Get liabilities
This endpoint retrieves a list of all liabilities belonging to the household. The response data will be an array of objects with each object being the data for one liability.
Path parameters
-
The GUID of the household you wish to get liabilities for.
GET /api/v2/household/{HouseholdGUID}/liabilities
curl \
-X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities \
-H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
"success": true,
"data": [
{
"LiabilityGUID": "E4A4A332-C53C-4C33-8D5B-1B846C3D6D6D",
"ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
"LiabilityDescription": "API Test",
"LiabilityType": 1,
"Value": 150000.1,
"ValueDate": "2023-04-20",
"JointOwnerClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
"StartBasis": 4,
"StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"StartAge": 42,
"StartDate": "2023-05-04",
"EndBasis": 3,
"EndEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
"EndAge": 65,
"EndDate": "2069-02-01",
"InterestRate": 5.5,
"InterestRateChange": 1,
"InterestRateChangeBasis": 4,
"InterestRateChangeEventGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
"InterestRateChangeAge": 65,
"InterestRateChangeDate": "2023-04-20",
"NewInterestRate": 4.5,
"ClearLiabilityAtEnd": 1,
"BackOfficeID": 13573,
"BackOfficeSync": 1,
"PolicyNumber": 134300454,
"ProviderCode": "8379dc94-3bcf-e011-87a9-b8ac6f1693a9",
"LinkedAssetGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
"FormattedValues": {
"Value": "£150,000",
"EndBasis": "Event",
"ValueDate": "20/04/2023",
"StartBasis": "Current",
"EndEventGUID": "API's State Pension Age",
"InterestRate": "1%",
"LiabilityType": "Repayment Mortgage",
"LinkedAssetGUID": "Our House",
"InterestRateChange": "No",
"ClearLiabilityAtEnd": "Yes"
}
}
]
}
Response examples (403)
{
"success": false,
"message": "You do not have permission to view the household."
}
Response examples (404)
{
"success": false,
"message": "Household not found."
}