Create a new rental rate override

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

New rental rate override

assignmentLevel
required
string

Rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required.

price
required
number [ -9999999 .. 9999999 ]

Price

rentalRatePriceType
required
string (RentalRatePriceType)

Rental price type - recurring rental or one off?

Enum: "RENTAL" "ONEOFF"
rentalRateType
string (RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum: "ADVANCE" "ARREARS"
periodsInAdvance
string (PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum: "STANDARD" "ADVANCEDPLUSONEMONTH"
rentalRateFrequency
string (RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "QUARTERLY" "SIXMONTHS" "TWENTYFOURMONTHS"
startDate
required
string <date>

Start date

endDate
string <date>

End date

applyThisToChildren
boolean
Default: true

Apply this override to children?

showOnInvoice
boolean
Default: true

Show on invoice?

customerId
required
integer <int64>

Customer identifier

rentalProductId
required
integer <int64>

Rental product identifier

Responses
200

OK

201

Created

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Request samples
application/json
{
  • "assignmentLevel": "CUSTOMER",
  • "price": -9999999,
  • "rentalRatePriceType": "RENTAL",
  • "rentalRateType": "ADVANCE",
  • "periodsInAdvance": "STANDARD",
  • "rentalRateFrequency": "DAILY",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "applyThisToChildren": true,
  • "showOnInvoice": true,
  • "customerId": 1,
  • "rentalProductId": 1
}
Response samples
application/json
{
  • "id": 1,
  • "assignmentLevel": "CUSTOMER",
  • "price": -9999999,
  • "rentalRatePriceType": "RENTAL",
  • "rentalRateType": "ADVANCE",
  • "periodsInAdvance": "STANDARD",
  • "rentalRateFrequency": "DAILY",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "applyThisToChildren": true,
  • "showOnInvoice": true,
  • "customerId": 1,
  • "rentalProductId": 1
}