REST API Reference for Billing Care

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

accountRef: string

The account ID, for example: 0.0.0.1+-account+2345678
installmentRef: string

The installment schedule ID, for example: 0.0.0.1+-installment_schedule+3456789

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The installment schedule bill information was retrieved successfully.

Root Schema : schema

Type: array

Show Source

Array of: object installmentScheduleBillDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/InstallmentScheduleBillDetails"
    }
}

Nested Schema : installmentScheduleBillDetails

Type: object

Show Source

billDetails(required): array billDetails
billInfoID(required): string

The installment schedule bill information ID.
href(required): string

The unique resource URL, used for getting the object.
id(required): string

The installment schedule bill ID.

{
    "required":[
        "billDetails",
        "billInfoID",
        "href",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment schedule bill ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used for getting the object."
        },
        "billDetails":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InstallmentScheduleBill"
            }
        },
        "billInfoID":{
            "type":"string",
            "description":"The installment schedule bill information ID."
        }
    },
    "xml":{
        "name":"installmentScheduleBillDetails"
    }
}

Nested Schema : billDetails

Type: array

Show Source

Array of: object InstallmentScheduleBill

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/InstallmentScheduleBill"
    }
}

Nested Schema : InstallmentScheduleBill

Type: object

Show Source

billNo(required): string

The installment schedule bill number.
createdAt(required): string

The date and time the installment schedule bill was created.
dueAmount: object Money
dueAt(required): string

The date and time the installment schedule bill is due.
id(required): string

The installment schedule bill ID.
status(required): string

The installment schedule bill status.
totalAmount: object Money

{
    "required":[
        "billNo",
        "createdAt",
        "dueAt",
        "id",
        "status"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment schedule bill ID."
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the installment schedule bill was created."
        },
        "dueAt":{
            "type":"string",
            "description":"The date and time the installment schedule bill is due."
        },
        "billNo":{
            "type":"string",
            "description":"The installment schedule bill number."
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "dueAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "status":{
            "type":"string",
            "description":"The installment schedule bill status."
        }
    }
}

Nested Schema : Money

Type: object

Show Source

amount(required): number

The amount of money.
currency: integer (int32)

The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

500 Response

An error occurred. An exception has been raised.

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