Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
_Toc404178534
_Toc404178534
Managed Entity and Task Resource Models

JSON based representation of the managed entities and tasks.

Anchor
_Toc404178535
_Toc404178535
BillingAccount Resource

A BillingAccount is a detailed description of a customer's bill structure.
JSON representation of a BillingAccount

{
"id": "65",
"href": "http://serverlocation:port/billingManagement/billingAccount/65",
"ratingType": "postpaid",
"name": "my personal Billing Account",
"state": "Active",
"validFor": {
"startDateTime": "2013-04-19T16:42:23.0Z"
},
"customerAccount": {
"id": "15",
"href": "http://serverlocation:port/customerManagement/customerAccount/15",
"name": "Customer Account xxx"
},
"customerBillingCycleSpecification": {
"id": "26",
"href": "http://serverlocation:port/billingManagement/customerbillingCycleSpecification/26",
"name": "Monthly billing on the 15"
},
"customerBillFormat": {
"id": "23",
"href": "http://serverlocation:port/billingManagement/customerBillFormat/23",
"name": "Detailed invoice"
},
"customerBillPresentationMedia": {
"id": "25",
"href": "http://serverlocation:port/billingManagement/customerBillPresentationMedia/25",
"name": "Electronic invoice"
},
"currency": {
"currencyCode": "EUR"
},
"billingAccountBalance": [
{
"type": "ReceivableBalance",
"amount": 52.3,
"validFor": {
"startDateTime": "2013-04-19T16:42:23.0Z",
"endDateTime": "2013-06-19T00:00:00.0Z"
},
"status": "Due"
}
],
"relatedParty": [
{
"id": "1",
"href": "http://serverlocation:port/partyManagement/partyRole/1",
"role": "bill receiver"
},
{
"id": "5",
"href": "http://serverlocation:port/partyManagement/partyRole/5",
"role": "bill responsible"
}
],
"paymentMean": {
"id": "45",
"href": "http://serverlocation:port/customerManagement/paymentMean/45",
"name": "my favourite payment mean"
}
}

Anchor
_Toc404178536
_Toc404178536
Customer billing cycle specification Resource

{
"id": "26",
"href": "http://serverlocation:port/billingManagement/customerbillingCycleSpecification/26",
"name": "Monthly billing on the 15",
"billingDateShift": 15,
"frequency": "monthly"
}

Anchor
_Toc404178537
_Toc404178537
Customer bill Format Resource

{
"id": "23",
"href": "http://serverlocation:port/billingManagement/customerBillFormat/23",
"name": "Detailed invoice"
}

 

Anchor
_Toc404178538
_Toc404178538
customer bill presentation media Resource

{
"id": "25",
"href": "http://serverlocation:port/billingManagement/customerBillPresentationMedia/25",
"name": "Electronic invoice"
}

...




UML models:

Figure 1 BillingAccount resource model

Figure 2 – CustomerBillPresentationMedia resource model

Figure 3 CustomerBillingCycleSpecification resource model

Figure 4 CustomerBillFormat resource model

Anchor
_Toc404178539
_Toc404178539
applied customer billing charge Resource

{
"id": "25",
"href": "http://serverlocation:port/BillingManagement/appliedCustomerBillingCharge/25",
"date": "2013-04-19T16:42:23.0Z",
"description": "Partner Premium monthly fee",
"type": "Recurring",
"currencyCode": "USD",
"taxIncludedAmount": 2.4,
"taxExcludedAmount": 2,
"appliedCustomerBillingTaxRate": [
{
"amount": 0.4,
"taxCategory": "VAT"
}
],
"serviceId": [
{
"id": "0601020304",
"type": "Mobile number"
}
],
"productSpecification": [
{
"name": "Partner Premium",
"productNumber": "P001"
}
],
"period": [
{
"startPeriod": "2013-10-01T00:00:00.0Z",
"endPeriod": "2013-10-31T00:00:00.0Z"
}
]
}

...


UML models:

Figure 5 AppliedCustomerBillingCharge (Bill Item) resource model

Anchor
_Toc404178540
_Toc404178540
Settlement note ADVICE Resource

{
"id": "26",
"href": "http://serverlocation:port/BillingManagement/settlementNoteAdvice/26",
"date": "2013-04-19T16:42:23.0Z",
"description": "Settlement note â€" From 2013/10/01 to 2013/10/31",
"paymentDueDate": "2013-04-19T16:42:23.0Z",
"taxDate": "2013-04-19T16:42:23.0Z",
"currencyCode": "EUR",
"taxExcludedAmount": 89933.25,
"taxIncludedAmount": 107560.16,
"taxItem": [
{
"taxCategory": "VAT",
"taxRate": 19.6,
"taxAmount": 17626.91
}
],
"settlementMethod": {
"code": "NET",
"label": "Netting"
},
"receiver": {
"id": "63796",
"href": "http://serverlocation:port/PartyManagement/partyRole/63796",
"taxRegistration": {
"number": "FR12345678912"
}
},
"issuer": {
"id": "0800",
"href": "http://serverlocation:port/PartyManagement/partyRole/0800",
"taxRegistration": {
"number": "FR98765432178"
}
},
"settlementNoteImage": {
"imageFormat": "pdf",
"imageSize": 130,
"imageFileName": "BungiornoFrance-2013October-1234",
"imageFileURL": "http://serverlocation:port/SettlementNoteImage/RQAAAABAAAAAAAAALryCQAbAAAAMAAxAF8ASQBuAHMAdABhAGwAb"
},
"settlementNoteItem": [
{
"itemNumber": "1",
"itemId": "0815",
"itemLabel": "Achats Gamifive",
"quantity": 34873,
"taxExcludedUnitPrice": 1.463,
"taxExcludedAmount": 51019.2,
"taxIncludedAmount": 61018.96,
"taxItem": [
{
"taxCategory": "VAT",
"taxRate": 19.6,
"taxAmount": 9999.76
}
],
"period": {
"startPeriod": "2013-10-01T00:00:00.0Z",
"endPeriod": "2013-10-31T00:00:00.0Z"
},
"productSpecification": {
"name": "Gamifive",
"productNumber": "17060"
}
},
{
"itemNumber": "2",
"itemId": "0816",
"itemLabel": "Achats iGirls TV",
"quantity": 19001,
"taxExcludedUnitPrice": 2.048,
"taxExcludedAmount": 38914.05,
"taxIncludedAmount": 46541.2,
"period": {
"startPeriod": "2013-10-01T00:00:00.0Z",
"endPeriod": "2013-10-31T00:00:00.0Z"
},
"productSpecification": {
"name": "iGirls TV",
"productNumber": "17063"
}
}
]
}

...

    • 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.

Anchor
_Toc404178541
_Toc404178541
Notification Resource Models

Two notification event types are defined:

...


Billing Account State Change Notification UML Diagram:

Anchor
_Toc399424580
_Toc399424580
Anchor
_Toc404178542
_Toc404178542
BillingAccount State Change Notification

{
"eventType": "BillingAccountStateChangeNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "13048231",
"event":
{
"billingAccount":
{
"id": "43",
Following a whole representation of the BillingAccount with all its attributes See BillingAccount Resource.
}
}
}


Settlement Note Advice Notification UML Diagram:

Anchor
_Toc404178543
_Toc404178543
SettlementNoteAdvice Notification

{
"eventType": "SettlementNoteAdviceNotification",
"eventTime": "2014-09-27T05:46:25.0Z",
"eventId": "108345",
"event":
{
"settlementNoteAdvice":
{
"id": "456",
Following a whole representation of the SettlementNoteAdvice with all its attributes See SettlementNoteAdvice Resource.
}
}
}

© TM Forum 2015. All Rights Reserved.