1. GET billingAccount/service/{id}
This operation retrieves billing account details based on msisdn/servicenumber.
URL
http://[host]:[port]/redmond-ux/v1/{businessId}/billingAccount/service/{id}
URL PARAMS
| name | type | description | required |
|---|
| businessId | string | 2 letter ISO 3166 country code (TT, BB, JM, PA, etc.) identifying the business unit. | Y |
| id | string | unique identifier of the service number. (service number) | Y |
| name | value | description | required |
|---|
| client_id | string | The client_id identifying the channel. Minimum characters: 5 | Y |
| client_secret | string | Password associated with the client_id. Minimum characters: 5 | Y |
| X-Correlation-ID | string | Identifier that correlates HTTP request between a client and server. Any identification model (UUDI, checksum, etc.) can be used, as long as it is a unique value to differentiate a transaction. | Y |
Response
Possible success response
This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.
Liberate response Data model
| Name | Type | Description | Required |
|---|
| id | String | Unique identifier of the Billing Account | Y |
| accountType | String | Type/category of customer account | Y |
| description | String | Description of the customer account | Y |
| name | String | Customer account name | Y |
| paymentStatus | String | Current payment status of the account | Y |
| state | String | Lifecycle state of the account | Y |
| bssState | String | Source BSS specific account status | Y |
| accountBalance | Array | Balance information associated with the customer account | Y |
| accountBalance.amount | Object | Monetary amount information | Y |
| accountBalance.amount.unit | String | Currency code of the balance amount | Y |
| accountBalance.amount.value | Number | Monetary value of the balance | Y |
| accountBalance.balanceType | String | Type of balance being reported | Y |
| accountBalance.validFor | Object | Time period during which the balance is applicable | N |
| accountBalance.validFor.endDateTime | DateTime | End date/time of balance validity | N |
| billStructure | Object | Billing structure and cycle information | Y |
| billStructure.cycleSpecification | Object | Billing cycle specification details | Y |
| billStructure.cycleSpecification.id | String | Billing cycle identifier | Y |
| billStructure.cycleSpecification.paymentDueDate | DateTime | Date payment is due | Y |
| billStructure.cycleSpecification.billingDay | Integer | Day of month on which billing occurs | Y |
| billStructure.presentationMedia | Array | Media preferences for bill presentation | Y |
| billStructure.presentationMedia.id | String | Presentation media identifier | Y |
| billStructure.presentationMedia.name | String | Presentation media name | Y |
| paymentPlan | Array | Payment plan configuration associated with account | Y |
| paymentPlan.priority | Integer | Payment plan priority order | Y |
| paymentPlan.planType | String | Type of payment plan | Y |
| paymentPlan.status | Boolean | Indicates whether plan is active | Y |
| paymentPlan.@Type | String | Extended payment plan type classification | Y |
| relatedParty | Array | Parties related to the customer account | Y |
| relatedParty.id | String | Identifier of related party | Y |
| relatedParty.name | String | Name of related party | Y |
| relatedParty.role | String | Role played by related party | Y |
| relatedParty.@type | String | Type of related entity | Y |
| relatedParty.@referredType | String | Referenced entity type | Y |
| relatedParty.@baseType | String | Base type of related party object | Y |
| relatedParty.characteristic | Array | Additional characteristics of the related party | Y |
| relatedParty.characteristic.name | String | Characteristic name | Y |
| relatedParty.characteristic.value | String / Array | Characteristic value | Y |
| relatedParty.characteristic.valueType | String | Data type of the characteristic value | N |
| contact | Array | Contact information associated with account | Y |
| contact.contactName | String | Name of contact person | Y |
| contact.partyRoleType | String | Role of contact relative to account | Y |
| contact.contactMedium | Array | Contact medium details | Y |
| contact.contactMedium.mediumType | String | Type of communication medium | Y |
| contact.contactMedium.characteristic | Object | Contact medium characteristics | Y |
| contact.contactMedium.characteristic.street1 | String | Street address line 1 | Y |
| contact.contactMedium.characteristic.city | String | City name | Y |
| contact.contactMedium.characteristic.stateOrProvince | String | State or province | Y |
| contact.contactMedium.characteristic.country | String | Country name | Y |
| contact.contactMedium.characteristic.emailAddress | String | Email address | Y |
| contact.contactMedium.characteristic.phoneNumber | String | Telephone number | Y |
| creditLimit | Object | Credit limit assigned to account | Y |
| creditLimit.unit | String | Currency code for credit limit | Y |
| creditLimit.value | Number | Credit limit amount | Y |
| defaultPaymentMethod | Object | Default method used for payment | Y |
| defaultPaymentMethod.id | String | Payment method identifier | Y |
| defaultPaymentMethod.name | String | Payment method name | Y |
| recurringFlag | Boolean | Indicates whether recurring payment is enabled | Y |
| sourceBSS | String | Source Billing Support System identifier | Y |
| legalEntity | String | Legal entity owning the account | Y |
| service | Object | Service associated with the customer account | Y |
| service.id | String | Service identifier | Y |
| service.state | String | Current service state | Y |
| service.serviceType | String | Service type classification | Y |
Liberate Success Response
{
"id": "286015730000",
"accountType": "O",
"description": "Browse & Talk HFONE",
"name": "MS Shawnalee M Foster",
"paymentStatus": "Active",
"state": "Closed",
"bssState": "E-Written off",
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "NetPayable"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2023-03-29T00:00:00.000-05:00"
}
},
{
"amount": {
"unit": "JMD",
"value": 4800.00
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2021-07-27T00:00:00.000-05:00"
}
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "DepositRequired"
},
{
"amount": {
"unit": "JMD",
"value": 23769.52
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalQuery"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "DepositHeld"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "Total Query Tax"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalAdjustmentCredit"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalDepositPaid"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalServiceChargeCredit"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalRewards"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "TotalAvailablePointsAmount"
},
{
"amount": {
"unit": "JMD",
"value": 24033.33
},
"balanceType": "BillAmount",
"validFor": {
"endDateTime": "2023-03-29T00:00:00.000-05:00"
}
}
],
"billStructure": {
"cycleSpecification": {
"id": "E",
"paymentDueDate": "2023-03-29T00:00:00.000-05:00",
"billingDay": 9
},
"presentationMedia": [
{
"id": "C",
"name": "Ceased Accounts"
},
{
"id": "E",
"name": "BillLanguage"
}
]
},
"paymentPlan": [
{
"priority": 0,
"planType": "%",
"status": true,
"@Type": "SupportsRecurringPayments"
}
],
"relatedParty": [
{
"id": "110962605",
"name": "MS Shawnalee M Foster",
"role": "customer",
"@type": "Customer",
"@referredType": "Customer",
"@baseType": "RelatedParty",
"characteristic": [
{
"name": "DocumentType",
"value": "TR"
},
{
"name": "DocumentNumber",
"value": "110962605"
},
{
"name": "Gender",
"value": "F"
},
{
"name": "Title",
"value": "MS",
"valueType": "string"
},
{
"name": "FirstName",
"value": "Shawnalee",
"valueType": "string"
},
{
"name": "LastName",
"value": "Foster",
"valueType": "string"
},
{
"name": "OtherName",
"value": "Monique",
"valueType": "string"
},
{
"name": "Date-Of-Birth",
"value": "1982-05-02T00:00:00.000-04:00",
"valueType": "string"
},
{
"name": "Customer Identity",
"valueType": "array",
"value": [
{
"DocumentType": "PP",
"DocumentNumber": "A3963661",
"DocumentDescription": "Passport No"
},
{
"DocumentType": "TR",
"DocumentNumber": "110962605",
"DocumentDescription": "TRN Number"
}
]
}
]
},
{
"id": "LIME",
"role": "legalEntity"
},
{
"@type": "Account",
"characteristic": [
{
"name": "BaseAccountType",
"value": "RES"
}
]
},
{
"id": "990000",
"name": "Residential",
"role": "marketingCategory"
}
],
"contact": [
{
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"street1": "KINGSLAND P.O BOX 22",
"city": "SPUR TREE",
"stateOrProvince": "MANCHESTER",
"country": "JAMAICA"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": ""
}
}
]
},
{
"contactName": "Shawnalee Foster",
"partyRoleType": "OWNER",
"contactMedium": [
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8765703673"
}
}
]
},
{
"contactName": "PAULINE FOSTER",
"partyRoleType": "RELAT",
"contactMedium": [
{
"mediumType": "Telephone",
"characteristic": {
"phoneNumber": "8769646405"
}
}
]
}
],
"creditLimit": {
"unit": "JMD",
"value": 0
},
"defaultPaymentMethod": {
"id": "C",
"name": "Cash"
},
"recurringFlag": false,
"sourceBSS": "LIBERATE",
"legalEntity": "LIME",
"service": {
"id": "8767153626",
"state": "C-Ceased",
"serviceType": "TP"
}
}
Cerillion Data Model
| Name | Type | Description | Required |
|---|
| id | String | Unique identifier of the Billing Account | Y |
| href | String | URI reference of the customer account resource | Y |
| name | String | Customer account name | Y |
| state | String | Lifecycle state of the customer account | Y |
| bssState | String | Source BSS specific account status | Y |
| relatedParty | Array | Parties related to the customer account | Y |
| relatedParty.id | String | Identifier of the related party | Y |
| relatedParty.name | String | Name of the related party | Y |
| relatedParty.role | String | Role played by the related party | Y |
| relatedParty.@type | String | Type of related entity | Y |
| relatedParty.@referredType | String | Referenced entity type | Y |
| relatedParty.@baseType | String | Base type of related party object | Y |
| relatedParty.characteristic | Array | Additional characteristics of the related party | Y |
| relatedParty.characteristic.name | String | Characteristic name | Y |
| relatedParty.characteristic.value | String / Array | Characteristic value | Y |
| relatedParty.characteristic.valueType | String | Datatype of characteristic value | N |
| relatedParty.characteristic.@referredType | String | Referenced type associated with characteristic | Y |
| accountType | String | Type/classification of customer account | Y |
| presentationMedia | Array | Preferred bill presentation channels | Y |
| presentationMedia.id | String | Presentation media identifier | Y |
| presentationMedia.name | String | Presentation media name | Y |
| contact | Array | Contact details associated with the account | Y |
| contact.contactName | String | Contact person name | Y |
| contact.contactType | String | Contact type classification | Y |
| contact.contactMedium | Array | Communication medium details | Y |
| contact.contactMedium.mediumType | String | Type of communication medium | Y |
| contact.contactMedium.characteristic | Object | Characteristics of communication medium | Y |
| contact.contactMedium.characteristic.addressLines1 | String | Primary address line | Y |
| contact.contactMedium.characteristic.street2 | String | Secondary street address | Y |
| contact.contactMedium.characteristic.postCode | String | Postal code | Y |
| contact.contactMedium.characteristic.contactType | String | Telephone contact category | Y |
| contact.contactMedium.characteristic.phoneNumber | String | Telephone number | Y |
| contact.contactMedium.characteristic.emailAddress | String | Email address | Y |
| accountBalance | Array | Account balance information | Y |
| accountBalance.amount | Object | Monetary amount details | Y |
| accountBalance.amount.unit | String | Currency code | Y |
| accountBalance.amount.value | Number | Monetary value | Y |
| accountBalance.balanceType | String | Type of balance | Y |
| accountBalance.validFor | Object | Validity period of balance information | Y |
| accountBalance.validFor.endDateTime | DateTime | End date/time of balance validity | Y |
| billStructure | Object | Billing structure details | Y |
| billStructure.cycleSpecification | Object | Billing cycle specification | Y |
| billStructure.cycleSpecification.id | String | Billing cycle identifier | Y |
| billStructure.cycleSpecification.paymentDueDate | DateTime | Payment due date | Y |
| billStructure.cycleSpecification.billingDay | Integer | Day of month billing is generated | Y |
| billStructure.presentationMedia | Array | Bill presentation media preferences | Y |
| billStructure.presentationMedia.id | String | Presentation media identifier | Y |
| billStructure.presentationMedia.name | String | Presentation media name | Y |
| paymentStatus | String | Current payment status of the account | Y |
| recurringFlag | Boolean | Indicates whether recurring payment is enabled | Y |
| sourceBSS | String | Source Billing Support System | Y |
| service | Object | Service associated with the customer account | Y |
| service.id | String | Service identifier | Y |
| service.state | String | Service status/state | Y |
| service.prepaidIndicator | Boolean | Indicates whether the service is prepaid | Y |
| service.serviceType | String | Service type classification | Y |
Cerillion Success Response
{
"id": "12386701",
"href": "/tmf-api/accountManagement/v1/JM/billingAccount/12386701",
"name": "CHRISTOPHER DUNKLEY",
"state": "Active",
"bssState": "SN",
"relatedParty": [
{
"id": "12386701",
"name": "CHRISTOPHER DUNKLEY",
"role": "customer",
"@type": "Customer",
"@referredType": "Customer",
"@baseType": "RelatedParty",
"characteristic": [
{
"name": "Customer Identity",
"valueType": "array",
"value": [
{
"DocumentType": "TRN",
"DocumentNumber": "102430322",
"DocumentDescription": "TRN Number"
}
]
},
{
"@referredType": "Customer",
"name": "Date-Of-Birth",
"value": "1959-03-25T23:00:00.000-05:00",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "Title",
"value": "MR",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "FirstName",
"value": "CHRISTOPHER",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "LastName",
"value": "DUNKLEY",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "CompanyName",
"value": "DUNKLEY",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "AccountClassificationCode",
"value": "RS",
"valueType": "string"
},
{
"@referredType": "Customer",
"name": "AlternativeEmail",
"value": "CHRISMUZIKDUNKS84@YAHOO.COM",
"valueType": "string"
}
]
},
{
"@referredType": "Customer",
"id": "23170"
},
{
"@referredType": "Account",
"id": "ST"
}
],
"accountType": "RES",
"presentationMedia": [
{
"id": "E",
"name": "EMAIL"
},
{
"id": "en-us",
"name": "BillLanguage"
}
],
"contact": [
{
"contactName": "CHRISTOPHER DUNKLEY",
"contactType": "primary",
"contactMedium": [
{
"mediumType": "BillingAddress",
"characteristic": {
"addressLines1": "3",
"street2": "SANDY LANE",
"postCode": "00020"
}
},
{
"mediumType": "Telephone",
"characteristic": {
"contactType": "MOBILE_NO",
"phoneNumber": "8768409971"
}
},
{
"mediumType": "Email",
"characteristic": {
"emailAddress": "CHRISMUZIKDUNKS84@YAHOO.COM"
}
}
]
}
],
"accountBalance": [
{
"amount": {
"unit": "JMD",
"value": 8055
},
"balanceType": "LastPayment Amount",
"validFor": {
"endDateTime": "2024-06-13T16:31:13.000-05:00"
}
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "CurrentBalance"
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "Overdue Amount"
},
{
"amount": {
"unit": "JMD",
"value": 0.00
},
"balanceType": "WrittenOffAmount"
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "TotalOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "LastBillAmount",
"validFor": {
"endDateTime": "2026-06-15T23:00:00.000-05:00"
}
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "LedgerBalance"
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "CurrentOutstandingBalance"
},
{
"amount": {
"unit": "JMD",
"value": 25270.66
},
"balanceType": "BillAmount",
"validFor": {
"endDateTime": "2026-06-15T23:00:00.000-05:00"
}
}
],
"billStructure": {
"cycleSpecification": {
"paymentDueDate": "2026-06-15T23:00:00.000-05:00",
"id": "JMT",
"billingDay": 1
},
"presentationMedia": [
{
"id": "E",
"name": "EMAIL"
},
{
"id": "en-us",
"name": "BillLanguage"
}
]
},
"paymentStatus": "In Arrears",
"recurringFlag": false,
"sourceBSS": "CERILLION",
"service": {
"id": "8766346821",
"state": "CU",
"prepaidIndicator": false,
"serviceType": "TP"
}
}