Get Installment Bills
get
/bcws/webresources/v1.0/installmentManagement/bills
Gets the installment bills that match the specified query criteria.
Request
Query Parameters
-
accountRef(required): string
The customer ID, for example: 0.0.0.1+-account+2345678
-
billInfoRef(required): string
The bill ID, for example: 0.0.0.1+-billinfo+3456789
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The installment bill information was returned successfully.
Nested Schema : installmentBillInfo
Type:
Show Source
object
-
bills(required): array
bills
-
customerRef(required): string
The customer reference.
-
id(required): string
The installment bill ID.
Nested Schema : InstallmentBill
Type:
Show Source
object
-
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.
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
Nested Schema : InstallmentBillItem
Type:
Show Source
object
-
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.
500 Response
An error occurred. An exception has been raised.