1. REST API Reference for Billing Care
  2. Tasks
  3. Deposits

Update a Deposit Specification Profile

patch

/bcws/webresources/v1.0/depositManagement/depositspecprofile/{id}

Updates the specified deposit specification profile.

Request

Path Parameters
  • The deposit specification profile ID, for example: 0.0.0.1+-config-deposit_spec_profile+1234567
Supported Media Types
Request Body - application/xml ()
The deposit specification profile to update. The minimum required parameters are:
  • name
Root Schema : schema
Type: object
Show Source
Nested Schema : DepositInterestRule
Type: object
Show Source
Nested Schema : DepositRefundRule
Type: object
Show Source
Nested Schema : DepositValidityRule
Type: object
Show Source
Nested Schema : Money
Type: object
Show Source
Request Body - application/json ()
The deposit specification profile to update. The minimum required parameters are:
  • name
Root Schema : schema
Type: object
Show Source
Nested Schema : DepositInterestRule
Type: object
Show Source
Nested Schema : DepositRefundRule
Type: object
Show Source
Nested Schema : DepositValidityRule
Type: object
Show Source
Nested Schema : Money
Type: object
Show Source
Back to Top

Response

200 Response

The deposit specification profile was updated successfully.

500 Response

An error occurred. An exception has been raised.
Back to Top

Examples

This example shows how to update a deposit specification profile by submitting a PUT request on the REST resource using cURL. For more information about cURL, see "Use cURL".

cURL Command

curl -X PUT 'http://hostname:port/bcws/webresources/version/depositManagement/depositSpecProfile/0.0.0.1+-config-deposit_spec_profile+2644112' -H 'content-type: application/json' -d @updateProfile.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.
  • updateProfile.json is the JSON file that specifies the details to update.

Example of Request Body

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

{
    "code": 1234,
    "descr": " Deposit Spec Profile Descr",
    "expiresAt": "2022-10-30T18:29:59.000Z",
    "hostName": "-",
    "interestRule": {
        "glCode": 102,
        "interestFrequencyUnit": "DAYS",
        "interestFrequencyValue": 23,
        "interestRate": 20.66,
        "interestType": "COMPOUND",
        "startInterestFrom": "PARTIAL_PAYMENT"
    },
    "isExemptible": true,
    "isOverridable": true,
    "isPayinterest": true,
    "isTransferrable": true,
    "name": " Deposit Spec Profile Updated",
    "refundRule": {
        "glCode": 104,
        "handlingFee": {
            "amount": 6,
            "currency": "USD"
        },
        "handlingFeeType": "PERCENTAGE",
        "hasWorkFlow": true
    },
    "releaseType": "REFUND",
    "validityRule": {
        "endOffsetPeriodUnit": "WEEKS",
        "endOffsetPeriodValue": 6
    },
    "validityRuleSource": "USER_DEFINED"
}

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"
}
Back to Top