REST API Reference for Billing Care

Get Installment Bills

get

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

Gets the installment bills that match the specified query criteria.

Request

Query Parameters

accountRef: string

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

The bill ID, for example: 0.0.0.1+-billinfo+3456789

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

The installment bill information was returned successfully.

Root Schema : schema

Type: array

Show Source

Array of: object installmentBillInfo

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

Nested Schema : installmentBillInfo

Type: object

Show Source

bills(required): array bills
customerRef(required): string

The customer reference.
id(required): string

The installment bill ID.

{
    "required":[
        "bills",
        "customerRef",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment bill ID."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "bills":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InstallmentBill"
            }
        }
    },
    "xml":{
        "name":"installmentBillInfo"
    }
}

Nested Schema : bills

Type: array

Show Source

Array of: object InstallmentBill

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

Nested Schema : InstallmentBill

Type: object

Show Source

billItems(required): array billItems
billNo(required): string

The installment bill number.
dueAmount: object Money
dueAt(required): string

When the installment bill is due.
id(required): string

The installment bill ID.

{
    "required":[
        "billItems",
        "billNo",
        "dueAt",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment bill ID."
        },
        "dueAt":{
            "type":"string",
            "description":"When the installment bill is due."
        },
        "dueAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "billNo":{
            "type":"string",
            "description":"The installment bill number."
        },
        "billItems":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/InstallmentBillItem"
            }
        }
    }
}

Nested Schema : billItems

Type: array

Show Source

Array of: object InstallmentBillItem

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

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

Nested Schema : InstallmentBillItem

Type: object

Show Source

billItemNumber(required): string

The installment bill item number.
billRef(required): string

The bill reference.
createdAt(required): string

The date and time the installment bill item was created.
customerRef(required): string

The customer reference.
dueAmount: object Money
id(required): string

The installment bill item ID.

{
    "required":[
        "billItemNumber",
        "billRef",
        "createdAt",
        "customerRef",
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The installment bill item ID."
        },
        "dueAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "createdAt":{
            "type":"string",
            "description":"The date and time the installment bill item was created."
        },
        "billItemNumber":{
            "type":"string",
            "description":"The installment bill item number."
        },
        "billRef":{
            "type":"string",
            "description":"The bill reference."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        }
    }
}

500 Response

An error occurred. An exception has been raised.

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