REST API Reference for Billing Care

Create a Deposit Specification

post

/bcws/webresources/v1.0/depositManagement/depositSpec

Creates a deposit specification.

Request

There are no request parameters for this operation.

Supported Media Types

application/xml
application/json

The deposit specification to create. The minimum required parameters are:

name
chargeOfferRef
profileRef

Root Schema : schema

Type: object

Show Source

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).

{
    "required":[
        "category",
        "chargeOfferRef",
        "code",
        "createdAt",
        "descr",
        "expiresAt",
        "glCode",
        "href",
        "id",
        "modifiedAt",
        "name",
        "permitted",
        "profileRef",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit specification ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "startsAt":{
            "type":"string",
            "description":"The date when the deposit specification starts."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit specification is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit specification is modified."
        },
        "expiresAt":{
            "type":"string",
            "description":"The expiry date of the deposit specfication."
        },
        "category":{
            "type":"string",
            "description":"The deposit specification category."
        },
        "permitted":{
            "type":"string",
            "description":"Specify whether the deposit specification is permitted (<b>true</b>) or not (<b>false</b>)."
        },
        "code":{
            "type":"string",
            "description":"The deposit specification code type."
        },
        "name":{
            "type":"string",
            "description":"The deposit specification name."
        },
        "descr":{
            "type":"string",
            "description":"The deposit specification description."
        },
        "status":{
            "type":"integer",
            "description":"The deposit specification status. Allowed Values: <b>0</b> (Active), <b>1</b> (Draft), <b>2</b> (Canceled).",
            "format":"int32"
        },
        "profileRef":{
            "type":"string",
            "description":"The deposit specification profile reference."
        },
        "chargeOfferRef":{
            "type":"string",
            "description":"The charge offer reference for the deposit specification."
        },
        "billPreference":{
            "type":"integer",
            "description":"The bill preference for the deposit specification. Allowed Values: <ul><li><b>0</b> (Immediate)</li><li><b>1</b> (Auto-align)</li></ul>",
            "format":"int32"
        },
        "creditLimitFlag":{
            "type":"boolean",
            "description":"Specify whether to increase the customer credit limit by the deposit amount (true) or not (false).",
            "default":false
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositSpec"
    }
}

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"
        }
    }
}

The deposit specification to create. The minimum required parameters are:

name
chargeOfferRef
profileRef

Root Schema : schema

Type: object

Show Source

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).

{
    "required":[
        "category",
        "chargeOfferRef",
        "code",
        "createdAt",
        "descr",
        "expiresAt",
        "glCode",
        "href",
        "id",
        "modifiedAt",
        "name",
        "permitted",
        "profileRef",
        "startsAt"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The deposit specification ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "startsAt":{
            "type":"string",
            "description":"The date when the deposit specification starts."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit specification is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit specification is modified."
        },
        "expiresAt":{
            "type":"string",
            "description":"The expiry date of the deposit specfication."
        },
        "category":{
            "type":"string",
            "description":"The deposit specification category."
        },
        "permitted":{
            "type":"string",
            "description":"Specify whether the deposit specification is permitted (<b>true</b>) or not (<b>false</b>)."
        },
        "code":{
            "type":"string",
            "description":"The deposit specification code type."
        },
        "name":{
            "type":"string",
            "description":"The deposit specification name."
        },
        "descr":{
            "type":"string",
            "description":"The deposit specification description."
        },
        "status":{
            "type":"integer",
            "description":"The deposit specification status. Allowed Values: <b>0</b> (Active), <b>1</b> (Draft), <b>2</b> (Canceled).",
            "format":"int32"
        },
        "profileRef":{
            "type":"string",
            "description":"The deposit specification profile reference."
        },
        "chargeOfferRef":{
            "type":"string",
            "description":"The charge offer reference for the deposit specification."
        },
        "billPreference":{
            "type":"integer",
            "description":"The bill preference for the deposit specification. Allowed Values: <ul><li><b>0</b> (Immediate)</li><li><b>1</b> (Auto-align)</li></ul>",
            "format":"int32"
        },
        "creditLimitFlag":{
            "type":"boolean",
            "description":"Specify whether to increase the customer credit limit by the deposit amount (true) or not (false).",
            "default":false
        },
        "amount":{
            "$ref":"#/components/schemas/Money"
        },
        "glCode":{
            "type":"string",
            "description":"The general ledger ID."
        }
    },
    "xml":{
        "name":"depositSpec"
    }
}

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"
        }
    }
}

Response

201 Response

The deposit specification was created successfully, and the ID of the new profile was returned.

500 Response

An error occurred. An exception has been raised.

Examples

This example shows how to create a deposit specification 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/version/depositManagement/depositSpec' -H 'content-type: application/json' -d @createDepositSpec.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.
createDepositSpec.json is the JSON file that specifies the deposit specification to create.

Example of Request Body

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

{
    "code": "Deposit Specification Code",
    "name": "Deposit Specification Example",
    "descr": "Deposit Specification Example",
    "billPreference": "IMMEDIATE",
    "profileRef": "0.0.0.1+-config-deposit_spec_profile+2927482",
    "permitted": "/account",
    "status": "ACTIVE",
    "category": "/account",
    "chargeOfferRef": "0.0.0.1+-product+2750007",
    "creditLimitFlag": true,
    "expiresAt": "2022-09-23T23:00:00.000Z"
}

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://host:port/bcws/webresources/version/depositManagement/depositSpec/0.0.0.1+-deposit_specification+2641457"
}