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
- application/xml
- 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:
Show Source
object
-
amount: object
Money
-
billProfileRef(required): string
The bill profile reference.
-
customerRef(required): string
The customer reference.
-
depositSpecRef(required): string
The deposit specification reference.
-
effectiveDate(required): string
The effective date for the advice-of-charge deposit.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The ID of the deposit.
-
serviceRef(required): string
The service reference.
-
startsAt(required): string
The date when the advice-of-charge starts.
-
validFor: object
TimePeriod
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
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:
Show Source
object
-
amount: object
Money
-
billProfileRef(required): string
The bill profile reference.
-
customerRef(required): string
The customer reference.
-
depositSpecRef(required): string
The deposit specification reference.
-
effectiveDate(required): string
The effective date for the advice-of-charge deposit.
-
href(required): string
The unique resource URL, used to get the object.
-
id(required): string
The ID of the deposit.
-
serviceRef(required): string
The service reference.
-
startsAt(required): string
The date when the advice-of-charge starts.
-
validFor: object
TimePeriod
Nested Schema : Money
Type:
Show Source
object
-
amount(required): number
The amount of money.
-
currency: integer
(int32)
The currency for the money.
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.