Get an Installment Schedule Specification by ID
get
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec/{id}
Gets the installment schedule specifications with the specified ID.
Request
Path Parameters
-
id(required): string
The installment specification ID, for example: 0.0.0.1+-config-instalment_schedule_spec+123123
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.
Root Schema : schema
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 an installment schedule specification 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/0.0.0.1+-config-installment-schedule_spec+3763164'
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+3763164",
"name": "Create Installment Schedule Spec",
"href": "http://hostname:port/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec/0.0.0.1+-config-installment-schedule_spec+3763164",
"descr": "",
"createdAt": "2021-11-20T07:33:36.000Z",
"startsAt": "2021-11-21T00:00:00.000Z",
"modifiedAt": "2021-11-20T07:33:36.000Z",
"expiresAt": "2021-11-24T00:00:00.000Z",
"glid": 109,
"minPercent": 0,
"minAmount": 200,
"maxIntervalDaysNEI": 10,
"maxNumNEI": 20,
"qualifiers": [
{
"key": "/account.PIN_FLD_ACCOUNT_NO",
"value": "123456",
"dataType": "STR",
"operator": "EQ"
},
{
"key": "/profile.PIN_FLD_NAME",
"value": "ABC",
"dataType": "STR",
"operator": "EQ"
}
]
}