Skip to content

Elevate Pricing Assignment API (1.21)

Customer and Site Pricing Assignment

Provides read & write access to customer, site and inventory level pricing assignments including price overrides

Rental and Usage Rate Cards

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

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

Rental and Usage Rate Overrides

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
Languages
Servers
https://rest.elevatebilling.com/v1

usage-rate-card-assignments

Usage rate cards contain the usage pricing structure - they can be assigned at Customer, Site or Usage Product Inventory level (UPI)

Operations

rental-rate-card-assignments

Rental rate cards contain the rental pricing structure - they can be assigned at Customer, Site or Rental Product Inventory level (RPI)

Operations

inclusive-usage-plan-assignments

Inclusive usage plans are an inclusive bundle assigned at Customer, Site or Usage Inventory level

Operations

usage-rate-overrides

Usage rate overrides can be set at Customer, Site or Usage Inventory level to override the pricing in the rate card

Operations

rental-rate-overrides

Rental rate overrides can be set at Customer, Site or Rental Inventory level to override the pricing in the rate card

Operations

buy-rental-rate-overrides

Buy rental rate overrides can be set at Inventory level to override the pricing in the buy rate card

Operations

Get a list of buy rental overrides

Request

When the summary header is true the list can be sorted by assignmentLevel, siteName, mainBillingNumber, rentalProductName, productCategoryName, rentalRateFrequency, price, rentalRatePriceType, startDate, endDate and id.

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)

Filter by rental product inventory

Example: rentalProductInventoryId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY""ALL"
Example: assignmentLevel=CUSTOMER, SITE, INVENTORY or ALL
customerIdstring(IdFilterParam)

Filter by customer. When the summary header is true this also matches the SITE and INVENTORY level overrides on the customer's sites.

Example: customerId=0
siteIdstring(IdFilterParam)

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.

Example: siteId=0
rentalProductIdstring(IdFilterParam)

Filter by rental product

Example: rentalProductId=0
rentalProductNamestring(StringFilterParam)

Filter by rental product name. Only used when the summary header is true

Example: rentalProductName=xyz | in:x,y | like:xyz
productCategoryNamestring(StringFilterParam)

Filter by product category name. Only used when the summary header is true

Example: productCategoryName=xyz | in:x,y | like:xyz
siteNamestring(StringFilterParam)

Filter by site name. Only used when the summary header is true

Example: siteName=xyz | in:x,y | like:xyz
mainBillingNumberstring(StringFilterParam)

Filter by the main billing number (CLI) of the rental product inventory. Only used when the summary header is true

Example: mainBillingNumber=xyz | in:x,y | like:xyz
serviceIdstring(StringFilterParam)

Filter by the service id of the rental product inventory. Only used when the summary header is true

Example: serviceId=xyz | in:x,y | like:xyz
logicstring(StringFilterParam)

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

Example: logic=xyz | in:x,y | like:xyz
Headers
summarystring(BooleanFilterParam)

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.

Example: true | false
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'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Buy rental rate override identifier

Example: 1
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY"
customerIdinteger(int64)

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.

Example: 1
siteIdinteger(int64)

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.

Example: 1
rentalProductIdinteger(int64)

Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.

Example: 1
rentalProductInventoryIdinteger(int64)

Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)

Example: 1
rentalProductNamestringread-only

Name of the rental product. Only populated when the summary header is true

productCategoryIdinteger(int64)read-only

Identifier of the rental product's product category. Only populated when the summary header is true

productCategoryNamestringread-only

Name of the rental product's product category. Only populated when the summary header is true

siteNamestringread-only

Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true

mainBillingNumberstringread-only

Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

serviceIdstringread-only

Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

pricenumber[ -9999999 .. 9999999 ]required

Price

rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

]
Response
application/json
[ { "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" } ]

Create a new buy rental rate override

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New buy rental rate override

assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY"
customerIdinteger(int64)

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.

Example: 1
siteIdinteger(int64)

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.

Example: 1
rentalProductIdinteger(int64)

Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.

Example: 1
rentalProductInventoryIdinteger(int64)

Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)

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

Price

rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

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"
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Buy rental rate override identifier

Example: 1
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY"
customerIdinteger(int64)

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.

Example: 1
siteIdinteger(int64)

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.

Example: 1
rentalProductIdinteger(int64)

Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.

Example: 1
rentalProductInventoryIdinteger(int64)

Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)

Example: 1
rentalProductNamestringread-only

Name of the rental product. Only populated when the summary header is true

productCategoryIdinteger(int64)read-only

Identifier of the rental product's product category. Only populated when the summary header is true

productCategoryNamestringread-only

Name of the rental product's product category. Only populated when the summary header is true

siteNamestringread-only

Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true

mainBillingNumberstringread-only

Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

serviceIdstringread-only

Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

pricenumber[ -9999999 .. 9999999 ]required

Price

rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{ "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" }

Check if buy rental rate override exists

Request

Security
bearerAuth
Query
rentalProductInventoryIdstring(IdFilterParam)

Filter by rental product inventory

Example: rentalProductInventoryId=0
startDatestring(DateFilterParam)

Filter by start date

Example: startDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
endDatestring(DateFilterParam)

Filter by end date

Example: endDate=yyyy-MM-dd | lt:yyyy-MM-dd | gt:yyyy-MM-dd | gtn:yyyy-MM-dd
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY""ALL"
Example: assignmentLevel=CUSTOMER, SITE, INVENTORY or ALL
customerIdstring(IdFilterParam)

Filter by customer. When the summary header is true this also matches the SITE and INVENTORY level overrides on the customer's sites.

Example: customerId=0
siteIdstring(IdFilterParam)

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.

Example: siteId=0
rentalProductIdstring(IdFilterParam)

Filter by rental product

Example: rentalProductId=0
rentalProductNamestring(StringFilterParam)

Filter by rental product name. Only used when the summary header is true

Example: rentalProductName=xyz | in:x,y | like:xyz
productCategoryNamestring(StringFilterParam)

Filter by product category name. Only used when the summary header is true

Example: productCategoryName=xyz | in:x,y | like:xyz
siteNamestring(StringFilterParam)

Filter by site name. Only used when the summary header is true

Example: siteName=xyz | in:x,y | like:xyz
mainBillingNumberstring(StringFilterParam)

Filter by the main billing number (CLI) of the rental product inventory. Only used when the summary header is true

Example: mainBillingNumber=xyz | in:x,y | like:xyz
serviceIdstring(StringFilterParam)

Filter by the service id of the rental product inventory. Only used when the summary header is true

Example: serviceId=xyz | in:x,y | like:xyz
logicstring(StringFilterParam)

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

Example: logic=xyz | in:x,y | like:xyz
Headers
summarystring(BooleanFilterParam)

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.

Example: true | false
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'

Responses

Exists

Headers
X-Total-Countinteger

Total number of buy rental rate overrides matching the supplied query filters. Returned when the summary header is true

Body

Update a buy rental rate override

Request

Security
bearerAuth
Path
assignmentLevelstringrequired

Assignment level to be updated - CUSTOMER, SITE or INVENTORY

Enum"CUSTOMER""SITE""INVENTORY"
buy_rental_rate_override_idinteger(int64)(IdParam)>= 1required

Buy rental rate override identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
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"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Buy rental rate override identifier

Example: 1
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY"
customerIdinteger(int64)

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.

Example: 1
siteIdinteger(int64)

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.

Example: 1
rentalProductIdinteger(int64)

Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.

Example: 1
rentalProductInventoryIdinteger(int64)

Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)

Example: 1
rentalProductNamestringread-only

Name of the rental product. Only populated when the summary header is true

productCategoryIdinteger(int64)read-only

Identifier of the rental product's product category. Only populated when the summary header is true

productCategoryNamestringread-only

Name of the rental product's product category. Only populated when the summary header is true

siteNamestringread-only

Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true

mainBillingNumberstringread-only

Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

serviceIdstringread-only

Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

pricenumber[ -9999999 .. 9999999 ]required

Price

rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{ "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" }

Delete a buy rental rate override

Request

Can only be done if not included in a finalised bill run

Security
bearerAuth
Path
assignmentLevelstringrequired

Assignment level to be deleted - CUSTOMER, SITE or INVENTORY

Enum"CUSTOMER""SITE""INVENTORY"
buy_rental_rate_override_idinteger(int64)(IdParam)>= 1required

Buy rental rate override identifier

Example: 1
curl -i -X DELETE \
  'https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/{assignmentLevel}/1' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

Update an inventory level buy rental rate overrideDeprecated

Request

Acts on INVENTORY level buy rental rate overrides only - use PATCH /buy-rental-rate-overrides/{assignmentLevel}/{buy_rental_rate_override_id} for other levels

Security
bearerAuth
Path
buy_rental_rate_override_idinteger(int64)(IdParam)>= 1required

Buy rental rate override identifier

Example: 1
Bodyapplication/json-patch+jsonrequired

A set of JSONPatch operations to be performed

Array [
opstringrequired

The JSON Patch operation to be performed

Enum"add""remove""replace""move""copy""test"
pathstringrequired

A JSON-Pointer

valueobject

The value to be used within the operations

fromstring

A string containing a JSON Pointer value

]
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"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Buy rental rate override identifier

Example: 1
assignmentLevelstring

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.

Default "INVENTORY"
Enum"CUSTOMER""SITE""INVENTORY"
customerIdinteger(int64)

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.

Example: 1
siteIdinteger(int64)

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.

Example: 1
rentalProductIdinteger(int64)

Rental product identifier - required when assignmentLevel is CUSTOMER or SITE. When the summary header is true it is also returned for INVENTORY level overrides.

Example: 1
rentalProductInventoryIdinteger(int64)

Rental product inventory identifier - required when assignmentLevel is INVENTORY (or omitted)

Example: 1
rentalProductNamestringread-only

Name of the rental product. Only populated when the summary header is true

productCategoryIdinteger(int64)read-only

Identifier of the rental product's product category. Only populated when the summary header is true

productCategoryNamestringread-only

Name of the rental product's product category. Only populated when the summary header is true

siteNamestringread-only

Name of the site, for SITE and INVENTORY level overrides. Only populated when the summary header is true

mainBillingNumberstringread-only

Main billing number (CLI) of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

serviceIdstringread-only

Service id of the rental product inventory, for INVENTORY level overrides. Only populated when the summary header is true

pricenumber[ -9999999 .. 9999999 ]required

Price

rentalRatePriceTypestring(RentalRatePriceType)required

Rental price type - recurring rental or one off?

Enum"RENTAL""ONEOFF"
rentalRateTypestring(RentalRateType)

Rental rate type. Required when rentalRatePriceType is RENTAL

Enum"ADVANCE""ARREARS"
periodsInAdvancestring(PeriodsInAdvance)

Number of periods in advance (i.e. Months) for rentals. Required when rentalRateType is ADVANCE

Enum"STANDARD""ADVANCEDPLUSONEMONTH"
rentalRateFrequencystring(RentalRateFrequency)

Frequency of rental. Required when rentalRatePriceType is RENTAL

Enum"DAILY""WEEKLY""MONTHLY""YEARLY""QUARTERLY""SIXMONTHS""TWENTYFOURMONTHS"
startDatestring(date)required

Start date

endDatestring(date)

End date

Response
application/json
{ "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" }

Delete an inventory level buy rental rate overrideDeprecated

Request

Acts on INVENTORY level buy rental rate overrides only - use DELETE /buy-rental-rate-overrides/{assignmentLevel}/{buy_rental_rate_override_id} for other levels. Can only be done if not included in a finalised bill run

Security
bearerAuth
Path
buy_rental_rate_override_idinteger(int64)(IdParam)>= 1required

Buy rental rate override identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v1/buy-rental-rate-overrides/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Body

rental-discount-plan-assignments

Rental discount plan assignments can be assigned at Customer, Site or Rental Product Inventory level

Operations