Jump to

• Request
• Response
• Examples

Get Customer Deposits

get

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

Gets the customer deposits that match the query criteria.

Request

Query Parameters

• billProfileRef: string
  The billing profile ID, for example: 0.0.0.1+-billInfo+123123
• customerRef: string
  The customer ID, for example: 0.0.0.1+-account+123123
• limit: string
  The maximum number of records to be displayed on a page.
• serviceRef: string
  The service ID, for example: 0.0.0.1+-service+123123

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

201 Response

The customer deposit details were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object CustomerDeposit

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerDeposit"
    }
}

Nested Schema : CustomerDeposit

Type: object

Show Source

• balanceAmount: object Money
• billProfileRef(required): string
  The bill profile reference.
• code(required): string
  The external identifier.
• createdAt(required): string
  The date when the customer deposit is created.
• customerRef(required): string
  The customer reference.
• depositSpecName(required): string
  The deposit specoification name.
• depositSpecRef(required): string
  The deposit specification reference.
• discountAmount: object Money
• effectiveDate(required): string
  The date from which the customer deposit is effective.
• href(required): string
  The unique resource URL, used to get the object.
• id(required): string
  The customer deposit ID.
• interestAmount: object Money
• modifiedAt(required): string
  The date when the customer deposit is modified.
• notes: string
  The notes for the customer deposit.
• receivedAmount: object Money
• releasedAmount: object Money
• releaseType: integer (int32)
  The release type. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
• serviceRef(required): string
  The service reference.
• status(required): string
  The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED
• totalAmount: object Money
• transactions(required): array transactions
• validFor: object TimePeriod
• validityRule: object DepositValidityRule

{
    "required":[
        "billProfileRef",
        "code",
        "createdAt",
        "customerRef",
        "depositSpecName",
        "depositSpecRef",
        "effectiveDate",
        "href",
        "id",
        "modifiedAt",
        "serviceRef",
        "status",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"The customer deposit ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the customer deposit is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the customer deposit is modified."
        },
        "effectiveDate":{
            "type":"string",
            "description":"The date from which the customer deposit is effective."
        },
        "status":{
            "type":"string",
            "description":"The deposit status. Allowed Values: WAITING, ACTIVE, EXPIRED, TRANSFERRED, RELEASED, REFUNDED, CANCELLED"
        },
        "totalAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "notes":{
            "type":"string",
            "description":"The notes for the customer deposit."
        },
        "receivedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "releasedAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "interestAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "balanceAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "discountAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "customerRef":{
            "type":"string",
            "description":"The customer reference."
        },
        "depositSpecRef":{
            "type":"string",
            "description":"The deposit specification reference."
        },
        "depositSpecName":{
            "type":"string",
            "description":"The deposit specoification name."
        },
        "serviceRef":{
            "type":"string",
            "description":"The service reference."
        },
        "billProfileRef":{
            "type":"string",
            "description":"The bill profile reference."
        },
        "releaseType":{
            "type":"integer",
            "description":"The release type. Allowed Values: <b>1</b> (Prepayment), <b>2</b> (Refund), <b>3</b> (Zeroise).",
            "format":"int32"
        },
        "code":{
            "type":"string",
            "description":"The external identifier."
        },
        "transactions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CustomerDepositTransactions"
            }
        },
        "validityRule":{
            "$ref":"#/components/schemas/DepositValidityRule"
        },
        "validFor":{
            "$ref":"#/components/schemas/TimePeriod"
        }
    }
}

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 : transactions

Type: array

Show Source

• Array of: object CustomerDepositTransactions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CustomerDepositTransactions"
    }
}

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

Nested Schema : DepositValidityRule

Type: object

Show Source

• endOffsetPeriodUnit: integer (int32)
  The unit of measure for the end offset.
  Allowed Values:

  • 0 (Month)
  • 1 (Day)
  • 2 (Week)
  • 3 (Year)
• endOffsetPeriodValue: integer (int32)
  The value for the end offset.

{
    "type":"object",
    "properties":{
        "endOffsetPeriodUnit":{
            "type":"integer",
            "description":"The unit of measure for the end offset.<br/>Allowed Values: <ul><li><b>0</b> (Month)</li><li><b>1</b> (Day)</li><li><b>2</b> (Week)</li><li><b>3</b> (Year)</li></ul>",
            "format":"int32"
        },
        "endOffsetPeriodValue":{
            "type":"integer",
            "description":"The value for the end offset.",
            "format":"int32"
        }
    }
}

Nested Schema : CustomerDepositTransactions

Type: object

Show Source

• transactionRef(required): string
  Reference to the transaction record.
• transactions(required): string
  The transactions.

{
    "required":[
        "transactionRef",
        "transactions"
    ],
    "type":"object",
    "properties":{
        "transactions":{
            "type":"string",
            "description":"The transactions."
        },
        "transactionRef":{
            "type":"string",
            "description":"Reference to the transaction record."
        }
    }
}

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get deposits for a particular customer by submitting a GET request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X GET 'http://hostname:port/bcws/webresources/version/depositManagement/customerDeposit?customerRef=0.0.0.1+-account+2205426&serviceRef=0.0.0.1+-service-telco-gsm+2203914&billProfileRef=0.0.0.1+-billinfo+2206194'

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.

Example of Response Body

This example shows the contents of the response body in JSON format.

[
 {
        "validityRule": null,
        "id": "0.0.0.1+-purchased_deposit+3243617",
        "href": "http://hostname:port/bcws/webresources/version/customerDeposit/0.0.0.1+-purchased_deposit+3243617",
        "createdAt": "2021-10-28T07:05:17.000Z",
        "modifiedAt": "2021-10-28T07:05:17.000Z",
        "effectiveDate": null,
        "code": "",
        "status": null,
        "customerRef": "0.0.0.1+-account+3208384",
        "serviceRef": "0.0.0.0++0",
        "billProfileRef": "0.0.0.0++0",
        "depositSpecRef": "0.0.0.1+-deposit_specification+3206595",
        "validFor": {
            "startDateTime": "2021-10-28T07:05:17.000Z",
            "endDateTime": "2022-01-26T00:00:00.000Z"
        },
        "totalAmount": {
            "amount": 36
        },
        "receivedAmount": {
            "amount": 36
        },
        "releasedAmount": {
            "amount": 0
        },
        "interestAmount": {
            "amount": 0
        },
        "balanceAmount": {
            "amount": 36
        },
        "releaseType": "PREPAYMENT",
        "discountAmount": null,
        "discountType": null,
        "transactions": [{
                "transactionRef": "0.0.0.1+-event-billing-item-transfer+332984897451946593"
            }, {
                "transactionRef": "0.0.0.0++0"
            }
        ]
    }, 
 {
        "validityRule": null,
        "id": "0.0.0.1+-purchased_deposit+3310457",
        "href": "http://hostname:port/bcws/webresources/version/customerDeposit/0.0.0.1+-purchased_deposit+3310457",
        "createdAt": "2021-12-01T13:19:16.000Z",
        "modifiedAt": "2021-12-01T13:19:16.000Z",
        "effectiveDate": null,
        "code": "",
        "status": null,
        "customerRef": "0.0.0.1+-account+3208384",
        "serviceRef": "0.0.0.0++0",
        "billProfileRef": "0.0.0.1+-billinfo+3209920",
        "depositSpecRef": "0.0.0.1+-deposit_specification+2907536",
        "validFor": {
            "startDateTime": "2021-12-01T13:19:16.000Z",
            "endDateTime": "2022-06-29T13:19:16.000Z"
        },
        "totalAmount": {
            "amount": 18
        },
        "receivedAmount": {
            "amount": 0
        },
        "releasedAmount": {
            "amount": 0
        },
        "interestAmount": {
            "amount": 0
        },
        "balanceAmount": {
            "amount": 0
        },
        "releaseType": "ZEROISE",
        "discountAmount": null,
        "discountType": null,
        "transactions": null
 }
]

Back to Top