Usage rate cards contain the usage pricing structure - they can be assigned at Customer, Site or Usage Product Inventory level (UPI)
Elevate Pricing Assignment API (1.21)
Provides read & write access to customer, site and inventory level pricing assignments including price overrides
Rental and Usage rate cards can be assigned at Customer, Site or Usage Inventory level
- Rate cards at Customer level will apply to all sites and product inventories under the customer
- Rate cards at Site level will override any rate card assigned at Customer level - the product inventories within this Site will use the assigned rate card
- Rate cards at Inventory level override any rate card assigned at Customer or Site level; the individual product inventory will use the assigned rate card
Inclusive Usage plans can be assigned at Customer, Site or Usage Product Inventory level
- Plans at Customer level will be shared between Sites for that Customer - e.g. 1000 minutes would be shared between the Sites
- Plans can be added at Site level to just apply to that Site - this is in addition to any shared plan set at Customer level
- Plans can be added at UPI level to just apply to that inventory item - this is in addition to any shared plan(s) set at Customer or Site level
Rate overrides are the last pricing assignment level - they will override any rates that are set on the Rental or Usage rate card that is assigned Some examples;
- A Usage rate override is set against a Customer - Sites belonging to this Customer will inherit the override regardless of the Usage rate card assigned
- A Rental rate card is assigned at Site level and a Rental Rate Override is set for a product - the override price will overrule the price in the rate card for that product
Results to return per page
Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change
Comma-delimited list of the field(s) to return if only a subset is required
Filter by rental product inventory
Filter by start date
Filter by end date
Optional assignment level - CUSTOMER, SITE, INVENTORY or ALL. Defaults to INVENTORY for backwards compatibility. ALL returns the overrides of every level in one list; it is only allowed when the summary header is true and customerId or siteId is supplied.
Filter by customer. When the summary header is true this also matches the SITE and INVENTORY level overrides on the customer's sites.
Filter by site. When the summary header is true this also matches the INVENTORY level overrides on the site; CUSTOMER level overrides are not returned.
Filter by rental product name. Only used when the summary header is true
Filter by product category name. Only used when the summary header is true
Filter by site name. Only used when the summary header is true
Filter by the main billing number (CLI) of the rental product inventory. Only used when the summary header is true
Filter by the service id of the rental product inventory. Only used when the summary header is true
Logical operator used to combine the name filters (rentalProductName, productCategoryName, siteName, mainBillingNumber and serviceId). Accepted values AND (default), OR. The id and date filters are always combined with AND. Only used when the summary header is true
If true, each override is returned with the names of its rental product, product category and site (and, at INVENTORY level, its main billing number and service id), and with the customerId, siteId and rentalProductId it belongs to. It also enables assignmentLevel ALL, the name filters and logic.
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://rest.elevatebilling.com/v1/buy-rental-rate-overrides?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&rentalProductInventoryId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&assignmentLevel=CUSTOMER%2C+SITE%2C+INVENTORY+or+ALL&customerId=0&siteId=0&rentalProductId=0&rentalProductName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&productCategoryName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&mainBillingNumber=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&logic=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'summary: true | false'OK
Optional - buy rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required. If omitted this defaults to INVENTORY for backwards compatibility.
Customer identifier - required when assignmentLevel is CUSTOMER. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Site identifier - required when assignmentLevel is SITE. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.
Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)
Name of the rental product. Only populated when the summary header is true
Identifier of the rental product's product category. Only populated when the summary header is true
Name of the rental product's product category. Only populated when the summary header is true
Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true
Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Rental price type - recurring rental or one off?
Rental rate type. Required when rentalRatePriceType is RENTAL
Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
Frequency of rental. Required when rentalRatePriceType is RENTAL
[ { "id": 1, "assignmentLevel": "INVENTORY", "customerId": 1, "siteId": 1, "rentalProductId": 1, "rentalProductInventoryId": 1, "rentalProductName": "string", "productCategoryId": 0, "productCategoryName": "string", "siteName": "string", "mainBillingNumber": "string", "serviceId": "string", "price": -9999999, "rentalRatePriceType": "RENTAL", "rentalRateType": "ADVANCE", "periodsInAdvance": "STANDARD", "rentalRateFrequency": "DAILY", "startDate": "2019-08-24", "endDate": "2019-08-24" } ]
New buy rental rate override
Optional - buy rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required. If omitted this defaults to INVENTORY for backwards compatibility.
Customer identifier - required when assignmentLevel is CUSTOMER. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Site identifier - required when assignmentLevel is SITE. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.
Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)
Rental price type - recurring rental or one off?
Rental rate type. Required when rentalRatePriceType is RENTAL
Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
Frequency of rental. Required when rentalRatePriceType is RENTAL
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://rest.elevatebilling.com/v1/buy-rental-rate-overrides \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"assignmentLevel": "INVENTORY",
"customerId": 1,
"siteId": 1,
"rentalProductId": 1,
"rentalProductInventoryId": 1,
"price": -9999999,
"rentalRatePriceType": "RENTAL",
"rentalRateType": "ADVANCE",
"periodsInAdvance": "STANDARD",
"rentalRateFrequency": "DAILY",
"startDate": "2019-08-24",
"endDate": "2019-08-24"
}'OK
Optional - buy rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required. If omitted this defaults to INVENTORY for backwards compatibility.
Customer identifier - required when assignmentLevel is CUSTOMER. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Site identifier - required when assignmentLevel is SITE. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.
Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)
Name of the rental product. Only populated when the summary header is true
Identifier of the rental product's product category. Only populated when the summary header is true
Name of the rental product's product category. Only populated when the summary header is true
Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true
Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Rental price type - recurring rental or one off?
Rental rate type. Required when rentalRatePriceType is RENTAL
Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
Frequency of rental. Required when rentalRatePriceType is RENTAL
{ "id": 1, "assignmentLevel": "INVENTORY", "customerId": 1, "siteId": 1, "rentalProductId": 1, "rentalProductInventoryId": 1, "rentalProductName": "string", "productCategoryId": 0, "productCategoryName": "string", "siteName": "string", "mainBillingNumber": "string", "serviceId": "string", "price": -9999999, "rentalRatePriceType": "RENTAL", "rentalRateType": "ADVANCE", "periodsInAdvance": "STANDARD", "rentalRateFrequency": "DAILY", "startDate": "2019-08-24", "endDate": "2019-08-24" }
Filter by rental product inventory
Filter by start date
Filter by end date
Optional assignment level - CUSTOMER, SITE, INVENTORY or ALL. Defaults to INVENTORY for backwards compatibility. ALL returns the overrides of every level in one list; it is only allowed when the summary header is true and customerId or siteId is supplied.
Filter by customer. When the summary header is true this also matches the SITE and INVENTORY level overrides on the customer's sites.
Filter by site. When the summary header is true this also matches the INVENTORY level overrides on the site; CUSTOMER level overrides are not returned.
Filter by rental product name. Only used when the summary header is true
Filter by product category name. Only used when the summary header is true
Filter by site name. Only used when the summary header is true
Filter by the main billing number (CLI) of the rental product inventory. Only used when the summary header is true
Filter by the service id of the rental product inventory. Only used when the summary header is true
Logical operator used to combine the name filters (rentalProductName, productCategoryName, siteName, mainBillingNumber and serviceId). Accepted values AND (default), OR. The id and date filters are always combined with AND. Only used when the summary header is true
If true, each override is returned with the names of its rental product, product category and site (and, at INVENTORY level, its main billing number and service id), and with the customerId, siteId and rentalProductId it belongs to. It also enables assignmentLevel ALL, the name filters and logic.
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X HEAD \
'https://rest.elevatebilling.com/v1/buy-rental-rate-overrides?rentalProductInventoryId=0&startDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&endDate=yyyy-MM-dd+%2C+lt%3Ayyyy-MM-dd+%2C+gt%3Ayyyy-MM-dd+%2C+gtn%3Ayyyy-MM-dd&assignmentLevel=CUSTOMER%2C+SITE%2C+INVENTORY+or+ALL&customerId=0&siteId=0&rentalProductId=0&rentalProductName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&productCategoryName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteName=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&mainBillingNumber=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&logic=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'summary: true | false'A set of JSONPatch operations to be performed
The JSON Patch operation to be performed
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{assignmentLevel}/{buy_rental_rate_override_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
'https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{assignmentLevel}/1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/endDate",
"value": "2049-07-15"
}
]'Success
Optional - buy rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required. If omitted this defaults to INVENTORY for backwards compatibility.
Customer identifier - required when assignmentLevel is CUSTOMER. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Site identifier - required when assignmentLevel is SITE. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.
Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)
Name of the rental product. Only populated when the summary header is true
Identifier of the rental product's product category. Only populated when the summary header is true
Name of the rental product's product category. Only populated when the summary header is true
Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true
Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Rental price type - recurring rental or one off?
Rental rate type. Required when rentalRatePriceType is RENTAL
Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
Frequency of rental. Required when rentalRatePriceType is RENTAL
{ "id": 1, "assignmentLevel": "INVENTORY", "customerId": 1, "siteId": 1, "rentalProductId": 1, "rentalProductInventoryId": 1, "rentalProductName": "string", "productCategoryId": 0, "productCategoryName": "string", "siteName": "string", "mainBillingNumber": "string", "serviceId": "string", "price": -9999999, "rentalRatePriceType": "RENTAL", "rentalRateType": "ADVANCE", "periodsInAdvance": "STANDARD", "rentalRateFrequency": "DAILY", "startDate": "2019-08-24", "endDate": "2019-08-24" }
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{assignmentLevel}/{buy_rental_rate_override_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{assignmentLevel}/1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'A set of JSONPatch operations to be performed
The JSON Patch operation to be performed
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{buy_rental_rate_override_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PATCH \
https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json-patch+json' \
-d '[
{
"op": "replace",
"path": "/endDate",
"value": "2049-07-15"
}
]'Success
Optional - buy rate overrides can be assigned at customer, site or product inventory levels - use the appropriate level to determine which fields are required. If omitted this defaults to INVENTORY for backwards compatibility.
Customer identifier - required when assignmentLevel is CUSTOMER. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Site identifier - required when assignmentLevel is SITE. When the summary header is true it is also returned for INVENTORY level overrides; remove it before sending such an override back.
Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.
Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)
Name of the rental product. Only populated when the summary header is true
Identifier of the rental product's product category. Only populated when the summary header is true
Name of the rental product's product category. Only populated when the summary header is true
Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true
Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true
Rental price type - recurring rental or one off?
Rental rate type. Required when rentalRatePriceType is RENTAL
Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE
Frequency of rental. Required when rentalRatePriceType is RENTAL
{ "id": 1, "assignmentLevel": "INVENTORY", "customerId": 1, "siteId": 1, "rentalProductId": 1, "rentalProductInventoryId": 1, "rentalProductName": "string", "productCategoryId": 0, "productCategoryName": "string", "siteName": "string", "mainBillingNumber": "string", "serviceId": "string", "price": -9999999, "rentalRatePriceType": "RENTAL", "rentalRateType": "ADVANCE", "periodsInAdvance": "STANDARD", "rentalRateFrequency": "DAILY", "startDate": "2019-08-24", "endDate": "2019-08-24" }
- https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{buy_rental_rate_override_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/1 \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'