Get the Early Termination Charges (ETC)

get/rental-etcs

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

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

Return based on customer id - mandatory

Example: customerId=0
calculationDate
required
string

Proposed date for ETC calculation - mandatory

Example: calculationDate=yyyy-MM-dd
rentalProductInventoryId
string (IdFilterParam)

Filter based on RPI id

Example: rentalProductInventoryId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

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