Get savings

GET /api/v2/household/{HouseholdGUID}/savings

This endpoint retrieves a list of all savings belonging to the household. The response data will be an array of objects with each object being the data for one saving.

Path parameters

HouseholdGUID string(uuid) Required

The GUID of the household you wish to get savings for.

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 array[object]
  
  Hide data attributes Show data attributes object
  
  SavingsGUID string(uuid)
  
  ClientGUID string(uuid)
  
  SavingsDescription string
  
  SavingsType integer
  
  Value number(float)
  
  ValueDate string(date)
  
  JointOwnerClientGUID string(uuid)
  
  MinimumBalance number(float)
  
  DependantGUID string(uuid)
  
  ATRGUID string(uuid)
  
  OriginalInvestmentValue number(float)
  
  OriginalInvestmentDate integer(date)
  
  OriginalInvestmentPercentageWithdrawn number(float)
  
  UseAnnualExemptAmount integer
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  PolicyNumber string
  
  ProviderCode string
  
  DefaultAccount integer
  
  ISASpecialType integer
  
  Only relevant in the cashflow when the savings type is 3 or 6.
  
  FutureRiskLevelChange integer
  
  FutureRiskATRGUID string(uuid)
  
  FutureRiskDateOfChangeBasis integer
  
  FutureRiskDateOfChangeEventGUID string(uuid)
  
  FutureRiskDateOfChangeAge integer
  
  FutureRiskDateOfChangeDate string
  
  NeverTouch integer
  
  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}/savings

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "SavingsGUID": "E4A4A332-C53C-4C33-8D5B-1B846C3D6D6D",
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "SavingsDescription": "API Test",
      "SavingsType": 22,
      "Value": 150000.1,
      "ValueDate": "2023-04-20",
      "JointOwnerClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "MinimumBalance": 10000.1,
      "DependantGUID": "4FDA7A23-46AF-45B0-89DB-635544D65147",
      "ATRGUID": "3A034051-4893-4929-A17D-DFC52CC65E57",
      "OriginalInvestmentValue": 1500,
      "OriginalInvestmentDate": "2023-04-20",
      "OriginalInvestmentPercentageWithdrawn": 15,
      "UseAnnualExemptAmount": 1,
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "PolicyNumber": 134300454,
      "ProviderCode": "8379dc94-3bcf-e011-87a9-b8ac6f1693a9",
      "DefaultAccount": 42,
      "ISASpecialType": 1,
      "FutureRiskLevelChange": 1,
      "FutureRiskATRGUID": "D6880240-1A49-464E-8809-DDA993021962",
      "FutureRiskDateOfChangeBasis": 4,
      "FutureRiskDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "FutureRiskDateOfChangeAge": 55,
      "FutureRiskDateOfChangeDate": "2069-05-04",
      "NeverTouch": 2,
      "FormattedValues": {
        "Value": "£150,000",
        "ATRGUID": "Medium",
        "ValueDate": "20/04/2023",
        "NeverTouch": "No",
        "SavingsType": "Structured Product",
        "ProviderCode": "1st Source Direct",
        "DependantGUID": "Diane Edwards",
        "DefaultAccount": "No",
        "ISASpecialType": "Junior ISA",
        "MinimumBalance": "£10,000",
        "FutureRiskATRGUID": "Lowest",
        "FutureRiskLevelChange": "Yes",
        "UseAnnualExemptAmount": "Yes",
        "OriginalInvestmentDate": "20/04/2023",
        "OriginalInvestmentValue": "£1,500",
        "FutureRiskDateOfChangeDate": "04/05/2069",
        "FutureRiskDateOfChangeBasis": "Event",
        "FutureRiskDateOfChangeEventGUID": "API's State Pension Age",
        "OriginalInvestmentPercentageWithdrawn": "15%"
      }
    }
  ]
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view the household."
}

Response examples (404)

{
  "success": false,
  "message": "Household not found."
}