Create an Installment Schedule Specification
post
/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec
Creates an installment schedule specification.
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
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.
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.
Response
201 Response
The installment schedule was created successfully, and the ID of the new installment schedule was returned.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to create an installment schedule specification by submitting a POST request on the REST resource using cURL. For more information about cURL, see "Use cURL".
cURL Command
curl -X POST 'http://hostname:port/bcws/webresources/version/installmentManagement/installmentScheduleSpec' -H 'content-type: application/json' -d @createInstallmentScheduleSpec.json
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.
- createInstallmentScheduleSpec.json is the JSON file that specifies the installment schedule specification to create.
Example of Request Body
This example shows the contents of the createInstallmentScheduleSpec.json file sent as the request body.
{
"name": "New Installment Schedule Spec",
"glid": "109",
"minPercent": "",
"minAmount": "200",
"descr": "",
"maxIntervalDaysNEI": "10",
"maxNumNEI": "20",
"startsAt": "2021-11-21T00:00:00.000Z",
"expiresAt": "2022-11-24T00:00:00.000Z",
"qualifiers": [
{
"dataType": "STR",
"key": "/account.PIN_FLD_ACCOUNT_NO",
"operator": "EQ",
"value": "123456"
},
{
"dataType": "STR",
"key": "/profile.PIN_FLD_NAME",
"operator": "EQ",
"value": "ABC"
}
]
}
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",
"href": http://hostname:port/bcws/webresources/v1.0/installmentManagement/installmentScheduleSpec/0.0.0.1+-config-installment-schedule_spec+3763164
}