Get Installment Schedule Specifications
get
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec
Gets the installment schedule specifications that match the specified query criteria.
Request
Query Parameters
-
customerRef(required): string
The account ID, for example: 0.0.0.1+-account+1234567
-
expiresAt(required): string
The installment schedule 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 specification name.
-
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 specification information was retrieved successfully.
Nested Schema : installmentScheduleSpec
Type:
Show Source
object
-
createdAt(required): string
The date when the installment schedule specification is created.
-
descr(required): string
The installment schedule specification description.
-
expiresAt(required): string
The date when the installment schedule specification expires.
-
glid: integer
(int32)
The general ledger ID used for recording the installment charge.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The installment schedule specification ID.
-
maxIntervalDaysNEI: integer
(int32)
The maximum number of days between non-equal installments.
-
maxNumNEI: integer
(int32)
The maximum number of non-equal installments.
-
minAmount(required): number
The minimum bill/charge amount to be considered for the installment conversion. Either the minimum percentage or the minimum amount must be included.
-
minPercent(required): number
The minimum bill/charge percentage to be considered for the installment conversion. Either the minimum percentage or the minimum amount must be included.
-
modifiedAt(required): string
The date when the installment schedule specification is modified.
-
name(required): string
The installment schedule specification name.
-
qualifiers(required): array
qualifiers
-
startsAt(required): string
The date when the installment schedule specification starts.
Nested Schema : Qualifier
Type:
Show Source
object
-
dataType: integer
(int32)
The data type of the value. Allowed values:
- 1 (Integer)
- 3 (Enumerated)
- 5 (String)
- 7 (POID)
- 8 (Timestamp)
- 14 (Decimal)
-
key(required): string
The name or the identifier from a storable class.
-
operator: integer
(int32)
The operator for the qualifier. Allowed values:
- 0 (Equals)
- 1 (Less than)
- 2 (Greater than)
- 3 (Less than or equals)
- 4 (Greater than or equals)
- 5 (Not equal)
- 6 (Contained in string)
- 7 (Like)
-
value(required): string
The reference value to be evaluated.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to get installment schedule specifications by name and expiry date 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?name=NewInstallmentScheduleSpecification&expiresAt=1627410600000'
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+-config-installment-schedule_spec+119351",
"name":"NewInstallmentScheduleSpecification1",
"href":"http://hostname:port/bcws/webresources/version/installmentManagement/installmentScheduleSpec/0.0.0.1+-config-installment-schedule_spec+119351",
"createdAt":1629421265000,
"startsAt":1627042891000,
"modifiedAt":1629421265000,
"expiresAt":1658578891000,
"glid":4,
"minPercent":0,
"minAmount":10,
"maxIntervalDaysNEI":30,
"maxNumNEI":5,
"qualifiers":[
{
"key":"/account.PIN_FLD_ACCOUNT_NO",
"value":"123",
"dataType":"STR",
"operator":"EQ"
}
]
},
{
"id":"0.0.0.1+-config-installment-schedule_spec+122559",
"name":"NewInstallmentScheduleSpecification2",
"href":"http://hostname:port/bcws/webresources/version/installmentManagement/installmentScheduleSpec/0.0.0.1+-config-installment-schedule_spec+122559",
"createdAt":1627358295000,
"startsAt":1627378104000,
"modifiedAt":1627358304000,
"expiresAt":1906624711000,
"glid":4,
"minPercent":0,
"minAmount":15,
"maxIntervalDaysNEI":30,
"maxNumNEI":5,
"qualifiers":[
{
"key":"/account.PIN_FLD_ACCOUNT_NO",
"value":"123",
"dataType":"STR",
"operator":"EQ"
}
]
}
]