Get Installment Schedules
get
/bcws/webresources/v1.0/installmentManagement/installmentSchedule
Gets the installment schedules that match the specified query criteria.
Request
Query Parameters
-
billProfileRef(required): string
The billing profile ID, for example: 0.0.0.1+-billInfo+123123
-
customerRef(required): string
The customer ID, for example: 0.0.0.1+-account+123123
-
expiresAt(required): string
The deposit specification expiry date, for example: 2038-09-18T18:30:00.000Z
-
limit(required): string
The maximum number of records to be displayed on a page.
-
name(required): string
The installment schedule name.
-
scheduleSpecRef(required): string
The schedule specification ID, for example: 0.0.0.1+-config-installment-schedule_spec+123456
-
serviceRef(required): string
The service ID, for example: 0.0.0.1+-service+123123
-
skip(required): integer(int32)
The number of records to skip before returning results.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The installment schedule information was returned successfully.
Nested Schema : installmentSchedule
Type:
Show Source
object
-
billPreference: integer
(int32)
Indicates either to bill the installment amount immediately or to keep it open and include it with the customer's billing cycle. Allowed Values:
- 0 (Auto-align)
- 1 (Immediate)
-
billProfileRef(required): string
The customer bill unit reference.
-
bills(required): array
bills
-
channel(required): string
The source of the request, for example the name of the store or app. For future use.
-
chargeOfferRef(required): string
The charge offer reference. For future use.
-
code(required): string
Placeholder for the external code.
-
createdAt(required): string
The date of creation.
-
customerRef(required): string
The customer account reference.
-
descr(required): string
The installment schedule description.
-
expiresAt(required): string
The expiration date.
-
glid(required): string
The general ledger ID for the installment charge.
-
href(required): string
The unique resource URL, used for getting the object.
-
id(required): string
The installment schedule's ID.
-
installmentAmount: object
Money
-
installmentPeriod(required): string
The installment cycle. For future use. Allowed Values: ANNUAL, SEMI-ANNUAL, QUARTERLY, MONTHLY, WEEKLY, DAILY. Default Value: MONTHLY
-
installments(required): array
installments
-
installmentType(required): string
The installment type. Allowed Values: EQUAL INSTALLMENT, NON-EQUAL INSTALLMENT
-
lastInstallmentAt(required): string
The last installment date. For future use.
-
modifiedAt(required): string
The last updated date.
-
name(required): string
The installment schedule name.
-
nextInstallmentAt(required): string
The next installment date. For future use.
-
scheduleSpecRef(required): string
The installment schedule specification reference.
-
serviceRef(required): string
The service reference.
-
startsAt(required): string
The start date.
-
status: integer
(int32)
The installment schedule status. Allowed Values:
- 100 (Open)
- 101 (Charged)
- 102 (Paid)
- 103 (Broken)
- 104 (Canceled)
- 105 (Finished)
-
totalAmount: object
Money
-
totalDue: object
Money
-
totalInstallments: integer
(int32)
The total number of installments.
-
validFor: object
TimePeriod
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
Nested Schema : InstallmentScheduleBills
Type:
Show Source
object
-
billId(required): string
The installment schedule bill ID.
Nested Schema : Installment
Type:
Show Source
object
-
amount: object
Money
-
createdAt(required): string
TThe date of creation.
-
customerRef(required): string
The customer reference.
-
descr(required): string
The installment description.
-
dueDate(required): string
The date of installment collection/charge.
-
href(required): string
The unique resource URL, used for getting the object.
-
id(required): string
The installment's ID.
-
scheduleRef(required): string
The reference to the installment schedule.
-
status: integer
(int32)
The installment status. Allowed Values:
- 100 (Open)
- 101 (Charged)
- 102 (Paid)
- 103 (Broken)
- 104 (Canceled)
- 105 (Finished)
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to get installment schedules by customer account number 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/installmentScheduleSpec?customerRef=0.0.0.1+-account+101244'
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+119528",
"href":"http://hostname:port/bcws/webresources/version/installmentManagement/installmentScheduleSpec/0.0.0.1+-installment_schedule+119528",
"code":"test",
"billProfileRef":"0.0.0.1+-billinfo+98556",
"validFor":{
"startDateTime":"2021-06-24T00:00:00.000Z",
"endDateTime":"2021-07-19T00:00:00.000Z"
},
"status":"OPEN",
"billPreference":"AUTOALIGN",
"installmentPeriod":"MONTHLY",
"totalAmount":{
"amount":1000
},
"totalInstallments":2,
"customerRef":"0.0.0.1+-account+101244",
"bills":[
{
"billId":"0.0.0.1+-item-cycle_forward+119144"
}
],
"scheduleSpecRef":"0.0.0.1+-config-installment-schedule_spec+110021",
"installments":[
{
"status":"CHARGED",
"dueDate":"2021-06-24T00:00:00.000Z",
"amount":{
"amount":500
}
},
{
"status":"CHARGED",
"dueDate":"2021-07-19T00:00:00.000Z",
"amount":{
"amount":500
}
}
]
}
]