Get a list of available rental rate cards

get/rental-rate-cards
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
contractOwnerId
string (IdFilterParam)

Filter by contract owner

Example: contractOwnerId=0
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
availableFrom
string (DateFilterParam)

Filter by available from date

Example: availableFrom=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
availableTo
string (DateFilterParam)

Filter by available to date

Example: availableTo=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
rentalRateCardType
string (StringFilterParam)

Filter by rate card type

Example: rentalRateCardType=xyz | in:x,y | like:xyz
rentalProductCategoryId
string (IdFilterParam)

Filter by rental product category

Example: rentalProductCategoryId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

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