Skip to content
/
Check if usage product in...

Elevate Product Inventory API (2.24)

Management of usage and rental inventory items

Product inventory controls the products and services that are assigned to Sites.

Rental Product Inventory

A Rental Product Inventory (RPI) is the assignment of a Rental Product to a Site, for example, a broadband service or connection charge Where Rental Products are sold to a Customer the creation of a Rental Product Inventory notifies Elevate that there is a billable asset Properties of an RPI include start and end dates, i.e. between which dates should Elevate create a charge

Usage Product Inventory

A Usage Product Inventory (UPI) is the assignment of a Usage Product to a Site Where Usage Products are sold to a Customer the creation of a UPI notifies Elevate that there is a billable asset Properties of UPI include start and end dates, i.e. between which dates Elevate will create a charge for any usage associated with that UPI

Unlike RPIs, the creation of charges for UPIs is dependent upon Elevate processing usage records (typically referred to as Call Detail Records or CDR) that are delivered by suppliers as files or some other mechanism. The usage records are associated with the correct UPI within Elevate

Usage Product Reference

A Usage Product Reference (UPR) is an identifier for a UPI. This 'product reference' could be a telephone number or other identifier depending on the Usage Product. A single UPI can have many UPRs. Typically one of these UPRs is marked as the 'primary' (e.g. a main billing number) for the UPI. Properties of UPR include start and end dates when they are associated to the UPI

Adhoc Inventory

An Adhoc Inventory is used to represent a charge, discount or refund that will be applied on an adhoc basis, for example, a charge for equipment/upfront costs or a discretionary payment. These can be part of the standard billing cycle or, unlike other inventory items, can be part of a dedicated adhoc bill run at any time

Provisioning Details

Once a Rental Product Inventory has been created it can have a phone line provisioned with a number of settings. Provisioning Details serve as a representation of these settings, showing active/suspended lines, subscribed data bundles or add-ons, and smart/international-barred numbers

Download OpenAPI description
billing-rest-inventory.json
billing-rest-inventory.yaml
Languages
Servers
https://rest.elevatebilling.com/v2

usage-product-inventories

A Usage Product Inventory (UPI) is the assignment of a usage product to a Site. A UPI has 1 or more product reference (UPR)

Operations

Get a list of available usage product inventories

Request

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
usageProductIdstring(IdFilterParam)

Filter by usage product id

Example: usageProductId=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
productReferencestring(StringFilterParam)

Filter by product reference

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

Filter by service id

Example: serviceId=xyz | in:x,y | like:xyz
siteIdstring(IdFilterParam)

Filter by site

Example: siteId=0
labelstring(StringFilterParam)

Filter by label

Example: label=xyz | in:x,y | like:xyz
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/usage-product-inventories?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&usageProductId=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&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteId=0&label=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Usage product inventory identifier

Example: 1
siteIdinteger(int64)required

Site identifier

Example: 1
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
startDatestring(date)required

Start date

endDatestring(date)

End date

supplierAccountIdinteger(int64)

Supplier account identifier

billByServiceIdboolean

Bill by Service ID

Default false
serviceIdstring[ 1 .. 100 ] characters

Service ID. Extra validations may be applied depending on product configurations

billableboolean

Billable charge

Default true
inFlightOrderboolean

In-flight order

Default false
externalOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external order reference

externalNetworkOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external Network order reference

pendingEndDatestring(date)

Inflight order pending end date

usageCapEnabledboolean

Usage cap enabled

Default false
defaultUsageCapnumber

Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

overrideUsageCapnumber

Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

applySurchargesboolean

Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

Default false
productReferencesArray of objects(ProductReference)non-emptyrequired
productReferences[].​idinteger(int64)read-only

Product reference identifier

Example: 1
productReferences[].​productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

productReferences[].​primaryboolean

True if product reference is primary (main billing number)

Default true
productReferences[].​labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

productReferences[].​startDatestring(date)required

Start date

productReferences[].​endDatestring(date)

End date

productReferences[].​userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

productReferences[].​userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

productReferences[].​costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

productReferences[].​departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

productReferences[].​notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

tripwirePlanIdinteger(int64)

Tripwire plan identifier

]
Response
application/json
[
  {
    "id": 1,
    "siteId": 1,
    "usageProductId": 1,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "supplierAccountId": 0,
    "billByServiceId": false,
    "serviceId": "string",
    "billable": true,
    "inFlightOrder": false,
    "externalOrderReference": "string",
    "externalNetworkOrderReference": "string",
    "pendingEndDate": "2019-08-24",
    "usageCapEnabled": false,
    "defaultUsageCap": 0,
    "overrideUsageCap": 0,
    "applySurcharges": false,
    "productReferences": [ … ],
    "tripwirePlanId": 0
  }
]

Check if usage product inventory exists

Request

Security
bearerAuth
Query
usageProductIdstring(IdFilterParam)

Filter by usage product id

Example: usageProductId=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
productReferencestring(StringFilterParam)

Filter by product reference

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

Filter by service id

Example: serviceId=xyz | in:x,y | like:xyz
siteIdstring(IdFilterParam)

Filter by site

Example: siteId=0
labelstring(StringFilterParam)

Filter by label

Example: label=xyz | in:x,y | like:xyz
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v2/usage-product-inventories?usageProductId=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&productReference=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&serviceId=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz&siteId=0&label=xyz+%7C+in%3Ax%2Cy+%7C+like%3Axyz' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Body

Create a new usage product inventory

Request

Security
bearerAuth
Bodyapplication/jsonrequired

New usage product inventory

siteIdinteger(int64)required

Site identifier

Example: 1
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
startDatestring(date)required

Start date

endDatestring(date)

End date

supplierAccountIdinteger(int64)

Supplier account identifier

billByServiceIdboolean

Bill by Service ID

Default false
serviceIdstring[ 1 .. 100 ] characters

Service ID. Extra validations may be applied depending on product configurations

billableboolean

Billable charge

Default true
inFlightOrderboolean

In-flight order

Default false
externalOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external order reference

externalNetworkOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external Network order reference

pendingEndDatestring(date)

Inflight order pending end date

usageCapEnabledboolean

Usage cap enabled

Default false
defaultUsageCapnumber

Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

overrideUsageCapnumber

Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

applySurchargesboolean

Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

Default false
productReferencesArray of objects(ProductReference)non-emptyrequired
productReferences[].​productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

productReferences[].​primaryboolean

True if product reference is primary (main billing number)

Default true
productReferences[].​labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

productReferences[].​startDatestring(date)required

Start date

productReferences[].​endDatestring(date)

End date

productReferences[].​userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

productReferences[].​userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

productReferences[].​costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

productReferences[].​departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

productReferences[].​notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

tripwirePlanIdinteger(int64)

Tripwire plan identifier

curl -i -X POST \
  https://rest.elevatebilling.com/v2/usage-product-inventories \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "siteId": 1,
    "usageProductId": 1,
    "startDate": "2019-08-24",
    "endDate": "2019-08-24",
    "supplierAccountId": 0,
    "billByServiceId": false,
    "serviceId": "string",
    "billable": true,
    "inFlightOrder": false,
    "externalOrderReference": "string",
    "externalNetworkOrderReference": "string",
    "pendingEndDate": "2019-08-24",
    "usageCapEnabled": false,
    "defaultUsageCap": 0,
    "overrideUsageCap": 0,
    "applySurcharges": false,
    "productReferences": [
      {
        "productReference": "string",
        "primary": true,
        "label": "string",
        "startDate": "2019-08-24",
        "endDate": "2019-08-24",
        "userId": "string",
        "userEmail": "string",
        "costCentreCode": "string",
        "departmentCode": "string",
        "notes": "string"
      }
    ],
    "tripwirePlanId": 0
  }'

Responses

OK

Bodyapplication/json
idinteger(int64)read-only

Usage product inventory identifier

Example: 1
siteIdinteger(int64)required

Site identifier

Example: 1
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
startDatestring(date)required

Start date

endDatestring(date)

End date

supplierAccountIdinteger(int64)

Supplier account identifier

billByServiceIdboolean

Bill by Service ID

Default false
serviceIdstring[ 1 .. 100 ] characters

Service ID. Extra validations may be applied depending on product configurations

billableboolean

Billable charge

Default true
inFlightOrderboolean

In-flight order

Default false
externalOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external order reference

externalNetworkOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external Network order reference

pendingEndDatestring(date)

Inflight order pending end date

usageCapEnabledboolean

Usage cap enabled

Default false
defaultUsageCapnumber

Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

overrideUsageCapnumber

Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

applySurchargesboolean

Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

Default false
productReferencesArray of objects(ProductReference)non-emptyrequired
productReferences[].​idinteger(int64)read-only

Product reference identifier

Example: 1
productReferences[].​productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

productReferences[].​primaryboolean

True if product reference is primary (main billing number)

Default true
productReferences[].​labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

productReferences[].​startDatestring(date)required

Start date

productReferences[].​endDatestring(date)

End date

productReferences[].​userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

productReferences[].​userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

productReferences[].​costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

productReferences[].​departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

productReferences[].​notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

tripwirePlanIdinteger(int64)

Tripwire plan identifier

Response
application/json
{
  "id": 1,
  "siteId": 1,
  "usageProductId": 1,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "supplierAccountId": 0,
  "billByServiceId": false,
  "serviceId": "string",
  "billable": true,
  "inFlightOrder": false,
  "externalOrderReference": "string",
  "externalNetworkOrderReference": "string",
  "pendingEndDate": "2019-08-24",
  "usageCapEnabled": false,
  "defaultUsageCap": 0,
  "overrideUsageCap": 0,
  "applySurcharges": false,
  "productReferences": [
    { … }
  ],
  "tripwirePlanId": 0
}

Get a specific usage product inventory

Request

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

Usage product inventory identifier

Example: 1
curl -i -X GET \
  https://rest.elevatebilling.com/v2/usage-product-inventories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Usage product inventory found

Bodyapplication/json
idinteger(int64)read-only

Usage product inventory identifier

Example: 1
siteIdinteger(int64)required

Site identifier

Example: 1
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
startDatestring(date)required

Start date

endDatestring(date)

End date

supplierAccountIdinteger(int64)

Supplier account identifier

billByServiceIdboolean

Bill by Service ID

Default false
serviceIdstring[ 1 .. 100 ] characters

Service ID. Extra validations may be applied depending on product configurations

billableboolean

Billable charge

Default true
inFlightOrderboolean

In-flight order

Default false
externalOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external order reference

externalNetworkOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external Network order reference

pendingEndDatestring(date)

Inflight order pending end date

usageCapEnabledboolean

Usage cap enabled

Default false
defaultUsageCapnumber

Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

overrideUsageCapnumber

Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

applySurchargesboolean

Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

Default false
productReferencesArray of objects(ProductReference)non-emptyrequired
productReferences[].​idinteger(int64)read-only

Product reference identifier

Example: 1
productReferences[].​productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

productReferences[].​primaryboolean

True if product reference is primary (main billing number)

Default true
productReferences[].​labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

productReferences[].​startDatestring(date)required

Start date

productReferences[].​endDatestring(date)

End date

productReferences[].​userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

productReferences[].​userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

productReferences[].​costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

productReferences[].​departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

productReferences[].​notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

tripwirePlanIdinteger(int64)

Tripwire plan identifier

Response
application/json
{
  "id": 1,
  "siteId": 1,
  "usageProductId": 1,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "supplierAccountId": 0,
  "billByServiceId": false,
  "serviceId": "string",
  "billable": true,
  "inFlightOrder": false,
  "externalOrderReference": "string",
  "externalNetworkOrderReference": "string",
  "pendingEndDate": "2019-08-24",
  "usageCapEnabled": false,
  "defaultUsageCap": 0,
  "overrideUsageCap": 0,
  "applySurcharges": false,
  "productReferences": [
    { … }
  ],
  "tripwirePlanId": 0
}

Update a usage product inventory

Request

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

Usage product inventory 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/v2/usage-product-inventories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/surchargesApply",
      "value": "true"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Usage product inventory identifier

Example: 1
siteIdinteger(int64)required

Site identifier

Example: 1
usageProductIdinteger(int64)required

Usage product identifier

Example: 1
startDatestring(date)required

Start date

endDatestring(date)

End date

supplierAccountIdinteger(int64)

Supplier account identifier

billByServiceIdboolean

Bill by Service ID

Default false
serviceIdstring[ 1 .. 100 ] characters

Service ID. Extra validations may be applied depending on product configurations

billableboolean

Billable charge

Default true
inFlightOrderboolean

In-flight order

Default false
externalOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external order reference

externalNetworkOrderReferencestring[ 1 .. 100 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

external Network order reference

pendingEndDatestring(date)

Inflight order pending end date

usageCapEnabledboolean

Usage cap enabled

Default false
defaultUsageCapnumber

Default usage cap amount. Specify the value in minor currency units (i.e. pence for GBP, cents for EUR/USD)

overrideUsageCapnumber

Override the default usage cap amount temporarily. Specify the value in minor currency units (e.g. pence for GBP, cents for EUR/USD)

applySurchargesboolean

Do surcharge apply to this UPI? If true and a rate is found with a surchargeValue greater than 0 then an additional surcharge will be applied to the usage cost

Default false
productReferencesArray of objects(ProductReference)non-emptyrequired
productReferences[].​idinteger(int64)read-only

Product reference identifier

Example: 1
productReferences[].​productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

productReferences[].​primaryboolean

True if product reference is primary (main billing number)

Default true
productReferences[].​labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

productReferences[].​startDatestring(date)required

Start date

productReferences[].​endDatestring(date)

End date

productReferences[].​userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

productReferences[].​userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

productReferences[].​costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

productReferences[].​departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

productReferences[].​notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

tripwirePlanIdinteger(int64)

Tripwire plan identifier

Response
application/json
{
  "id": 1,
  "siteId": 1,
  "usageProductId": 1,
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "supplierAccountId": 0,
  "billByServiceId": false,
  "serviceId": "string",
  "billable": true,
  "inFlightOrder": false,
  "externalOrderReference": "string",
  "externalNetworkOrderReference": "string",
  "pendingEndDate": "2019-08-24",
  "usageCapEnabled": false,
  "defaultUsageCap": 0,
  "overrideUsageCap": 0,
  "applySurcharges": false,
  "productReferences": [
    { … }
  ],
  "tripwirePlanId": 0
}

Delete usage product inventory

Request

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

Usage product inventory identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v2/usage-product-inventories/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body

Update a UPI product reference

Request

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

Usage product reference 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/v2/usage-product-references/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json-patch+json' \
  -d '[
    {
      "op": "replace",
      "path": "/startDate",
      "value": "2023-01-13"
    }
  ]'

Responses

Success

Bodyapplication/json
idinteger(int64)read-only

Product reference identifier

Example: 1
productReferencestring[ 1 .. 100 ] charactersrequired

Product reference. Extra validations may be applied depending on product configurations.

primaryboolean

True if product reference is primary (main billing number)

Default true
labelstring[ 1 .. 500 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Product reference

startDatestring(date)required

Start date

endDatestring(date)

End date

userIdstring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

User Id

userEmailstring[ 0 .. 255 ] characters[a-zA-Z0-9.!#$%&'\*\+\/=?^_`{|}~-]+@[a-zA-Z0-...

User email address

costCentreCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Cost centre code

departmentCodestring[ 0 .. 255 ] characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Department code

notesstringnon-empty[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Notes

Response
application/json
{
  "id": 1,
  "productReference": "string",
  "primary": true,
  "label": "string",
  "startDate": "2019-08-24",
  "endDate": "2019-08-24",
  "userId": "string",
  "userEmail": "string",
  "costCentreCode": "string",
  "departmentCode": "string",
  "notes": "string"
}

Delete UPI product reference

Request

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

Usage product reference identifier

Example: 1
curl -i -X DELETE \
  https://rest.elevatebilling.com/v2/usage-product-references/1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Body

rental-product-inventories

A Rental Product Inventory (RPI) is the assignment of a rental product to a Site

Operations

adhoc-inventories

An Adhoc Inventory is used to represent a charge, discount or refund that will be applied on an adhoc basis

Operations

provisioning-details

A group of settings which detail the provisioning state of a rental product inventory

Operations