Get a Deposit Specification Profile by ID
get
/bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}
Gets the deposit specification profile with the specified ID.
Request
Path Parameters
-
id(required): string
The deposit specification profile ID, for example: 0.0.0.1+-config-deposit_spec_profile+1234567
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The deposit specification profile information was returned successfully.
Root Schema : schema
Type:
Show Source
object
-
code(required): string
The deposit specification profile code.
-
createdAt(required): string
The date when the deposit specification profile is created.
-
descr(required): string
The deposit specification profile description.
-
expiresAt(required): string
The expiry date of the deposit specification profile.
-
hostName(required): string
Not used.
-
href(required): string
The unique resource URL, used to get the deposit specification profile object.
-
id(required): string
The deposit specification profile ID.
-
interestRule: object
DepositInterestRule
-
isExemptible: boolean
Default Value:
false
Specify whether the deposit specification profile is exemptible (true) or not (false). -
isOverridable: boolean
Default Value:
false
Specify whether the deposit specification profile is overridable (true) or not (false). -
isPayinterest: boolean
Default Value:
false
Specify whether the interest must be paid for the deposit specification profile (true) or not (false). -
isRefundable(required): string
Not used.
-
isTransferrable: boolean
Default Value:
false
Specify whether the deposit specification profile is transferrable (true) or not (false). -
modifiedAt(required): string
The date when the deposit specification profile is modified.
-
name(required): string
The deposit specification profile name.
-
refundRule: object
DepositRefundRule
-
releaseType: integer
(int32)
The release type for the deposit specification profile. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
-
startDateTime(required): string
The start date of the deposit specification profile.
-
status(required): string
The deposit specification profile status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).
-
validityRule: object
DepositValidityRule
-
validityRuleSource(required): string
The deposit validity rule source.
Allowed Values: SYSTEM_DEFINED, RULE_DEFINED
Nested Schema : DepositInterestRule
Type:
Show Source
object
-
glCode: integer
(int32)
The general ledger ID.
-
interestFrequencyUnit: integer
(int32)
The unit of measure for the interest frequency.
Allowed Values:- 0 (Month)
- 1 (Day)
- 2 (Week)
- 3 (Year)
Default value: 0 -
interestFrequencyValue: integer
(int32)
The interest frequency.
-
interestRate(required): number
The deposit interest rate.
-
interestType: integer
(int32)
The deposit interest type.
- 0 (Simple)
- 1 (Compound)
- 2 (Absolute)
- 3 (Invalid zero error)
-
startInterestFrom: integer
(int32)
The date when interest starts on the deposit. Allowed Values:
- 0 (Partial payment)
- 1 (Full payment)
Nested Schema : DepositRefundRule
Type:
Show Source
object
-
glCode: integer
(int32)
The general ledger ID.
-
handlingFee: object
Money
-
handlingFeeType: integer
(int32)
The handling fee type.
Allowed Values: PERCENTAGE, ABSOLUTE -
hasWorkFlow: boolean
Default Value:
true
Specify whether the deposit refund has a workflow (true) or not (false). -
id: integer
(int32)
The ID of the deposit refund rule.
-
minRefundAmount: object
Money
-
offsetPeriodUnit(required): string
The unit of measure for the offer period.
Allowed Values: DAY, WEEK, MONTH, YEAR -
offsetPeriodValue: integer
(int32)
The offer period value.
Nested Schema : DepositValidityRule
Type:
Show Source
object
-
endOffsetPeriodUnit: integer
(int32)
The unit of measure for the end offset.
Allowed Values:- 0 (Month)
- 1 (Day)
- 2 (Week)
- 3 (Year)
-
endOffsetPeriodValue: integer
(int32)
The value for the end offset.
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
500 Response
An error occurred. An exception has been raised.
Examples
This example shows how to get a deposit specification profile 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/depositManagement/depositSpecProfile/0.0.0.1+-config-deposit_spec_profile+2644112'
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-deposit_spec_profile+2644112",
"href": "http://hostname:port/bcws/webresources/version/depositManagement/depositspecprofile/0.0.0.1+-config-deposit_spec_profile+2644112",
"createdAt": "2021-11-06T12:23:29.000Z",
"modifiedAt": "2021-11-06T12:23:29.000Z",
"expiresAt": "2022-10-30T18:29:59.000Z",
"startDateTime": "2021-11-06T12:23:29.000Z",
"name": "Deposit Spec Profile",
"hostName": "-",
"descr": " Deposit Spec Profile Descr",
"code": "1234",
"releaseType": "REFUND",
"isPayinterest": true,
"isExemptible": true,
"isOverridable": true,
"isTransferrable": true,
"refundRule": {
"glCode": 104,
"handlingFee": {
"amount": 6
},
"handlingFeeType": "PERCENTAGE",
"hasWorkFlow": true
},
"interestRule": {
"glCode": 102,
"interestFrequencyUnit": "DAYS",
"interestFrequencyValue": 23,
"interestRate": 20.66,
"interestType": "COMPOUND",
"startInterestFrom": "PARTIAL_PAYMENT"
},
"validityRule": {
"endOffsetPeriodUnit": "WEEKS",
"endOffsetPeriodValue": 6
}
}
]