# Elevate Pricing Assignment API

### 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


Version: 1.15

## Servers

```
https://rest.elevatebilling.com/v1
```

## Security

### bearerAuth

Type: http
Scheme: bearer
Bearer Format: JWT

## Download OpenAPI description

[Elevate Pricing Assignment API](https://docs.elevatebilling.com/_bundle/openapi/prod/gen/billing-rest-assignment.yaml)

## 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)

### Get a list of usage rate card assignments

 - [GET /usage-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-card-assignments/getusageratecardassignments.md)

### Create a new usage rate card assignment

 - [POST /usage-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-card-assignments/createusageratecardassignment.md)

### Check if usage rate card assignment exists

 - [HEAD /usage-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-card-assignments/checkusageratecardassignment.md)

### Update a usage rate card assignment

 - [PATCH /usage-rate-card-assignments/{assignmentLevel}/{usage_rate_card_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-card-assignments/updateusageratecardassignment.md)

### Delete a usage rate card assignment

 - [DELETE /usage-rate-card-assignments/{assignmentLevel}/{usage_rate_card_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-card-assignments/deleteusageratecardassignment.md): Can only be done if not included in a finalised bill run

## 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)

### Get a list of rental rate card assignments

 - [GET /rental-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-card-assignments/getrentalratecardassignments.md)

### Create a new rental rate card assignment

 - [POST /rental-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-card-assignments/createrentalratecardassignment.md)

### Check if rental rate card assignment exists

 - [HEAD /rental-rate-card-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-card-assignments/checkrentalratecardassignment.md)

### Update a rental rate card assignment

 - [PATCH /rental-rate-card-assignments/{assignmentLevel}/{rental_rate_card_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-card-assignments/updaterentalratecardassignment.md)

### Delete a rental rate card assignment

 - [DELETE /rental-rate-card-assignments/{assignmentLevel}/{rental_rate_card_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-card-assignments/deleterentalratecardassignment.md): Can only be done if not included in a finalised bill run

## inclusive-usage-plan-assignments

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

### Get a list of inclusive usage plan assignments

 - [GET /inclusive-usage-plan-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/inclusive-usage-plan-assignments/getinclusiveusageplanassignments.md)

### Create a new inclusive usage plan assignment

 - [POST /inclusive-usage-plan-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/inclusive-usage-plan-assignments/createinclusiveusageplanassignment.md)

### Check if inclusive usage plan assignment exists

 - [HEAD /inclusive-usage-plan-assignments](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/inclusive-usage-plan-assignments/checkinclusiveusageplanassignment.md)

### Update an inclusive usage plan assignment

 - [PATCH /inclusive-usage-plan-assignments/{assignmentLevel}/{inclusive_usage_plan_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/inclusive-usage-plan-assignments/updateinclusiveusageplanassignment.md)

### Delete an inclusive usage plan assignment

 - [DELETE /inclusive-usage-plan-assignments/{assignmentLevel}/{inclusive_usage_plan_assignment_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/inclusive-usage-plan-assignments/deleteinclsiveusageplanassignment.md): Delete an inclusive usage plan assignment

## usage-rate-overrides

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

### Get a list of usage overrides

 - [GET /usage-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-overrides/getusagerateoverrides.md)

### Create a new usage rate override

 - [POST /usage-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-overrides/createusagerateoverride.md)

### Check if usage rate override exists

 - [HEAD /usage-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-overrides/checkusagerateoverride.md)

### Update a usage rate override

 - [PATCH /usage-rate-overrides/{assignmentLevel}/{usage_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-overrides/updateusagerateoverride.md)

### Delete a usage rate override

 - [DELETE /usage-rate-overrides/{assignmentLevel}/{usage_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/usage-rate-overrides/deleteusagerateoverride.md): Can only be done if not included in a finalised bill run

## rental-rate-overrides

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

### Get a list of rental overrides

 - [GET /rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-overrides/getrentalrateoverrides.md)

### Create a new rental rate override

 - [POST /rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-overrides/createrentalrateoverride.md)

### Check if rental rate override exists

 - [HEAD /rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-overrides/checkrentalrateoverride.md)

### Update a rental rate override

 - [PATCH /rental-rate-overrides/{assignmentLevel}/{rental_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-overrides/updaterentalrateoverride.md)

### Delete a rental rate override

 - [DELETE /rental-rate-overrides/{assignmentLevel}/{rental_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/rental-rate-overrides/deleterentalrateoverride.md): Can only be done if not included in a finalised bill run

## buy-rental-rate-overrides

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

### Get a list of buy rental overrides

 - [GET /buy-rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/buy-rental-rate-overrides/getbuyrentalrateoverrides.md)

### Create a new buy rental rate override

 - [POST /buy-rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/buy-rental-rate-overrides/createbuyrentalrateoverride.md)

### Check if buy rental rate override exists

 - [HEAD /buy-rental-rate-overrides](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/buy-rental-rate-overrides/checkbuyrentalrateoverride.md)

### Update a buy rental rate override

 - [PATCH /buy-rental-rate-overrides/{buy_rental_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/buy-rental-rate-overrides/updatebuyrentalrateoverride.md)

### Delete a buy rental rate override

 - [DELETE /buy-rental-rate-overrides/{buy_rental_rate_override_id}](https://docs.elevatebilling.com/openapi/prod/gen/billing-rest-assignment/buy-rental-rate-overrides/deletebuyrentalrateoverride.md): Can only be done if not included in a finalised bill run