Get Installment Bills

get

/bcws/webresources/v1.0/installmentManagement/bills

Gets the installment bills that match the specified query criteria.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

The installment bill information was returned successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : installmentBillInfo
Type: object
Show Source
Nested Schema : bills
Type: array
Show Source
Nested Schema : InstallmentBill
Type: object
Show Source
Nested Schema : billItems
Type: array
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : InstallmentBillItem
Type: object
Show Source

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to get installment bills by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/installmentManagement/bills?accountRef=0.0.0.1+-account+145037&billInfoRef=0.0.0.1+-billinfo+145805'

where:

  • hostname is the URL for the Billing Care REST server.
  • port is the port for the Billing Care REST server.
  • version is the version of the API you're using, such as v1.0.

Example of Response Body

This example shows the contents of the response body in JSON format.
{
    "id": "0.0.0.1+-account+145037",
    "customerRef": "0.0.0.1+-account+145037",
    "bills": [
        {
            "id": "0.0.0.1+-bill+349328038284113485",
            "dueAt": null,
            "dueAmount": {
                "amount": 1000,
                "currency": null
            },
            "billNo": "B1-68",
            "billItems": [
                {
                    "id": "0.0.0.1+-item-deposit-charge+349328038284112461",
                    "dueAmount": {
                        "amount": 1000,
                        "currency": null
                    },
                    "createdAt": "2024-05-14T10:06:57.000Z",
                    "billItemNumber": "B1-68,1",
                    "billRef": "0.0.0.1+-bill+349328038284113485",
                    "customerRef": "0.0.0.1+-account+145037"
                }
            ]
        },
        {
            "id": "0.0.0.1+-bill+349328038284108149",
            "dueAt": null,
            "dueAmount": {
                "amount": 1699,
                "currency": null
            },
            "billNo": "B1-70",
            "billItems": [
                {
                    "id": "0.0.0.1+-item-deposit-charge+349328038284110965",
                    "dueAmount": {
                        "amount": 1699,
                        "currency": null
                    },
                    "createdAt": "2024-05-14T10:09:24.000Z",
                    "billItemNumber": "B1-70,1",
                    "billRef": "0.0.0.1+-bill+349328038284108149",
                    "customerRef": "0.0.0.1+-account+145037"
                }
            ]
        }
    ]
}
Back to Top