Create an Advice of Charge Customer Deposit

post

/bcws/webresources/v1.0/depositManagement/customerDeposit/chargeofadvice

Creates a new advice-of-charge customer deposit.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/xml ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : TimePeriod
Type: object
Show Source
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Money
Type: object
Show Source
Nested Schema : TimePeriod
Type: object
Show Source
Back to Top

Response

200 Response

The advice-of-charge customer deposit was created successfully, and its ID was returned.

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to create an advice of charge customer deposit 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/v1.0/depositManagement/customerDeposit/chargeofadvice' -H 'content-type: application/json' -d @createCharge.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.
  • createCharge.json is the JSON file that specifies the deposit to create.

Example of Request Body

This example shows the contents of the createCharge.json file sent as the request body.

{"customerRef":"0.0.0.1+-account+204825","depositSpecRef":"0.0.0.1+-deposit_specification+223906"}

Example of Response Body

This following shows the contents of the response body.
 {
    "id": null,
    "href": null,
    "startsAt": null,
    "effectiveDate": null,
    "customerRef": "0.0.0.1+-account+204825",
    "depositSpecRef": "0.0.0.1+-deposit_specification+223906",
    "serviceRef": null,
    "billProfileRef": null,
    "amount": {
        "amount": 2150.00,
        "currency": null
    },
    "validFor": null
}
Back to Top