Get a list of rental overrides

get/rental-rate-overrides
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
assignmentLevel
string (StringFilterParam)

Filter by assignment level - CUSTOMER, SITE or INVENTORY

Example: assignmentLevel=xyz | in:x,y | like:xyz
customerId
string (IdFilterParam)

Filter by customer

Example: customerId=0
siteId
string (IdFilterParam)

Filter by site

Example: siteId=0
rentalProductInventoryId
string (IdFilterParam)

Filter by rental product inventory

Example: rentalProductInventoryId=0
rentalProductCategoryId
string (IdFilterParam)

Filter by rental product category

Example: rentalProductCategoryId=0
rentalProductId
string (IdFilterParam)

Filter by rental product

Example: rentalProductId=0
startDate
string (DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDate
string (DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

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
    }
]