Get the combined suspense, supplier, sell and buy records

get/rental-combined-records

Get the combined suspense, supplier, sell and buy records records for a rental product inventory

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

Return based on rental product inventory identifier

Example: rentalProductInventoryId=0
excludeBuyPrices
string (StringFilterParam)

Filter out buy prices (true/false)

Example: excludeBuyPrices=xyz | in:x,y | like:xyz
excludeSellPrices
string (StringFilterParam)

Filter out sell prices (true/false)

Example: excludeSellPrices=xyz | in:x,y | like:xyz
excludeSupplierPrices
string (StringFilterParam)

Filter out supplier prices (true/false)

Example: excludeSupplierPrices=xyz | in:x,y | like:xyz
excludeSuspense
string (StringFilterParam)

Filter out suspense records

Example: excludeSuspense=xyz | in:x,y | like:xyz
hasSellPrice
string (StringFilterParam)

Filter out those records without a sell price

Example: hasSellPrice=xyz | in:x,y | like:xyz
searchFilter
string (StringFilterParam)

Filter by search text against all fields

Example: searchFilter=xyz | in:x,y | like:xyz
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "rentalProductInventoryId": 1,
    • "invoicePresentationProductName": "string",
    • "billRunId": 1,
    • "adhocBillRunId": 1,
    • "billRunName": "string",
    • "adhocBillRunName": "string",
    • "billRunStatus": "string",
    • "adhocBillRunStatus": "string",
    • "chargeStartDate": "2019-08-24",
    • "chargeEndDate": "2019-08-24",
    • "buyPrice": 10.5,
    • "sellPrice": 10.5,
    • "preDiscountSellPrice": 10.5,
    • "supplierPrice": 10.5,
    • "sellPriceType": "Rental",
    • "buyPriceType": "Rental",
    • "qty": 1,
    • "howWasTheBuyRateDerived": "string",
    • "howWasTheSellRateDerived": "string",
    • "suspenseReason": "Cannot find a rate in the rate card"
    }
]