Jump to

• Request
• Response
• Examples

Get Deposit Specification Profiles

get

/bcws/webresources/v1.0/depositManagement/depositspecprofile

Gets the deposit specification profiles that match the query criteria.

Request

Query Parameters

• expiresAt: string
  The deposit specification profile expiry date, for example: 2037-09-18T18:30:00.000Z
• limit: string
  The maximum number of records to be displayed on a page.
• name: string
  The name of the deposit specification profile.
• status: string
  The deposit specifiction profile status, for example: ACTIVE

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The deposit specification profile details were returned successfully.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object depositSpecProfile

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

Nested Schema : depositSpecProfile

Type: object

Show Source

• code(required): string
  The deposit specification profile code.
• createdAt(required): string
  The date when the deposit specification profile is created.
• descr(required): string
  The deposit specification profile description.
• expiresAt(required): string
  The expiry date of the deposit specification profile.
• hostName(required): string
  Not used.
• href(required): string
  The unique resource URL, used to get the deposit specification profile object.
• id(required): string
  The deposit specification profile ID.
• interestRule: object DepositInterestRule
• isExemptible: boolean
  Default Value: false

  Specify whether the deposit specification profile is exemptible (true) or not (false).
• isOverridable: boolean
  Default Value: false

  Specify whether the deposit specification profile is overridable (true) or not (false).
• isPayinterest: boolean
  Default Value: false

  Specify whether the interest must be paid for the deposit specification profile (true) or not (false).
• isRefundable(required): string
  Not used.
• isTransferrable: boolean
  Default Value: false

  Specify whether the deposit specification profile is transferrable (true) or not (false).
• modifiedAt(required): string
  The date when the deposit specification profile is modified.
• name(required): string
  The deposit specification profile name.
• refundRule: object DepositRefundRule
• releaseType: integer (int32)
  The release type for the deposit specification profile. Allowed Values: 1 (Prepayment), 2 (Refund), 3 (Zeroise).
• startDateTime(required): string
  The start date of the deposit specification profile.
• status(required): string
  The deposit specification profile status. Allowed Values: 0 (Active), 1 (Draft), 2 (Canceled).
• validityRule: object DepositValidityRule
• validityRuleSource(required): string
  The deposit validity rule source.
  Allowed Values: SYSTEM_DEFINED, RULE_DEFINED

{
    "required":[
        "code",
        "createdAt",
        "descr",
        "expiresAt",
        "hostName",
        "href",
        "id",
        "isRefundable",
        "modifiedAt",
        "name",
        "startDateTime",
        "status",
        "validityRuleSource"
    ],
    "type":"object",
    "properties":{
        "validityRuleSource":{
            "type":"string",
            "description":"The deposit validity rule source.<br/>Allowed Values: SYSTEM_DEFINED, RULE_DEFINED"
        },
        "id":{
            "type":"string",
            "description":"The deposit specification profile ID."
        },
        "href":{
            "type":"string",
            "description":"The unique resource URL, used to get the deposit specification profile object."
        },
        "createdAt":{
            "type":"string",
            "description":"The date when the deposit specification profile is created."
        },
        "modifiedAt":{
            "type":"string",
            "description":"The date when the deposit specification profile is modified."
        },
        "expiresAt":{
            "type":"string",
            "description":"The expiry date of the deposit specification profile."
        },
        "startDateTime":{
            "type":"string",
            "description":"The start date of the deposit specification profile."
        },
        "name":{
            "type":"string",
            "description":"The deposit specification profile name."
        },
        "hostName":{
            "type":"string",
            "description":"Not used."
        },
        "descr":{
            "type":"string",
            "description":"The deposit specification profile description."
        },
        "code":{
            "type":"string",
            "description":"The deposit specification profile code."
        },
        "isRefundable":{
            "type":"string",
            "description":"Not used."
        },
        "releaseType":{
            "type":"integer",
            "description":"The release type for the deposit specification profile. Allowed Values: <b>1</b> (Prepayment), <b>2</b> (Refund), <b>3</b> (Zeroise).",
            "format":"int32"
        },
        "isPayinterest":{
            "type":"boolean",
            "description":"Specify whether the interest must be paid for the deposit specification profile (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "isExemptible":{
            "type":"boolean",
            "description":"Specify whether the deposit specification profile is exemptible (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "isTransferrable":{
            "type":"boolean",
            "description":"Specify whether the deposit specification profile is transferrable (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "isOverridable":{
            "type":"boolean",
            "description":"Specify whether the deposit specification profile is overridable (<b>true</b>) or not (<b>false</b>).",
            "default":false
        },
        "refundRule":{
            "$ref":"#/components/schemas/DepositRefundRule"
        },
        "interestRule":{
            "$ref":"#/components/schemas/DepositInterestRule"
        },
        "validityRule":{
            "$ref":"#/components/schemas/DepositValidityRule"
        },
        "status":{
            "type":"string",
            "description":"The deposit specification profile status. Allowed Values: <b>0</b> (Active), <b>1</b> (Draft), <b>2</b> (Canceled)."
        }
    },
    "xml":{
        "name":"depositSpecProfile"
    }
}

Nested Schema : DepositInterestRule

Type: object

Show Source

• glCode: integer (int32)
  The general ledger ID.
• interestFrequencyUnit: integer (int32)
  The unit of measure for the interest frequency.
  Allowed Values:

  • 0 (Month)
  • 1 (Day)
  • 2 (Week)
  • 3 (Year)

  
  Default value: 0
• interestFrequencyValue: integer (int32)
  The interest frequency.
• interestRate(required): number
  The deposit interest rate.
• interestType: integer (int32)
  The deposit interest type.
  

  • 0 (Simple)
  • 1 (Compound)
  • 2 (Absolute)
  • 3 (Invalid zero error)
• startInterestFrom: integer (int32)
  The date when interest starts on the deposit. Allowed Values:

  • 0 (Partial payment)
  • 1 (Full payment)

{
    "required":[
        "interestRate"
    ],
    "type":"object",
    "properties":{
        "interestFrequencyUnit":{
            "type":"integer",
            "description":"The unit of measure for the interest frequency.<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><br/>Default value: <b>0</b>",
            "format":"int32"
        },
        "interestFrequencyValue":{
            "type":"integer",
            "description":"The interest frequency.",
            "format":"int32"
        },
        "interestType":{
            "type":"integer",
            "description":"The deposit interest type.<br/><ul><li><b>0</b> (Simple)</li><li><b>1</b> (Compound)</li><li><b>2</b> (Absolute)</li><li><b>3</b> (Invalid zero error)</li></ul>",
            "format":"int32"
        },
        "interestRate":{
            "type":"number",
            "description":"The deposit interest rate."
        },
        "startInterestFrom":{
            "type":"integer",
            "description":"The date when interest starts on the deposit. Allowed Values: <ul><li><b>0</b> (Partial payment)</li><li><b>1</b> (Full payment)</li></ul>",
            "format":"int32"
        },
        "glCode":{
            "type":"integer",
            "description":"The general ledger ID.",
            "format":"int32"
        }
    }
}

Nested Schema : DepositRefundRule

Type: object

Show Source

• glCode: integer (int32)
  The general ledger ID.
• handlingFee: object Money
• handlingFeeType: integer (int32)
  The handling fee type.
  Allowed Values: PERCENTAGE, ABSOLUTE
• hasWorkFlow: boolean
  Default Value: true

  Specify whether the deposit refund has a workflow (true) or not (false).
• id: integer (int32)
  The ID of the deposit refund rule.
• minRefundAmount: object Money
• offsetPeriodUnit(required): string
  The unit of measure for the offer period.
  Allowed Values: DAY, WEEK, MONTH, YEAR
• offsetPeriodValue: integer (int32)
  The offer period value.

{
    "required":[
        "offsetPeriodUnit"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "description":"The ID of the deposit refund rule.",
            "format":"int32"
        },
        "hasWorkFlow":{
            "type":"boolean",
            "description":"Specify whether the deposit refund has a workflow (<b>true</b>) or not (<b>false</b>).",
            "default":true
        },
        "handlingFeeType":{
            "type":"integer",
            "description":"The handling fee type.<br/>Allowed Values: PERCENTAGE, ABSOLUTE",
            "format":"int32"
        },
        "handlingFee":{
            "$ref":"#/components/schemas/Money"
        },
        "minRefundAmount":{
            "$ref":"#/components/schemas/Money"
        },
        "offsetPeriodUnit":{
            "type":"string",
            "description":"The unit of measure for the offer period.<br/>Allowed Values: DAY, WEEK, MONTH, YEAR"
        },
        "offsetPeriodValue":{
            "type":"integer",
            "description":"The offer period value.",
            "format":"int32"
        },
        "glCode":{
            "type":"integer",
            "description":"The general ledger ID.",
            "format":"int32"
        }
    }
}

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

500 Response

An error occurred. An exception has been raised.

Back to Top

Examples

This example shows how to get active deposit specification profiles 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/depositSpecProfile?name=Deposit*&status=ACTIVE'

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.

[
    {
        "id": "0.0.0.1+-config-deposit_spec_profile+2644112",
        "href": "http://hostname:port/bcws/webresources/version/depositManagement/depositSpecProfile/0.0.0.1+-config-deposit_spec_profile+2644112",
        "createdAt": "2021-11-06T12:23:29.000Z",
        "modifiedAt": "2021-11-06T12:27:42.000Z",
        "expiresAt": "2022-10-30T18:29:59.000Z",
        "startDateTime": "2021-11-06T12:23:29.000Z",
        "name": "Deposit Spec Profile Updated",
        "hostName": "-",
        "descr": "Deposit Spec Profile Descr",
        "code": "21321",
        "releaseType": "REFUND",
        "isPayinterest": true,
        "isExemptible": true,
        "isOverridable": true,
        "isTransferrable": true,
        "refundRule": {
            "glCode": 104,
            "handlingFee": {
                "amount": 6
            },
            "handlingFeeType": "PERCENTAGE",
            "hasWorkFlow": true
        },
        "interestRule": {
            "glCode": 102,
            "interestFrequencyUnit": "DAYS",
            "interestFrequencyValue": 23,
            "interestRate": 20.66,
            "interestType": "COMPOUND",
            "startInterestFrom": "PARTIAL_PAYMENT"
        },
        "validityRule": {
            "endOffsetPeriodUnit": "WEEKS",
            "endOffsetPeriodValue": 6
        }
    }
]

Back to Top