Get the rated buy records

get/rental-rated-buy-records

Get the rated buy records for a rental product inventory, site or customer in a given bill run

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
rentalProductInventoryId
string (IdFilterParam)

Return based on rental product inventory identifier - required unless the "siteId+billRunId" or "customerId+billRunId" filter combinations have been specified

Example: rentalProductInventoryId=0
billRunId
string (IdFilterParam)

Filter based on bill run identifier

Example: billRunId=0
customerId
string (IdFilterParam)

Filter based on customer identifier - required with "billRunId" unless the "rentalProductInventoryId" or "siteId+billRunId" filter combinations have been specified

Example: customerId=0
siteId
string (IdFilterParam)

Filter based on site identifier - required with "billRunId" unless the "rentalProductInventoryId" or "customerId+billRunId" filter combinations have been specified

Example: siteId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "rentalProductInventoryId": 1,
    • "customerId": 0,
    • "siteId": 0,
    • "billRunId": 1,
    • "billRunName": "string",
    • "billRunStatus": "string",
    • "creationDate": "2019-08-24",
    • "chargeStartDate": "2019-08-24",
    • "chargeEndDate": "2019-08-24",
    • "buyPrice": 10.5,
    • "priceType": "Rental",
    • "qty": 1
    }
]