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

Get the rated sell records

Request

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

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)

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

Example: rentalProductInventoryId=0
billRunIdstring(IdFilterParam)

Filter based on bill run identifier

Example: billRunId=0
adhocBillRunIdstring(IdFilterParam)

Filter based on adhoc bill run identifier

Example: adhocBillRunId=0
customerIdstring(IdFilterParam)

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

Example: customerId=0
siteIdstring(IdFilterParam)

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

Example: siteId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v1/rental-rated-sell-records?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&rentalProductInventoryId=0&billRunId=0&adhocBillRunId=0&customerId=0&siteId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Rental rated sell identifier

Example: 1
rentalProductInventoryIdinteger(int64)required

Rental product inventory identifier

Example: 1
customerIdinteger(int64)

Customer identifier

siteIdinteger(int64)

Site identifier

billRunIdinteger(int64)

Bill run identifier

Example: 1
billRunNamestring[ 0 .. 255 ] characters

Bill run friendly name

billRunStatusstring[ 0 .. 255 ] characters

Bill run status

adhocBillRunIdinteger(int64)

Adhoc bill run identifier

Example: 1
creationDatestring(date)

Created date

chargeStartDatestring(date)

Charge start date

chargeEndDatestring(date)

Charge end date

preDiscountPricenumber

Rated pre discount price

Example: 10.5
sellPricenumber

Rated sell price

Example: 10.5
priceTypestring[ 0 .. 255 ] characters

Price type

Example: "Rental"
qtynumber

Quantity

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

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