dxp-ux
Retrieve CustomerBillById (TMF-678)
[GET]
The customerBill API provides below features,
#GetCustomerBillById#: This operation retrieve CustomerBill Summary for particular bill and retrieve PDF for CSG.
Please find sample requests and responses below.
This API is available for LCPR - CSG, ARIA.
GetCustomerBillById
URL
http://[localhost]:[port]/dxp-ux/v1/{businessId}/customerBill/idURL PARAMS
| name | type | description | required |
|---|---|---|---|
| businessId | string | 2 letter ISO 3166 country code Ex: PR, JM, PA | Y |
| id | string | Bill identifier. billNo received from GET:/customerBill | Y |
Header
| 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 Minimum characters: 1 | N |
| lob | string | The Line of Business Identifier currently available are: POSTPAID, FIXED | Y |
| channelId | string | This is to identify the source (Project). Value : APP Conditionally Mandatory. | Y |
| targetSystem | string | This is not required for POSTPAID. Use this data type to indicate target system name/id in your request. enum csg From biz api, account length is used for routing. For CSG system account length is 16. csg is only in scope for now. | N |
Query Param
| name | type | description | required |
|---|---|---|---|
| accountId | string | This is billing account number which is unique for the customer Note: account id for which we are fetching bill. From biz api, account length is used for routing. For CSG system account length is 16 | Y |
| runType | string | Reset counter value for bill reference number | Not in scope |
| boolean | Flag to include the bill pdf. If true, pdf content is send in response, if false or absent ,only bill summary is sent. | Y for CSG | |
| pdfId | boolean | Flag to indicate Evertec pdf bill. Bill details from CSG will not be present in the response. Note : this queryparam for Csg if lob as "FIXED" | Y for CSG |
Note :
To fetch CustomerBill Summary from PR Csg customers need to pass lob as "Fixed"
To fetch CustomerBill Summary from PR Customers in aria need to pass lob as "POSTPAID".
To fetch CustomerBill Summary for PR from Csg,
- if pdf is true and pdfId is false, then response is from csg and evertec pdf data
- if pdf is false and pdfId is true, then response is from only evertec pdf data
- if pdf is false and pdfId is false, then response is from csg data
RESPONSE BODY FOR getCustomerBillById -CSG
PDF = false ,PDFID = false
{
"id": "77773H00002735P0",
"href": "https://esb-dev.lla.com/customerBillManagement/customerBill/77773H00002735P0",
"billNo": "77773H00002735P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-08-29T00:00:00.000Z",
"billDate": "2022-08-14T00:00:00.000Z",
"nextBillDate": "2022-09-13T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-09-13T00:00:00.000Z",
"startDateTime": "2022-08-14T00:00:00.000Z"
},
"amountDue": {
"value": 85.34,
"unit": "USD"
},
"paymentDueDate": "2022-08-31T00:00:00.000Z",
"remainingAmount": {
"value": 85.34,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 85.34,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"@schemaLocation": "www.bill.customerBill.json",
"appliedPayment": [
{
"appliedAmount": {
"value": 85.34,
"unit": "USD"
},
"payment": {
"id": "8779198000000010",
"paymentDate": "2022-08-01",
"@referredType": "payment"
}
}
],
"billingAccount": {
"id": "8211990010000479",
"href": "https://esb-dev.lla.com/accountManagement/billingAccount/8211990010000479",
"name": "TORIBIO JAVIER",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.0,
"taxAmount": {
"value": 1.05,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.1,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911",
"taxRate": 0.0,
"taxAmount": {
"value": 0.5,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.11,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.59,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb-dev.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb-dev.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "TORIBIO JAVIER",
"@referredType": "individualParty"
},
{
"href": "https://esb-dev.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "TORIBIO JAVIER",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb-dev.lla.com/accountManagement/financialAccount/15",
"name": "TORIBIO JAVIER",
"@referredType": "financialAccount"
}
}PDF = true, PDFID = false
{
"id": "77773H00002735P0",
"href": "https://esb-dev.lla.com/customerBillManagement/customerBill/77773H00002735P0",
"billNo": "77773H00002735P0",
"runType": "onCycle",
"category": "normal",
"state": "due",
"lastUpdate": "2022-08-29T00:00:00.000Z",
"billDate": "2022-08-14T00:00:00.000Z",
"nextBillDate": "2022-09-13T00:00:00.000Z",
"billingPeriod": {
"endDateTime": "2022-09-13T00:00:00.000Z",
"startDateTime": "2022-08-14T00:00:00.000Z"
},
"amountDue": {
"value": 85.34,
"unit": "USD"
},
"paymentDueDate": "2022-08-31T00:00:00.000Z",
"remainingAmount": {
"value": 85.34,
"unit": "USD"
},
"taxIncludedAmount": {
"value": 85.34,
"unit": "USD"
},
"@baseType": "bill",
"@type": "customerBill",
"@schemaLocation": "www.bill.customerBill.json",
"appliedPayment": [
{
"appliedAmount": {
"value": 85.34,
"unit": "USD"
},
"payment": {
"id": "8779198000000010",
"paymentDate": "2022-08-01",
"@referredType": "payment"
}
}
],
"billDocument": [
{
"id": "8211990010021897",
"name": "\\\\EVT-CUPCEZAP-01\\eStatements\\PDF\\000010000821199001002189720220325.pdf",
"mimeType": "application/pdf",
"size": {
"amount": 254760,
"unit": "bytes"
},
"@type": "billDocument",
"content": "JVBERi0xLjQKJeLjz9MNCjYgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU3VidHlwZS9JbWFnZQovV2lkdGggNTU3Ci9IZWlnaHQgMTI5Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0NvbG9y...."
}
],
"billingAccount": {
"id": "8211990010000479",
"href": "https://esb-dev.lla.com/accountManagement/billingAccount/8211990010000479",
"name": "TORIBIO JAVIER",
"@referredType": "billingAccount"
},
"taxItem": [
{
"taxCategory": "IVU ESTATAL",
"taxRate": 0.0,
"taxAmount": {
"value": 1.05,
"unit": "USD"
}
},
{
"taxCategory": "IVU MUNICIPAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.1,
"unit": "USD"
}
},
{
"taxCategory": "CARGO POR SERVICIO DE 911",
"taxRate": 0.0,
"taxAmount": {
"value": 0.5,
"unit": "USD"
}
},
{
"taxCategory": "CARGO LOCAL DE SERVICIO UNIVERSAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.11,
"unit": "USD"
}
},
{
"taxCategory": "CARGO SERVICIO UNIVERSAL INTERESTATAL",
"taxRate": 0.0,
"taxAmount": {
"value": 0.59,
"unit": "USD"
}
}
],
"relatedParty": [
{
"href": "https://esb-dev.lla.com/partyManagement/individual/500",
"role": "issuer",
"id": "500",
"name": "LCPR",
"@referredType": "organizationParty"
},
{
"href": "https://esb-dev.lla.com/partyManagement/individual/710",
"role": "billReceiver",
"id": "710",
"name": "TORIBIO JAVIER",
"@referredType": "individualParty"
},
{
"href": "https://esb-dev.lla.com/partyManagement/individual/710",
"role": "payer",
"id": "710",
"name": "TORIBIO JAVIER",
"@referredType": "individualParty"
}
],
"financialAccount": {
"id": "15",
"href": "https://esb-dev.lla.com/accountManagement/financialAccount/15",
"name": "TORIBIO JAVIER",
"@referredType": "financialAccount"
}
}PDF = false, PDFID = True
{
"billDocument": [
{
"id": "192392349",
"name": "\\\\EVT-CUPCEZAP-01\\eStatements\\PDF\\000010000821199001004229920220205.pdf",
"mimeType": "application/pdf",
"@type": "billDocument",
"content": "JVBERi0xLjQKJeLjz9MNCjYgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU3VidHlwZS9JbWFnZQovV2lkdGggNTU3Ci9IZWlnaHQgMTI5Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0NvbG9yU3Bh
}
],
"billingAccount": {
"id": "8211990010042299",
"@referredType": "billingAccount"
}
}
Response from Aria:
{
"id": "165279006",
"category": "Anniversary Period Invoice",
"state": "validated",
"@type": "InvoiceLineDetails",
"billingAccount": {
"id": "DAVE2021091002",
"@type": "AccountRef"
},
"relatedParty": [
{
"id": "7858208",
"@type": "BillingGroupNumber"
},
{
"id": "25898444",
"@type": "AccountMasterPlanRef"
}
],
"billingPeriod": {
"endDateTime": "2021-09-09T00:00:00.000Z",
"startDateTime": "2021-08-10T00:00:00.000Z"
},
"extendedCharacteristic": [
{
"name": "acct_locale_name",
"value": "System_US_English_locale"
},
{
"name": "rb_status",
"value": "False"
},
{
"name": "overall_bill_from_date",
"value": "2021-09-10T00:00:00.000Z"
},
{
"name": "overall_bill_thru_date",
"value": "2021-10-09T00:00:00.000Z"
}
],
"appliedPayment": [
{
"appliedAmount": {
"unit": "usd",
"value": 45
},
"payment": {
"id": "2392927413",
"@type": "invoice_line_transaction_id"
},
"extendedCharacteristic": [
{
"name": "service_name",
"value": "Mobile Connection Fee"
},
{
"name": "client_service_id",
"value": "PR_B2C_Mobile_Con_Fee_Voice"
},
{
"name": "plan_name",
"value": "Unlimited Elite Base"
},
{
"name": "client_plan_id",
"value": "Unlimited_Elite_Base"
},
{
"name": "line_type",
"value": "Activation Charge"
},
{
"name": "client_rate_schedule_id",
"value": "PHLSC01_10615583"
},
{
"name": "client_plan_instance_id",
"value": "25898444"
},
{
"name": "tax_related_ind",
"value": "0"
},
{
"name": "units",
"value": "1"
},
{
"name": "rate_per_unit",
"value": "45"
},
{
"name": "rate_schedule_tier_no",
"value": "1"
}
],
"@type": "Activation Fee",
"@baseType": "invoice_line_no_1"
},
{
"appliedAmount": {
"unit": "usd",
"value": 0
},
"payment": {
"id": "2392927414",
"@type": "invoice_line_transaction_id"
},
"extendedCharacteristic": [
{
"name": "service_name",
"value": "Puerto Rico Universal Service"
},
{
"name": "client_service_id",
"value": "State_Universal_Service_Fund_Fee"
},
{
"name": "plan_name",
"value": "Unlimited Elite Base"
},
{
"name": "client_plan_id",
"value": "Unlimited_Elite_Base"
},
{
"name": "line_type",
"value": "Recurring charge"
},
{
"name": "client_rate_schedule_id",
"value": "PHLSC01_10615583"
},
{
"name": "client_plan_instance_id",
"value": "25898444"
},
{
"name": "tax_related_ind",
"value": "0"
},
{
"name": "units",
"value": "1"
},
{
"name": "rate_per_unit",
"value": "0"
},
{
"name": "date_range_start",
"value": "2021-09-10T00:00:00.000Z"
},
{
"name": "date_range_end",
"value": "2021-10-09T00:00:00.000Z"
},
{
"name": "base_plan_units",
"value": "1"
},
{
"name": "proration_factor",
"value": "1"
},
{
"name": "rate_schedule_tier_no",
"value": "1"
}
],
"@type": "State Universal Service Fund Fee",
"@baseType": "invoice_line_no_2"
}
]
}Data model for the response:
| name | type | description | required |
|---|---|---|---|
| id | string | Unique identifier of he bill | Y |
| href | string | Bill unique reference | N |
| billDate | datetime | Bill date | Y |
| billNo | string | Bill reference known by the customer or the party and displayed on the bill. Could be different from the id | N |
| category | string | Category of the bill produced : For example: Anniversary Period Invoice, normal, duplicate, interim, last, trial customer or credit note | N |
| lastUpdate | datetime | Date of bill last update | N |
| nextBillDate | datetime | Approximate date of the next bill production given for information (only used for onCycle bill) | N |
| paymentDueDate | datetime | Date at which the amount due should have been paid | Y |
| runType | string | onCycle (a bill can be created as a result of a cycle run) or offCycle (a bill can be created as a result of other events such as customer request or account close) | N |
| amountDue | array | Y | |
| amountDue.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| amountDue.value | string | A positive floating point number | N |
| accountBalance | array | Balances linked to the account | N |
| accountBalance.amount | object | Balance amount | N |
| accountBalance.balanceType | string | Type of the balance - Previous Balance, deposit balance, disputed balance, loyalty balance, receivable balance...Default value is "BeginningBalance" | N |
| accountBalance.amount.value | number | A floating point number | N |
| accountBalance.amount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| accountBalance.validFor | object | The period of time for which the attachment is valid. Not in scope | N |
| accountBalance.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| accountBalance.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| appliedPayment | object array | The applied payment is the result of lettering process. It enables to assign automatically or manually part of incoming payment amount to a bill. | N |
| appliedPayment.appliedAmount | array | ||
| appliedPayment.appliedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| appliedPayment.appliedAmount.value | string | A positive floating point number | N |
| appliedPayment.payment | array | A EntityRef is a detailed description of a bill structure. | N |
| appliedPayment.payment.id | string | Unique identifier for the EntityRef | N |
| appliedPayment.payment.href | string | Reference of the EntityRef | N |
| appliedPayment.payment.name | string | Name of the EntityRe | N |
| appliedPayment.payment.@baseType | string | When sub-classing, this defines the super-class | N |
| appliedPayment.payment.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| appliedPayment.payment.@type | string | When sub-classing, this defines the sub-class entity name | N |
| appliedPayment.payment.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| appliedPayment.@baseType | string | When sub-classing, this defines the super-class | N |
| appliedPayment.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| appliedPayment.@type | string | When sub-classing, this defines the sub-class entity name | N |
| billDocument | array | An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself | N |
| billDocument.id | string | Unique identifier for this particular attachment | N |
| billDocument.href | string | URI for this Attachment | N |
| billDocument.attachmentType | string | Attachment type such as video, picture | N |
| billDocument.content | string | The actual contents of the attachment object, if embedded, encoded as base64 | N |
| billDocument.description | string | A narrative text describing the content of the attachment | N |
| billDocument.mimeType | string | Attachment mime type such as extension file for video, picture and document | N |
| billDocument.name | string | The name of the attachment | N |
| billDocument.url | string | Uniform Resource Locator, is a web page address (a subset of URI) | N |
| billDocument.size | string | The size of the attachment. | N |
| billDocument.validFor | array | The period of time for which the attachment is valid | N |
| billDocument.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| billDocument.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| billingAccount | array | A EntityRef is a detailed description of a bill structure. | N |
| billingAccount.id | string | Unique identifier of the billing account(BAN-CAN) | N |
| billingAccount.href | string | Reference of the EntityRef | N |
| billingAccount.name | string | Name of the EntityRe | N |
| billingAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| billingAccount.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| billingAccount.@type | string | Type of the billingAccount.id (AccountRef) | N |
| billingAccount.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| billingPeriod | array | N | |
| billingPeriod.validFor.endDateTime | datetime | End of the time period. | N |
| billingPeriod.validFor.startDateTime | datetime | Start of the time period. If you define a start, you must also define an end | N |
| financialAccount | array | AccountReceivable reference. An account of money owed by a party to another entity in exchange for goods or services that have been delivered or used. An account receivable aggregates the amounts of one or more party accounts (billing or settlement) owned by a given party. | N |
| financialAccount.id | string | Unique identifier for the account | N |
| financialAccount.href | string | Reference of the account | N |
| financialAccount.name | string | Name of the account | N |
| financialAccount.accountBalance | array | Balances linked to the account | N |
| balanceType | Type of the balance ; deposit balance, disputed balance, loyalty balance, receivable balance | ||
| balanceType.amount | array | ||
| balanceType.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| balanceType.value | string | A positive floating point number | N |
| balanceType.validFor | |||
| balanceType.validFor.endDateTime | datetime | End of the time period, using IETC-RFC-3339 format | N |
| balanceType.validFor.startDateTime | datetime | Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end | N |
| balanceType.@baseType | string | When sub-classing, this defines the super-class | N |
| balanceType.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| balanceType.@type | string | When sub-classing, this defines the sub-class entity name | N |
| financialAccount.@baseType | string | When sub-classing, this defines the super-class | N |
| financialAccount.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| financialAccount.@type | string | When sub-classing, this defines the sub-class entity name | N |
| financialAccount.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| paymentMethod | array | N | |
| paymentMethod.id | string | Unique identifier for the EntityRef | N |
| paymentMethod.href | string | Reference of the EntityRef | N |
| paymentMethod.name | string | Name of the EntityRe | N |
| paymentMethod.@baseType | string | When sub-classing, this defines the super-class | N |
| paymentMethod.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| paymentMethod.@type | string | When sub-classing, this defines the sub-class entity name | N |
| paymentMethod.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| relatedParty | array | Related Entity reference. A related party defines party or party role linked to a specific entity | N |
| relatedParty.id | string | Unique identifier for the related entity. | N |
| relatedParty.href | string | Reference of the related entity. | N |
| relatedParty.name | string | Name of the related entity. | N |
| relatedParty.role | string | Role played by the related party | N |
| relatedParty.@baseType | string | When sub-classing, this defines the super-class | N |
| relatedParty.@schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| relatedParty.@type | string | Related party of the billing account. It can be BillingGroupNumber, AccountMasterPlanRef | N |
| relatedParty.@referredType | string | The actual type of the target instance when needed for disambiguation. | N |
| remainingAmount | array | N | |
| remainingAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| remainingAmount.value | string | A positive floating point number | N |
| state | string | Current state of the bill. enum: - new - onHold - validated - sent - partiallyPaid - settled - due - paid | Y |
| taxExcludedAmount | array | N | |
| taxExcludedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxExcludedAmount.value | string | A positive floating point number | N |
| taxIncludedAmount | array | N | |
| taxIncludedAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxIncludedAmount.value | string | A positive floating point number | N |
| taxItem | array | N | |
| taxItem.taxCategory | string | tax Category | |
| taxItem.taxRate | number | Applied rate of the tax | |
| taxItem.taxAmount | array | Amount of tax expressed in the given currency | |
| taxItem.taxAmount.unit | string | Currency (ISO4217 norm uses 3 letters to define the currency) | N |
| taxItem.taxAmount.value | string | A positive floating point number | N |
| @baseType | string | When sub-classing, this defines the super-class | N |
| @schemaLocation | string | A URI to a JSON-Schema file that defines additional attributes and relationships | N |
| @type | string | Hard coded value "InvoiceLineDetails" | N |
Extended Characteristics data model:
extendedCharacteristic:
| name | type | description | required |
|---|---|---|---|
| extendedCharacteristic.name | String | acct_locale_name (Name of the account level locale) | N |
| extendedCharacteristic.value | string | System_US_English_locale | N |
| extendedCharacteristic.name | string | rb_status (Indicates whether the current invoice has been rebilled.) | N |
| extendedCharacteristic.value | boolean | true/ fales | N |
| extendedCharacteristic.name | String | overall_bill_from_date (The earliest date for this invoicing period.) | N |
| extendedCharacteristic.value | String | 2021-09-10T00:00:00.000Z | N |
| extendedCharacteristic.name | String | overall_bill_thru_date (The latest date for this invoicing period.) | N |
| extendedCharacteristic.value | String | 2021-10-09T00:00:00.000Z | N |
appliedPayment.extendedCharacteristic:
| name | type | description | required |
|---|---|---|---|
| extendedCharacteristic.name | String | service_name (The name corresponding to this line items service code.) | N |
| extendedCharacteristic.value | string | Mobile Connection Fee | N |
| extendedCharacteristic.name | string | client_service_id (The unique client-defined unique service ID associated with this line item.) | N |
| extendedCharacteristic.value | String | PR_B2C_Mobile_Con_Fee_Voice | N |
| extendedCharacteristic.name | String | plan_name (The name of the plan associated with this line item) | N |
| extendedCharacteristic.value | String | Unlimited Elite Base | N |
| extendedCharacteristic.name | String | client_plan_id (The unique client-defined plan ID associated with this line item) | N |
| extendedCharacteristic.value | String | Unlimited_Elite_Base | N |
| extendedCharacteristic.name | String | line_type (Specifies the type of charge or credit associated with this line item.) | N |
| extendedCharacteristic.value | String | Activation Charge | N |
| extendedCharacteristic.name | String | client_rate_schedule_id (Client-defined unique identifier for the rate schedule used to generate this invoice line item.) | N |
| extendedCharacteristic.value | String | PHLSC01_10615583 | N |
| extendedCharacteristic.name | String | client_plan_instance_id (Client-defined unique identifier of the plan instance directly associated with this invoice line item. Note that this parameter may be a master plan instance or a supplemental plan instance.) | N |
| extendedCharacteristic.value | String | 25898444 | N |
| extendedCharacteristic.name | String | Indicates whether the invoice line is related to tax. Invoice lines that are a tax charge or a credit applied to a tax charge will be returned as '1'. All other invoice lines will be returned as '0'. | N |
| extendedCharacteristic.value | String | 0 | N |
| extendedCharacteristic.name | String | units (The number of units of this service code billed on this line item.) | N |
| extendedCharacteristic.value | String | 1 | N |
| extendedCharacteristic.name | String | rate_per_unit (The rate per unit billed) | N |
| extendedCharacteristic.value | String | 45 | N |
| extendedCharacteristic.name | String | rate_schedule_tier_no (Aria-assigned unique identifier for the rate schedule used to generate this invoice line item.) | N |
| extendedCharacteristic.value | String | 1 | N |
Possible Error Scenarios: :
IF WE ARE PASSING INVALID (accountId) NUMBER IN QUERYPARAMS
{
"errors": [
{
"code": 400,
"message": "ARIA:Invoice_Details",
"description": "Aria API get_invoice_details_m failed with error - 1009 | account does not exist"
},
{
"code": 400,
"message": "ARIA:Payments_On_Invoice",
"description": "Aria API get_payments_on_invoice_m failed with error - 1009 | account does not exist"
}
]
}INVALID URL
{
"errors": [
{
"code": 405,
"message": "APIKIT:METHOD_NOT_ALLOWED",
"description": "HTTP Method get not allowed for : /{businessId}"
}
]
}INVALID LOB
{
"errors": [
{
"code": 400,
"message": "ERROR:LOB_VALIDATION",
"description": "Lob must be of type POSTPAID"
}
]
}INVALID CHANNELID
{
"errors": [
{
"code": 501,
"message": "Not implemented",
"description": "Operation GET for Business Id: PR and channelId:ECOM not implemented"
}
]
}