Managed Entity and Task Resource Models
JSON based representation of the managed entities and tasks.
BillingAccount Resource
A BillingAccount is a detailed description of a customer's bill structure.
JSON representation of a BillingAccount
{ |
Customer billing cycle specification Resource
{ |
Customer bill Format Resource
{ |
customer bill presentation media Resource
{ |
Field Descriptions :
BillingAccount: A detailed description of a customer's bill structure.
Field | Description |
id | Unique identifier of the billing account |
href | Reference of the billing account |
name | A short descriptive name |
ratingType | Rating type (prepaid, postpaid) of the billing account |
state | Used to track the lifecycle state |
validFor. | The period for which the billing account is valid |
BillingAccountBalance: Balance of the Billing Account.
Field | Description |
type | Type of the balance |
amount | Balance amount |
validFor | Balance validity period |
status | Balance status |
CustomerAccount: An arrangement that a customer has with an enterprise that provides products to the customer (SID definition to be reviewed?).
Field | Description |
id | Unique identifier of the customer account |
href | Reference of the customer account |
name | A short descriptive name |
CustomerBillingCycleSpecification: A detailed description of when to initiate a billing cycle and the various sub steps of a billing cycle.
Field | Description |
id | Unique identifier of the customer billing cycle specification |
billingDateShift | An offset of a billing date. The offset is expressed as number of days with regard to the start of the billing period. |
frequency | Frequency of the billing cycle (monthly for instance) |
href | Reference of the customer billing cycle specification |
name | A short descriptive name |
CustomerBillFormat: A detailed description of the way in which a customer's bill is presented.
Field | Description |
id | Unique identifier of the customer bill format |
href | Reference of the customer bill format |
name | A short descriptive name |
CustomerBillPresentationMedia: A means of communicating a CustomerBill, supported by the associated bill format. For example, post mail, email, web page.
Field | Description |
id | Unique identifier of the customer bill presentation media |
href | Reference of the customer bill presentation media |
name | A short descriptive name |
Currency: A base / value business entity used to represent currency.
Field | Description |
currencyCode | A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro) |
PaymentMean: defines a specific mean of payment (e.g. direct debit with all details associated).
Field | Description |
id | Unique identifier of the payment mean |
href | Reference of the payment mean |
name | Name of the payment mean |
RelatedParty: Defines party or partyRole linked to a specific entity.
Field | Description |
id | Unique identifier of related party |
href | Reference of the relatedParty, could be a party reference or a partyRole reference |
role | Role of the related party |
UML models:
Figure 1 – BillingAccount resource model
Figure 2 – CustomerBillPresentationMedia resource model
Figure 3 CustomerBillingCycleSpecification resource model
Figure 4 CustomerBillFormat resource model
applied customer billing charge Resource
{ |
Tax rate should be further defined by experts.
Field Descriptions :
AppliedCustomerBillingCharge: An amount, usually of money, for which a person or an organization is financially liable.
Field | Description |
id | Unique identifier of the applied customer billing charge |
href | Reference of the applied customer billing charge |
date | Creation date of the applied customer billing charge |
description | Additional data to be displayed on the customer bill for this applied customer billing charge |
type | Type of the applied customer billing charge (recurring, one time or usage) necessary to find the category of the invoice where the charge has to be displayed |
currencyCode | A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro) |
taxIncludedAmount | All taxes included amount to be charged on the customer bill (expressed in the given currency) |
taxExcludedAmount | Tax excluded amount to be charged on the customer bill (expressed in the given currency) |
AppliedCustomerBillingTaxRate: An amount of money levied on the price of a product by a legislative body.
Field | Description |
amount | Tax amount |
taxCategory | A categorization of the tax rate |
Period: defines the period of a recurring charge
Field | Description |
startPeriod | Start date of the period |
endPeriod | End date of the period |
ProductSpecification: A detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to Customers or other Parties playing a PartyRole.
Field | Description |
productNumber | An identification number assigned to uniquely identity the specification |
Name | The name of the product specification |
ServiceId: defines the identifier of the service
Field | Description |
id | Identifier of the service |
type | Type of the service identifier (e.g. mobile number) |
UML models:
Figure 5 AppliedCustomerBillingCharge (Bill Item) resource model
Settlement note ADVICE Resource
{ |
Field Descriptions :
SettlementNoteAdvice: The settlement is about transferring money receiving by a CSP to a partner. The settlement is notified to the partner with a settlement note advice containing details in settlement lines.
Field | Description |
id | A unique identifier for the settlement note advice |
date | Creation date of the settlement note advice |
description | A free description text |
href | Reference of the settlement note advice |
paymentDueDate | Date at which the due amount should have been paid to the partner |
taxDate | Date of the tax |
currencyCode | A string used as a code for specifying the currency associated to the given amounts. The ISO4217 norm uses 3 letters to define the currency (for example USD for US dollar or EUR for Euro) |
taxExcludedAmount | All taxes excluded amount (expressed in the given currency) |
taxIncludedAmount | All taxes included amount (expressed in the given currency) |
TaxItem: A tax item is created for each tax rate and tax type used in the settlement note.
Field | Description |
taxCategory | Tax category (for example VAT) |
taxRate | Tax rate |
taxAmount | Tax amount |
SettlementMethod: is the way in which the CSP provides the payment.
Field | Description |
Code | Code of the settlement method |
label | A word, term or phrase by which a settlement method is known and distinguished from other settlement method |
Receiver: PartyRole who will receive the settlement note.
Field | Description |
id | Identifier of the receiver |
href | Reference of the receiver |
Issuer: PartyRole who will issue the settlement note.
Field | Description |
id | Identifier of the issuer |
href | Reference of the issuer |
TaxRegistration: The CSP and the partner could be registered with a tax number in a tax registration system.
Field | Description |
number | Tax registration number |
SettlementNoteImage: is the image of the settlement note.
Field | Description |
imageFormat | The format of the settlement note image (Csv, pdf, xls, txt…) |
imageSize | The size of the settlement note image (in bytes) |
imageFileName | The name of the file in which the settlement note image is saved |
imageFileURL | The URL of the settlement note image |
SettlementNoteItem: concerns a product identified by its catalogue reference. It could also follow a period delimited by a start and an end date.
Field | Description |
itemNumber | Unique number assigned to the settlement note item |
itemId | Unique identifier of the settlement note item |
itemLabel | A free description text for the settlement note item |
quantity | Quantity |
taxExcludedUnitPrice | Tax excluded unit price to be applied on the given quantity |
taxExcludedAmount | Tax excluded amount equal to quantity * taxExcludedUnitPrice |
taxIncludedAmount | All taxes included amount equal to taxExcludedAmount + taxAmount |
Period: defines the period of a recurring charge
Field | Description |
startPeriod | Start date of the period |
endPeriod | End date of the period |
ProductSpecification: A detailed description of a tangible or intangible object made available externally in the form of a ProductOffering to Customers or other Parties playing a PartyRole.
Field | Description |
productNumber | An identification number assigned to uniquely identity the specification |
Name | The name of the product specification |
UML models
Figure 6 – SettlementNoteAdvice resource model
BillingAccount lifecycle:
Figure 7 : Billing Account States
State definitions:
- Defined / created: billing account has been created but no related invoice can be produced
- Active: The billing account is active and related invoices are produced
- Pending update : billing account update is planned and will be effective for next billing cycle
- Suspended : billing account has been suspended on customer request or for other reasons (bad debts, etc.)
- Pending closed: the billing account will be closed when the last invoice will have been produced
- Closed : the billing account is closed and can not be changed to another state.
Notification Resource Models
Two notification event types are defined:
- BillingAccountStateChangeNotification
- SettlementNoteAdviceNotification
Billing Account State Change Notification UML Diagram:
BillingAccount State Change Notification
{ |
Settlement Note Advice Notification UML Diagram:
SettlementNoteAdvice Notification
{ |
© TM Forum 2015. All Rights Reserved.