Customer Bill Management Biz API

GET

This operation Fetch CustomerBill Summary, PDF or TXT for given billReference.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/tmf-api/customerBillManagement/v1/{businessId}/customerBill/{id}

note : the API version is not according with TMF version. The right should be v4

URL PARAMS

Header

Query Param

note : B2B Project is still using accountId and pdf parameters. This is a technical debt.

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

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.

[ 200 ]

OK - retrieveCustomerBill request processed successfully, response body contains an entity corresponding to the requested resource.

PDF = false and TXT = false

{
    "id": "2018031",
    "billNo": "2018031",
    "billDate": "2018-05-02T09:00:23",
    "paymentDueDate": "2018-05-30T12:00:00",
    "amountDue": {
        "unit": "PAB",
        "value": 3161.46
    },
    "appliedPayment": [
        {
            "appliedAmount": {
                "unit": "PAB",
                "value": 3161.46
            }
        }
    ],
    "billingAccount": {
        "id": "801941080000",
        "@referredType": "billingAccount"
    },
    "remainingAmount": {
        "unit": "PAB",
        "value": 0.00
    },
    "taxIncludedAmount": {
        "unit": "PAB",
        "value": 3161.46
    },
    "@baseType": "bill",
    "@type": "customerBill"
}

PDF = true and TXT = false

{
    "id": "2019111",
    "billingAccount": {
        "id": "271041000000",
        "@referredType": "billingAccount"
    },
    "billDocument": [{
            "id": "2019111",
            "name": "Bill.271041000000.2019111.pdf",
            "attachmentType": "document",
            "mimeType": "application/pdf",
            "size": 100,
            "sizeUnit": "bytes",
            "@type": "billDocument",
            "content": " "
        }
    ]
}

X-PDF/PDF = true and billDocument.attachmentType="application/pdf"

{
    "billDocument": [
        {
            "id": "205495579",
            "name": "\\EVT-CUPCEZAP-01\\eStatements\\PDF\\000010000821199001002189720220325.pdf",
            "mimeType": "application/pdf",
            "size": {
                "amount": 254760,
                "unit": "bytes"
            },
            "@type": "billDocument",
            "content": "JVBERi0xLjQKJeLjz9MNCjYgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU3VidHlwZS9JbWFnZQovV2lkdGggNTU3Ci9IZWlnaHQgMTI5Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0NvbG9y...."
        }
    ],
    "billDate": "2022-07-01T00:00:00.000Z",
    "billingAccount": {
        "id": "8211990010042349",
        "@referredType": "billingAccount"
    }
}

TXT = true and PDF = false

{
   "id":"2018031",
   "billingAccount":{
      "id":"801941080000",
      "@referredType":"billingAccount"
   },
   "billDate":"02-May-2018 21:00:23",
   "billDocument":[
      {
         "name":"APPLICATION_BILL_LIB_DOBC_SEG1:BILL_2018_03_C_1_ELEC.TLB",
         "mimeType":"application/txt",
         "size":{
            "amount": 63055,
            "units":"bytes"
         },
         "content":"TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGludWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
      }
   ]
}

PDF = false

{
    "id": "77937H00004338P0",
    "href": "https://esb-dev.lla.com/customerBillManagement/customerBill/77937H00004338P0",
    "billNo": "77937H00004338P0",
    "runType": "onCycle",
    "category": "normal",
    "state": "due",
    "billDate": "2022-03-03T00:00:00.000Z",
    "nextBillDate": "2022-04-03T00:00:00.000Z",
    "billingPeriod": {
        "endDateTime": "2022-04-03T00:00:00.000Z",
        "startDateTime": "2022-03-04T00:00:00.000Z"
    },
    "amountDue": {
        "value": 385.43,
        "unit": "USD"
    },
    "remainingAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "taxExcludedAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "taxIncludedAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "@baseType": "bill",
    "@type": "customerBill",
    "@schemaLocation": "www.bill.customerBill.json",
    "appliedPayment": [
        {
            "appliedAmount": {
                "value": 385.43,
                "unit": "USD"
            },
            "payment": {
                "id": "77937H00004338P0",
                "paymentDate": "2022-03-03T00:00:00.000Z",
                "@referredType": "payment"
            }
        }
    ],
    "billingAccount": {
        "id": "8211990010021897",
        "href": "https://esb-dev.lla.com/accountManagement/billingAccount/8211990010021897",
        "name": "TEST QA WALTER",
        "@referredType": "billingAccount"
    },
    "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": "TEST QA WALTER",
            "@referredType": "individualParty"
        },
        {
            "href": "https://esb-dev.lla.com/partyManagement/individual/710",
            "role": "payer",
            "id": "710",
            "name": "TEST QA WALTER",
            "@referredType": "individualParty"
        }
    ],
    "financialAccount": {
        "id": "15",
        "href": "https://esb-dev.lla.com/accountManagement/financialAccount/15",
        "name": "TEST QA WALTER",
        "@referredType": "financialAccount"
    }
}

PDF = true and runType = <>

{
    "id": "2018031",
    "billDocument": [
        {
            "id": "12345",
            "mimeType": "application/pdf",
            "attachmentType": "pdf",
            "size": {
                "amount": 63055,
                "units": "bytes"
            },
            "content": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBhc3Npb24gZnJvbSBvdGhlciBhbmltYWxzLCB3aGljaCBpcyBhIGx1c3Qgb2YgdGhlIG1pbmQsIHRoYXQgYnkgYSBwZXJzZXZlcmFuY2Ugb2YgZGVsaWdodCBpbiB0aGUgY29udGludWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4=",
            "@type": "billDocument"
        }
    ]
}

X-PDF/PDF = true

{
    "id": "77937H00004338P0",
    "href": "https://esb-dev.lla.com/customerBillManagement/customerBill/77937H00004338P0",
    "billNo": "77937H00004338P0",
    "runType": "onCycle",
    "category": "normal",
    "state": "due",
    "billDate": "2022-03-03T00:00:00.000Z",
    "nextBillDate": "2022-04-03T00:00:00.000Z",
    "billingPeriod": {
        "endDateTime": "2022-04-03T00:00:00.000Z",
        "startDateTime": "2022-03-04T00:00:00.000Z"
    },
    "amountDue": {
        "value": 385.43,
        "unit": "USD"
    },
    "remainingAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "taxExcludedAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "taxIncludedAmount": {
        "value": 385.43,
        "unit": "USD"
    },
    "@baseType": "bill",
    "@type": "customerBill",
    "@schemaLocation": "www.bill.customerBill.json",
    "billDocument": [{
        "id": "8211990010021897",
        "name": "\\\\EVT-CUPCEZAP-01\\eStatements\\PDF\\000010000821199001002189720220325.pdf",
        "mimeType": "application/pdf",
         "size": {
             "amount": 254760,
             "unit": "bytes"
        },
        "@type": "billDocument",
        "content": "JVBERi0xLjQKJeLjz9MNCjYgMCBvYmoKPDwKL1R5cGUvWE9iamVjdAovU3VidHlwZS9JbWFnZQovV2lkdGggNTU3Ci9IZWlnaHQgMTI5Ci9CaXRzUGVyQ29tcG9uZW50IDgKL0NvbG9y...."
    }],
    "appliedPayment": [
        {
            "appliedAmount": {
                "value": 385.43,
                "unit": "USD"
            },
            "payment": {
                "id": "77937H00004338P0",
                "paymentDate": "2022-03-03T00:00:00.000Z",
                "@referredType": "payment"
            }
        }
    ],
    "billingAccount": {
        "id": "8211990010021897",
        "href": "https://esb-dev.lla.com/accountManagement/billingAccount/8211990010021897",
        "name": "TEST QA WALTER",
        "@referredType": "billingAccount"
    },
    "paymentMethod": {
        "href": " https://host:port/accountManagement/paymentMethod/41",
        "id": "41",
        "name": "Adam Smith Credit Card",
        "@referredType": "creditCard"
    },
    "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": "TEST QA WALTER",
            "@referredType": "individualParty"
        },
        {
            "href": "https://esb-dev.lla.com/partyManagement/individual/710",
            "role": "payer",
            "id": "710",
            "name": "TEST QA WALTER",
            "@referredType": "individualParty"
        }
    ],
    "financialAccount": {
        "id": "15",
        "href": "https://esb-dev.lla.com/accountManagement/financialAccount/15",
        "name": "TEST QA WALTER",
        "@referredType": "financialAccount"
    }
}

Definitions

Each of the request parameters is detailed.

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - the request could not be understood by the server due to malformed syntax. The client SHOULD NOT repeat the request without modifications. When there is not a valid businessId, correlationId, lob or any data input payload present

{
    "errors": [
        {
            "code": 400,
            "message": "\"Required header 'client-secret' not specified\"",
            "description": "APIKIT:BAD_REQUEST"
        }
    ]
}

{
    "errors": [
        {
            "code": 400,
            "message": "\"Invalid value '' for query parameter XXXX. expected type: Number, found: String\"",
            "description": "APIKIT:BAD_REQUEST"
        }
    ]
}

[ 401 ]

Unauthorized - The request has not been applied because it lacks valid authentication credentials for the target resource.
json { "errors" : [{ "code" : 401, "message" : "The user could not be authenticated for this request.", "description" : "The request has not been applied because it lacks valid authentication credentials for the target resource" } ] }

[ 403 ]

Forbidden - Indicates that the server understood the request but refuses to fulfill it. If authentication credentials were provided in the request, the server considers them insufficient to grant access. The client SHOULD NOT automatically repeat the request with the same credentials. The client MAY repeat the request with new or different credentials.

[ 404 ]

Not Found - server has not found a resource with that URI. This may be temporary and permanent condition. This status code is commonly used when the server does not wish to reveal exactly why the request has been refused, or when no other response is applicable.
```json
{
"errors" : [{

  "code" : 404,
   "message" : "Liberate : Customer bill Details not found for account no: XXXXXX , Bill Reference: XXXXX",
   "description" : "SOAP-ENV:Server-BILLFILNTFND"
}

]
}
json
{
"errors" : [{

  "code" : 404,
   "message" : "Liberate : Customer bill Details not found for account no: XXXXXX , Bill Reference: XXXXX",
   "description" : "SOAP-ENV:Server-INVBILLREF"
}

]
}
json
{
"errors" : [{

  "code" : 404,
   "message" : "Invalid AccountId is not found xxxxx"  ,
  "description" : "Route to BSS System API not found"

}

]
}
```

{
  "errors" : [{

      "code" : 404,
       "message" : "Liberate : No Bills found for the requested time period, account no: xxx" ,
      "description" : "NOBILLSFOUND-Bills not found"
    }
  ]
}

{
  "errors" : [{
       "code" : 404,
       "message" : "No Bills found for the requested time period, account no: xxxx",
      "description" : "NOBILLSFOUND"
    }
  ]
}

{
  "errors" : [{

      "code" : 404,
       "message" : "Customer bill history not found for bill reference Id: xxxxx" ,
      "description" : "-"
    }
  ]
}

[ 405 ]

Method Not Allowed - HTTP method not allowed for this resource. The method specified in the Request-Line is not allowed for the resource identified by the Request-URI.
http Allowed Method: GET

[ 429 ]

Too Many Requests - client has sent too many requests in a space of time (rate limiting). When a server is under attack or just receiving a very large number of requests from a single party, responding to each with a 429 status code will consume resources. Therefore, servers may drop connections or take other steps instead of responding with the 429 status code, when limiting resource usage.
```json
{
"errors" : [{

  "code" : 429,
   "message" : "The request is invalid or not properly formed.",
  "description" : "The requested operation failed because a resource associated with the request could not be found."
}

]
}

#### [ 500 ]

Internal Server Error - server encountered an error processing request. This should not happen normally, but it is a generic error message, given when no more specific message is suitable.
```json
{
  "errors" : [{
      "code" : 500,
      "message" : "The request failed due to an internal error.",
      "description": "xxxxx"
    }
  ]
}

[ 501 ]

Not implemented - indicates that the server does not support the functionality required to fulfill the request. This is the appropriate response when the server does not recognize the request method and is not capable of supporting it for any resource.

{
  "errors" : [{
      "code" : 501,
      "message" : "Not implemented",
      "description" : "Operation GET /customerBill/xxxxxx for Business Id: xxxx not implemented"
    }
  ]
  }

[ 502]

Bad Gateway - gateway is available but backend service is not. The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request.

[ 503 ]

Service Unavailable - temporary maintenance of service, try again later. The implication is that this is a temporary condition which will be alleviated after some delay. If known, the length of the delay will be indicated in a Retry-After header. If no Retry-After is given, the client SHOULD handle the response as it would for a 500 response. Note: The existence of the 503 status code does not imply that a server will use it when becoming overloaded. Servers may simply refuse the connection.

    Retry-After: 120

Administration and data management

In this section you define all the transformations, temporary and final repositories of the data within the method flow.

Transformation Request

In this section the matrix of all the data transformations that is carried out within the service is defined.

1. liberate-bill-management-sys

2. cerillion-bill-management-sys

3. csg-bill-management-sys

4. evertec-sys

5.unicorn-customer-bill-management-sys

6. comverse1-bill-management-sys

Transformation Response

In this section the matrix of all the data transformations that is carried out within the service is defined.

1. liberate-bill-management-sys

2. cerillion-bill-management-sys

3. csg-bill-management-sys

4. evertec-sys

5.unicorn-customer-bill-management-sys

6. comverse1-bill-management-sys

Services dependencies

This section defines all the connections to the web services and the methods that are used within the method.

liberate-bill-management-sys

cerillion-bill-management-sys

csg-bill-management-sys

evertec-sys

aria-customer-bill-management-sys

unicorn-customer-bill-management-sys

comverse1-bill-management-sys