Get Installment Schedule Bills

get

/bcws/webresources/v1.0/installmentManagement/installmentSchedule/billDetails

Gets the installment schedule 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 schedule bill information was retrieved successfully.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : installmentScheduleBillDetails
Type: object
Show Source
Nested Schema : billDetails
Type: array
Show Source
Nested Schema : InstallmentScheduleBill
Type: object
Show Source
Nested Schema : Money
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 schedule 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/installmentSchedule/billDetails?accountRef=0.0.0.1+-account+168945&installmentRef=0.0.0.1+-installment_schedule+268552''

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+-installment_schedule+268552",
    "href": null,
    "billDetails": [
        {
            "id": "0.0.0.1+-bill+352811291120987262",
            "createdAt": "2024-11-05T08:00:00.000Z",
            "dueAt": "2024-12-05T08:00:00.000Z",
            "billNo": "B1-362",
            "totalAmount": {
                "amount": 223.54,
                "currency": null
            },
            "dueAmount": {
                "amount": 0,
                "currency": null
            },
            "status": null
        }
    ],
    "billInfoID": "Bill Unit(1)"
}
Back to Top