Jump to

• Request
• Response

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

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "required":[
        "billProfileRef",
        "customerRef",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "serviceRef",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the deposit."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "startsAt":{
            "type":"string",
            "description":"The date when the advice-of-charge starts."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The effective date for the advice-of-charge deposit."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    },
    "xml":{
        "name":"depositAOC"
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

Nested Schema : TimePeriod

Type: object

Show Source

• endDateTime(required): string
• startDateTime(required): string

{
    "required":[
        "endDateTime",
        "startDateTime"
    ],
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "required":[
        "billProfileRef",
        "customerRef",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "serviceRef",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The ID of the deposit."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "startsAt":{
            "type":"string",
            "description":"The date when the advice-of-charge starts."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The effective date for the advice-of-charge deposit."
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    },
    "xml":{
        "name":"depositAOC"
    }
}

Nested Schema : Money

Type: object

Show Source

• amount(required): number
  The amount of money.
• currency: integer (int32)
  The currency for the money.

{
    "required":[
        "amount"
    ],
    "type":"object",
    "properties":{
        "amount":{
            "type":"number",
            "description":"The amount of money."
        },
        "currency":{
            "type":"integer",
            "description":"The currency for the money.",
            "format":"int32"
        }
    }
}

Nested Schema : TimePeriod

Type: object

Show Source

• endDateTime(required): string
• startDateTime(required): string

{
    "required":[
        "endDateTime",
        "startDateTime"
    ],
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string"
        },
        "endDateTime":{
            "type":"string"
        }
    }
}

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