Create a new rental rate card

post/rental-rate-cards
SecuritybearerAuth
Request
Request Body schema: application/json

New rental rate card

contractOwnerIds
Array of integers <int32>

Contract owner identifiers required for SELL/TEMPLATE rental rate card.

name
required
string [ 1 .. 100 ] characters [\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Rental rate card name

rentalProductCategoryId
required
integer <int64>

Rental product category identifier

rentalRateCardType
required
string (RentalRateCardType)

Rental rate card type. Buy = used to price rental products purchased from the supplier, Sell = used to price rental products sold to customers, Template = is a rate card to which other rate cards can be linked

Enum: "SELL" "TEMPLATE" "BUY"
basedOnTemplateId
integer <int64>

Based on rental rate card identifier. Sell rental rate cards can be linked to a template. Typically the template would contain the more obscure products that are less subject to price variations meaning the sell rate card can contain fewer products and be easier to maintain

availableFrom
required
string <date>

Available from

availableTo
string <date>

Available to

acceptOverridesFromParents
boolean
Default: true

Accept overrides from parents. Pricing can be assigned at customer, site or product inventory levels and could be a rate card assignment or override assignment. If selected, this property allows overrides assigned at a higher point in the hierarchy to override prices set within this rate card

Array of objects (RentalRate)
supplierAccountId
integer <int64>

The supplier account associated with BUY rate card only.

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

Request samples
application/json
{
  • "contractOwnerIds": [
    • 1
    ],
  • "name": "string",
  • "rentalProductCategoryId": 1,
  • "rentalRateCardType": "SELL",
  • "basedOnTemplateId": 1,
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "acceptOverridesFromParents": true,
  • "rentalRates": [
    • {
      • "rentalProductId": 1,
      • "price": 0,
      • "rentalRateType": "ADVANCE",
      • "rentalRatePriceType": "RENTAL",
      • "periodsInAdvance": "STANDARD",
      • "rentalRateFrequency": "DAILY",
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24",
      • "showOnInvoice": true
      }
    ],
  • "supplierAccountId": 1
}
Response samples
application/json
{
  • "id": 1,
  • "contractOwnerIds": [
    • 1
    ],
  • "name": "string",
  • "rentalProductCategoryId": 1,
  • "rentalRateCardType": "SELL",
  • "basedOnTemplateId": 1,
  • "availableFrom": "2019-08-24",
  • "availableTo": "2019-08-24",
  • "acceptOverridesFromParents": true,
  • "rentalRates": [
    • {
      • "id": 1,
      • "rentalProductId": 1,
      • "price": 0,
      • "rentalRateType": "ADVANCE",
      • "rentalRatePriceType": "RENTAL",
      • "periodsInAdvance": "STANDARD",
      • "rentalRateFrequency": "DAILY",
      • "startDate": "2019-08-24",
      • "endDate": "2019-08-24",
      • "showOnInvoice": true
      }
    ],
  • "supplierAccountId": 1
}