Skip to content

Elevate Rental API (1.5)

Rental Service

Provides access to rental rating values for customer and RPIs. Currently supports;

  • Get the Early Termination Charge (ETC) that would apply for a given customer or RPI should the customer/RPI end the contract early
  • Get the rated sell records for a rental product inventory, site or customer in a given adhoc/bill run
  • Get the rated buy records for a rental product inventory, site or customer in a given bill run
  • Get the suspense records for a rental product inventory, site or customer
Download OpenAPI description
billing-rest-rental.json
billing-rest-rental.yaml
Languages
Servers
https://rest.elevatebilling.com/v1

etc

Early Termination Charge

Operations

rental-rated-sell-records

Rental Rated Sell Records

Operations

rental-rated-buy-records

Rental Rated Buy Records

Operations

rental-suspense-records

Rental Suspense Records

Operations

rental-combined-records

Rental Combined Records of suspense, supplier, buy and sell

Operations

Get the combined suspense, supplier, sell and buy records

Request

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

Security
bearerAuth
Query
pageinteger(int32)(PageParam)>= 1required

Page of results to show

Example: page=1
pageSizeinteger(int32)(ResultsPerPageParam)[ 1 .. 1000 ]required

Results to return per page

Example: pageSize=100
sortstring(SortParam)

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

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

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

Example: fields=id,name
rentalProductInventoryIdstring(IdFilterParam)required

Return based on rental product inventory identifier

Example: rentalProductInventoryId=0
excludeBuyPricesstring(StringFilterParam)

Filter out buy prices (true/false)

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

Filter out sell prices (true/false)

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

Filter out supplier prices (true/false)

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

Filter out suspense records

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

Filter out those records without a sell price

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

Filter by search text against all fields

Example: searchFilter=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/rental-combined-records?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&rentalProductInventoryId=0&excludeBuyPrices=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeSellPrices=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeSupplierPrices=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&excludeSuspense=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&hasSellPrice=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&searchFilter=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
invoicePresentationProductNamestring[ 1 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product name as presented on invoice

billRunIdinteger(int64)

Bill run identifier

Example: 1
adhocBillRunIdinteger(int64)

Adhoc bill run identifier

Example: 1
billRunNamestring[ 0 .. 255 ] characters

Bill run friendly name

adhocBillRunNamestring[ 0 .. 255 ] characters

Adhoc bill run friendly name

billRunStatusstring[ 0 .. 255 ] characters

Bill run status

adhocBillRunStatusstring[ 0 .. 255 ] characters

Adhoc bill run status

chargeStartDatestring(date)

Charge start date

chargeEndDatestring(date)

Charge end date

buyPricenumber

Rated buy price

Example: 10.5
sellPricenumber

Rated sell price

Example: 10.5
preDiscountSellPricenumber

Rated sell price before discounting

Example: 10.5
supplierPricenumber

Supplier price

Example: 10.5
sellPriceTypestring[ 0 .. 255 ] characters

Sell price type

Example: "Rental"
buyPriceTypestring[ 0 .. 255 ] characters

Buy price type

Example: "Rental"
qtynumber

Rental product inventory quantity

Example: 1
howWasTheBuyRateDerivedstring<= 1024 characters

description of how the buy price was arrived at

howWasTheSellRateDerivedstring<= 1024 characters

description of how the sell price was arrived at

suspenseReasonstring[ 0 .. 255 ] characters

Suspense reason

Example: "Cannot find a rate in the rate card"
]
Response
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"
  }
]