Update repayment
This endpoint allows users to update a repayment for a household liability. However, if the repayment is associated with a calculated repayment liability, it cannot be updated. In such cases, the request will return a 403 Forbidden error, indicating that updates are not permitted for calculated repayment liabilities.
Path parameters
-
The HouseholdGUID of the client.
-
The LiabilityGUID for the repayment you want to update.
-
The RepaymentGUID you want to update.
Body
Required
-
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if TransactionType = not 8.
-
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if TransactionType = not 8.
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if the value of StartBasis = 4.
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if the value of StartBasis = 2 or 7.
Minimum value is
0, maximum value is130. -
This field is required if the value of StartBasis = 3. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.
-
This field is required if the value of Frequency is not = 120 and the value of TransactionType is not = 8.
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if the value of EndBasis = 4 and the value of Frequency is not = 120 and the value of TransactionType is not = 8. Event end must be after starting.
To retrieve a comprehensive list of acceptable values and their corresponding formatted values, you may make a request to the designated endpoint: /api/v2/household/{HouseholdGUID}/liabilities/repayments/options
-
This field is required if the value of EndBasis = 2 or 7 and the value of Frequency is not = 120 and the value of TransactionType is not = 8. EndAge must be after starting.
Minimum value is
0, maximum value is130. -
This field is required if the value of EndBasis = 3 and the value of Frequency is not = 120 and the value of TransactionType is not 8. EndDate must be after starting. Dates should be provided in the format "Y-m-d", where "Y" represents the year, "m" represents the month and "d" represents the day. For example, "2023-07-24" represents 24th July, 2023.
-
Maximum length is
255. -
An integer representing the status of the back office sync:
- 1: Yes
- 2: No
- 3: Only update from back office
-
If set to any value, formatted values will be excluded from the response.
-
This field will be ignored, as the CalculatedRepayment cannot be updated once set. Any changes to this field will not be processed or validated. It is intended to remain unchanged after its initial value is established.
curl \
--request PUT 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"TransactionType":4,"TransactionAmount":5000.1,"InterestPayment":1,"Frequency":26,"StartBasis":3,"StartEventGUID":"F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7","StartAge":42,"StartDate":"2024-01-01","EndBasis":3,"EndEventGUID":"F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7","EndAge":65,"EndDate":"2025-01-01","BackOfficeID":13573,"BackOfficeSync":1,"ExcludeFormattedValues":1,"CalculatedRepayment":2}'{
"TransactionType": 4,
"TransactionAmount": 5000.1,
"InterestPayment": 1,
"Frequency": 26,
"StartBasis": 3,
"StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"StartAge": 42,
"StartDate": "2024-01-01",
"EndBasis": 3,
"EndEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"EndAge": 65,
"EndDate": "2025-01-01",
"BackOfficeID": 13573,
"BackOfficeSync": 1,
"ExcludeFormattedValues": 1,
"CalculatedRepayment": 2
}{
"success": true,
"data": {
"TransactionGUID": "055CAE9F-6167-4186-8DE2-EC994D2222A2",
"TransactionType": 4,
"LiabilityGUID": "246C6E3A-3A3D-42A6-BEA3-85A8E3272C2C",
"TransactionAmount": 5000.1,
"InterestPayment": 1,
"Frequency": 26,
"StartBasis": 3,
"StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"StartAge": 42,
"StartDate": "2024-01-01",
"EndBasis": 3,
"EndEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"EndAge": 65,
"EndDate": "2025-01-01",
"BackOfficeID": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
"BackOfficeSync": 1,
"CalculatedRepayment": 2,
"FormattedValues": {
"EndDate": "01/01/2025",
"EndBasis": "Specific Date",
"Frequency": "per fortnight",
"StartDate": "01/01/2024",
"StartBasis": "Specific Date",
"LiabilityGUID": "API Test",
"TransactionType": "Liability Repayment",
"TransactionAmount": "£5,000",
"CalculatedRepayment": "No"
}
}
}{
"success": false,
"message": "You do not have permission to edit the household."
}{
"success": false,
"message": "Household not found."
}{
"success": false,
"message": "Validation Error.",
"data": {
"ClientGUID": [
"The client guid field is required."
]
}
}{
"success": false,
"message": "Failed to update the liability repayment."
}