Get a Deposit Specification by ID
get
/bcws/webresources/v1.0/depositManagement/depositSpec/{id}
Gets the deposit specification details with the specified ID.
Request
Path Parameters
-
id(required): string
The deposit specification ID, for example: 0.0.0.1+-deposit_specification+1234567
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
The deposit specification details were returned successfully.
Root Schema : depositSpec
Type:
Show Source
object
-
amount: object
Money
-
billPreference: integer
(int32)
The bill preference for the deposit specification. Allowed Values:
- 0 (Immediate)
- 1 (Auto-align)
-
category(required): string
The deposit specification category.
-
chargeOfferRef(required): string
The charge offer reference for the deposit specification.
-
code(required): string
The deposit specification code type.
-
createdAt(required): string
The date when the deposit specification is created.
-
creditLimitFlag: boolean
Default Value:
false
Specify whether to increase the customer credit limit by the deposit amount (true) or not (false). -
descr(required): string
The deposit specification description.
-
expiresAt(required): string
The expiry date of the deposit specfication.
-
glCode(required): string
The general ledger ID.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The deposit specification ID.
-
modifiedAt(required): string
The date when the deposit specification is modified.
-
name(required): string
The deposit specification name.
-
permitted(required): string
Specify whether the deposit specification is permitted (true) or not (false).
-
profileRef(required): string
The deposit specification profile reference.
-
startsAt(required): string
The date when the deposit specification starts.
-
status: integer
(int32)
The deposit specification status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).
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 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/depositSpec/0.0.0.1+-deposit_specification+2641457'
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+-deposit_specification+2641457",
"href": "http://hostname:port/bcws/webresources/version/depositManagement/depositSpec/0.0.0.1+-deposit_specification+2641457",
"createdAt": "2021-11-06T12:39:57.000Z",
"modifiedAt": "2021-11-06T12:39:57.000Z",
"expiresAt": "2022-09-24T18:29:59.000Z",
"category": "/account",
"permitted": "/account",
"code": "Deposit Specification Code",
"name": "Deposit Specification Example",
"descr": "Deposit Specification Example",
"status": "ACTIVE",
"profileRef": "0.0.0.1+-config-deposit_spec_profile+2927482",
"chargeOfferRef": "0.0.0.1+-product+2750007",
"billPreference": "IMMEDIATE",
"creditLimitFlag": true
}