Skip to content
etc/
Get the Early Termination...

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

Get the Early Termination Charges (ETC)

Request

Get the Early Termination Charges (ETC) that would apply for given customer or RPI on proposed end date

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

Return based on customer id - mandatory

Example: customerId=0
calculationDatestringrequired

Proposed date for ETC calculation - mandatory

Example: calculationDate=yyyy-MM-dd
rentalProductInventoryIdstring(IdFilterParam)

Filter based on RPI id

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

Responses

OK

Bodyapplication/jsonArray [
customerIdinteger(int64)required

Customer Id

Example: 1
rentalProductInventoryIdinteger(int64)

RPI Id

Example: 1
amountInMajorCurrencynumber[ -9999999 .. 9999999 ]required

ETC amount in major currency (e.g pounds/dollars/euros)

Example: 10.5
currencyCodestring(CurrencyCode)= 3 characters[A-Z]{3}required

ISO 4217 3-character currency code

Example: "GBP"
calculationDatestring(date)required

Date when the ETC was calculated for

]
Response
application/json
[
  {
    "customerId": 1,
    "rentalProductInventoryId": 1,
    "amountInMajorCurrency": 10.5,
    "currencyCode": "GBP",
    "calculationDate": "2019-08-24"
  }
]

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