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 ()
The deposit advice-of-charge schema to create. The minimum required parameters are:
  • id
  • href
  • startsAt
  • effectiveDate
  • customerRef
  • depositSpecRef
  • serviceRef
  • billProfileRef
  • amount
  • validFor
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 ()
The deposit advice-of-charge schema to create. The minimum required parameters are:
  • id
  • href
  • startsAt
  • effectiveDate
  • customerRef
  • depositSpecRef
  • serviceRef
  • billProfileRef
  • amount
  • validFor
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

201 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