Get liability

GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}

Bearer auth

This endpoint allows users to retrieve a clients liability from their household.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client.
LiabilityGUID string(uuid) Required

The LiabilityGUID you want to retrieve.

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data object
  
  Hide data attributes Show data attributes object
  
  LiabilityGUID string(uuid)
  
  ClientGUID string(uuid)
  
  LiabilityDescription string
  
  LiabilityType integer
  
  Value number(float)
  
  ValueDate string
  
  JointOwnerClientGUID string(uuid)
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  EndBasis integer
  
  EndEventGUID string(uuid)
  
  EndAge integer
  
  EndDate string
  
  InterestRate number(float)
  
  InterestRateChange integer
  
  InterestRateChangeBasis integer
  
  InterestRateChangeEventGUID string(uuid)
  
  InterestRateChangeAge integer
  
  InterestRateChangeDate string
  
  NewInterestRate number(float)
  
  ClearLiabilityAtEnd integer
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  PolicyNumber string
  
  ProviderCode string
  
  LinkedAssetGUID string(uuid)
  
  FormattedValues object
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Household not found
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

GET /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}' \
 --header "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": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
    "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."
}