Get a list of available rental product inventories

get/rental-product-inventories
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
invoicePresentationProductName
string (StringFilterParam)

Filter by invoice presentation name

Example: invoicePresentationProductName=xyz | in:x,y | like:xyz
rentalProductId
string (IdFilterParam)

Filter by rental product identifier

Example: rentalProductId=0
productReference
string (StringFilterParam)

Filter by product reference

Example: productReference=xyz | in:x,y | like:xyz
additionalProductReference
string (StringFilterParam)

Filter by additional product reference

Example: additionalProductReference=xyz | in:x,y | like:xyz
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
siteId
string (IdFilterParam)

Filter by site

Example: siteId=0
supplierAccountId
string (IdFilterParam)

Filter by supplier account

Example: supplierAccountId=0
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,
    • "siteId": 1,
    • "rentalProductId": 1,
    • "parentRentalProductInventoryId": 1,
    • "invoicePresentationProductName": "string",
    • "supplierAccountId": 1,
    • "startDate": "2019-08-24",
    • "endDate": "2019-08-24",
    • "invoiceFrequency": 0,
    • "quantity": 1,
    • "productReference": "string",
    • "additionalProductReference": "string",
    • "label": "string",
    • "treatStartAsWholePeriod": false,
    • "treatEndAsWholePeriod": false,
    • "contractStartDate": "2019-08-24",
    • "userId": "string",
    • "userEmail": "string",
    • "costCentreCode": "string",
    • "departmentCode": "string",
    • "featureNumber": "string",
    • "nominalCode": "string",
    • "notes": "string",
    • "billable": true,
    • "inFlightOrder": false,
    • "billInitialChargesImmediately": false,
    • "alignedToStart": false,
    • "alignedToBillPeriod": false,
    • "externalOrderReference": "string",
    • "externalNetworkOrderReference": "string",
    • "pendingEndDate": "2019-08-24",
    • "forceBilling": true,
    • "forceBillPeriods": 1,
    • "installationAddress": {
      • "id": 1,
      • "businessName": "string",
      • "address1": "string",
      • "address2": "string",
      • "address3": "string",
      • "town": "string",
      • "county": "string",
      • "postcode": "string",
      • "country": "GB"
      },
    • "customFields": [
      • {
        • "id": 1,
        • "label": "string",
        • "value": "string"
        }
      ]
    }
]