dxp-ux

GET /customerBill/{id}

The customerBill API provides below features

1. To retrieve CustomerBill Summary for particular bill and retrieve PDF for CSG, ARIA, Evertec.
2. To retrieve CustomerBill PDF for Liberty Caribbean markets (JM).

URL

http://[localhost]:[port]/dxp-ux/v1/{businessId}/customerBill/{id}

URL PARAMS

Header

Query Param

Data Model Response

Extended Characteristics data model for PR:

appliedPayment.extendedCharacteristic for PR:

Key Considerations

• Please refer the examples from the following URL - DXP-UX CustomerBillByID-v1

PR Implementation(CSG):

1. To fetch CustomerBill Summary from PR Csg customers need to pass lob as "Fixed"
2. To fetch CustomerBill Summary from PR Customers in aria need to pass lob as "POSTPAID".

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

LC Implementation:

1. This is implemented to retrieve customerBill data and pdf content from Liberate and Cerillion systems.
2. This is implemented for Jamaica market (JM).
3. billDocument[].content will be retrieved in base64 format from the backend systems (This content should be converted to generate customerBill PDF).
4. "billNo" refers to the bill reference number.

5. Following are the mandatory fields in the request

   • id (uriParam) - bill reference number should be sent
   • pdf (queryParam) - should be sent as true

Possible Error Scenarios for PR:

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"
        }
    ]
}