Skip to content
/
Check if a set of provisi...

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

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

Get a list of provisioning details

Request

Get a list of provisioning details for existing rental product inventories

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 identifier

Example: rentalProductInventoryId=0
curl -i -X GET \
  'https://rest.elevatebilling.com/v2/provisioning-details?page=1&pageSize=100&sort=id%2Cname+%7C+name%3Adesc&fields=id%2Cname&rentalProductInventoryId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/jsonArray [
idinteger(int64)read-only

Provisioning details identifier

Example: 1
statusstring(ProvisioningStatus)required

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
smartBarStatusstring(ProvisioningStatus)

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
internationalBarStatusstring(ProvisioningStatus)

Indicates the current status of the provisioned rental product inventory

Enum"INACTIVE""ACTIVE""ACTIVE_BUT_PORTING""SUSPENDED""PENDING""PENDING_EXTENDED""SUCCESS""ERROR""TERMINATED"
subscriptionIdstring<= 40 characters[\w\p{L}\s%£@&#=':;`’,|!_—–\(\)\\/\-\+\.\?\*\...

Subscription id

rentalProductInventoryIdinteger(int64)read-onlyrequired

Rental product inventory identifier

Example: 1
]
Response
application/json
[
  {
    "id": 1,
    "status": "INACTIVE",
    "smartBarStatus": "INACTIVE",
    "internationalBarStatus": "INACTIVE",
    "subscriptionId": "string",
    "rentalProductInventoryId": 1
  }
]

Check if a set of provisioning details

Request

Check if a set of provisioning details for a rental product inventory exists

Security
bearerAuth
Query
rentalProductInventoryIdstring(IdFilterParam)

Filter by rental product inventory id

Example: rentalProductInventoryId=0
curl -i -X HEAD \
  'https://rest.elevatebilling.com/v2/provisioning-details?rentalProductInventoryId=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Exists

Body