Update Company Charges
PUT {{baseUrl}}/cas/companies/:companyId/charges/:chargeId
This resource is to update an existing charge.
As it is a PUT, any field NOT included will be set to NULL.
The recommended approach is to first send a GET to retrieve all fields, and then include that response in the PUT body, making the adjustments as needed.
Request Body
Legend:
✓ Field used in that jurisdiction (optional)
[blank] Field not used in that jurisdiction
| Field | AUSTRALIA | NZ & OTHERS | SINGAPORE | Validation message |
|---|---|---|---|---|
| instrumentTitle | MANDATORY | MANDATORY | MANDATORY (only for local SG companies, foreign SG companies is not mandatory) | - Instrument title is mandatory |
| number | MANDATORY | MANDATORY | MANDATORY | - Charge Number is mandatory |
| code | ||||
| description | ✓ | |||
| dateCreated | MANDATORY | MANDATORY | MANDATORY | - Date Created is mandatory - Date created is an invalid date |
| dateRegistered | ✓ | ✓ | ✓ | - Date Registered is an invalid date |
| approvalDate | ✓ | - Approval Date is an invalid date | ||
| type | MANDATORY Valid enums: -FIXED -FLOATING -FIXED & FLOATING | MANDATORY Valid enums: -FIXED -FLOATING -FIXED & FLOATING | MANDATORY Valid enums: -FIXED -FLOATING -FIXED & FLOATING | - Type of Charge is mandatory - " " is an invalid Type of Charge |
| createdBy | MANDATORY Valid enums: -INSTRUMENT -RESOLUTION -DEPOSIT -OTHER -CONDUCT | MANDATORY Valid enums: -INSTRUMENT -RESOLUTION -DEPOSIT -OTHER CONDUCT | MANDATORY Valid enums: -INSTRUMENT -RESOLUTION -DEPOSIT -OTHER -CONDUCT | - Created Method is mandatory - " " is an invalid Creation Method |
| state | MANDATORY Valid enums: -AUSTRALIAN_CAPITAL_TERRITORY -FOREIGN -NEW_SOUTH_WALES -QUEENSLAND -SOUTH_AUSTRALIA -WESTERN_AUSTRALI -TASMANIA -NORTHERN-TERRITORY -VICTORIA | Default to FOREIGN | Default to FOREIGN | - State is mandatory - " " is an invalid State |
| chargeeDetails (object) | ||||
| chargeeId | MANDATORY | MANDATORY | MANDATORY | - Chargee Id does not exist - Chargee is required |
| previousChargeeId | ✓ | ✓ | ✓ | - Previous Chargee Id does not exist |
| propertyDetails (object) | ||||
| datePropertyAcquired | ✓ | ✓ | ✓ | - Approval Date is an invalid date |
| amountCharged | ✓ | |||
| amountChargedCurrency | ✓ | |||
| propertyDetails | ✓ | ✓ | ✓ | |
| liabilityDetails (object) | ||||
| totalLiabilities | ✓ | ✓ | ✓ | |
| liabilityCurrency | ✓ | ✓ | ✓ | - " " is an invalid currency |
| liabilityDetails | ✓ | ✓ | ✓ | |
| debentureDetails (object) | ||||
| financialBenefitTotalAmountSecured | ✓ | ✓ | ✓ | |
| totalAmountSecuredCurrency | ✓ | - " " is an invalid currency | ||
| amountOfPresentIssueOfSeries | CONDITIONAL (if Date of present issue of series is entered, this is required) | - Amount of Present issue of series is mandatory | ||
| amountOfPresentIssueCurrency | ✓ | - " " is an invalid currency | ||
| dateOfPresentIssue | ✓ | - Date of Present Issue of Series is an invalid Date | ||
| debentureDetails | ✓ | |||
| totalDebentures | ✓ | ✓ | ||
| variationDetails (object) | ||||
| dateOfLastChangeVariation | ✓ | ✓ | ✓ | - Date of Last Change/Latest Variation is invalid |
| latestVariationDeclaration | CONDITIONAL (if date of change is entered, this is required) Valid enums: -CONFIRMATION_OF_TRUE_COPY -CONFIRMATION_OF_EXECUTED_INSTRUMENT -NOT_APPLICABLE | - Declaration Type is mandatory - " " is an invalid Declaration Type | ||
| changeDetails | ✓ | ✓ | ✓ | |
| satisfactionDetails (object) | ||||
| extentOfReleaseNatureOfSatisfaction | Valid enums -FULL_RELEASE -NO_RELEASE -PARTIAL_RELEASE_FOR_CASH -PARTIAL_RELEASE_FOR_PROPERTY -PARTIAL_RELEASE_FOR_CASH_AND_PROPERTY | Valid enums -FULL_RELEASE -NO_RELEASE -PARTIAL_RELEASE_FOR_CASH -PARTIAL_RELEASE_FOR_PROPERTY -PARTIAL_RELEASE_FOR_CASH_AND_PROPERTY | Valid enums -PARTIAL_DISCHARG -PARTIAL_SATISFACTION -TOTAL_SATISFACTION -TOTAL_DISCHARGE | - " " is not a valid Extent of Release/Nature of Satisfaction |
| dateOfReleaseSatisfaction | ✓ | ✓ | ✓ | - Date of Release/Satisfaction is an invalid date - Date of Release/Satisfaction cannot be before the date of registration of Charge |
| releasePaidAmountSatisfied | ✓ | ✓ | ✓ | |
| releasePaidAmountCurrency | ✓ | - " " is an invalid currency | ||
| propertyReleasedSatisfactionDetails | ✓ | ✓ | ✓ |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
| `` | null |
Request Body
{"instrumentTitle"=>"Title of Instrument Example", "number"=>"3", "code"=>nil, "description"=>nil, "dateCreated"=>"2023-04-05", "dateRegistered"=>"2023-01-01", "approvalDate"=>"2023-01-01", "type"=>"Fixed", "createdBy"=>"Resolution", "state"=>"QLD", "chargeeDetails"=>{"chargeeId"=>1941877, "previousChargeeId"=>1934710}, "propertyDetails"=>{"datePropertyAcquired"=>"2020-01-01", "amountCharged"=>nil, "amountChargedCurrency"=>nil, "propertyDetails"=>"Testing this"}, "liabilityDetails"=>{"totalLiabilities"=>123123213.0, "liabilityCurrency"=>"AUD", "liabilityDetails"=>"Note this"}, "debentureDetails"=>{"financialBenefitTotalAmountSecured"=>900000.0, "totalAmountSecuredCurrency"=>nil, "amountOfPresentIssueOfSeries"=>nil, "amountOfPresentIssueCurrency"=>nil, "dateOfPresentIssue"=>nil, "debentureDetails"=>nil, "totalDebentures"=>9000000}, "variationDetails"=>{"dateOfLastChangeVariation"=>"2023-09-02", "changeDetails"=>"to be changed", "latestVariationDeclaration"=>"CONFIRMATION_OF_EXECUTED_INSTRUMENT"}, "satisfactionDetails"=>{"extentOfReleaseNatureOfSatisfaction"=>"Total Discharge", "dateOfReleaseSatisfaction"=>"2024-01-01", "releasePaidAmountSatisfied"=>23112.0, "releasePaidAmountCurrency"=>"BZD", "propertyReleasedSatisfactionDetails"=>"Released Property"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string |
RESPONSES
status: OK
{"approvalDate":null,"chargeeDetails":{"chargeeId":1941877,"previousChargeeId":1934710},"code":null,"createdBy":"Resolution","dateCreated":"2023-04-05","dateRegistered":"2023-01-01","debentureDetails":{"amountOfPresentIssueCurrency":null,"amountOfPresentIssueOfSeries":0,"dateOfPresentIssue":null,"debentureDetails":null,"financialBenefitTotalAmountSecured":900000,"totalAmountSecuredCurrency":null,"totalDebentures":0},"description":null,"id":3505,"instrumentTitle":"Title of Instrument Example","liabilityDetails":{"liabilityCurrency":"AUD","liabilityDetails":"Note this","totalLiabilities":123123213},"number":"4","propertyDetails":{"amountCharged":0,"amountChargedCurrency":null,"datePropertyAcquired":"2020-01-01","propertyDetails":"Testing this"},"satisfactionDetails":{"dateOfReleaseSatisfaction":"2024-01-01","extentOfReleaseNatureOfSatisfaction":"Total Discharge","propertyReleasedSatisfactionDetails":"Released Property","releasePaidAmountCurrency":null,"releasePaidAmountSatisfied":23112},"state":"QLD","type":"Fixed","variationDetails":{"changeDetails":"to be changed","dateOfLastChangeVariation":"2023-09-02","latestVariationDeclaration":null,"latestVariationDeclarationDescription":null}}