Download OpenAPI specification:Download
Product inventory controls the products and services that are assigned to Sites.
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.
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.
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.
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.
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.