Get saving

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

Bearer auth

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

Path parameters

HouseholdGUID string(uuid) Required

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

The SavingsGUID you want to retrieve.

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
  
  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)
  
  ATRSlot integer
  
  OriginalInvestmentValue number(float)
  
  OriginalInvestmentDate integer(date)
  
  OriginalInvestmentPercentageWithdrawn number(float)
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  PolicyNumber string
  
  ProviderCode string
  
  DefaultAccount integer
  
  ISASpecialType integer
  
  FutureRiskLevelChange integer
  
  FutureRiskLevel integer
  
  FutureRiskDateOfChangeBasis integer
  
  FutureRiskDateOfChangeEventGUID string(uuid)
  
  FutureRiskDateOfChangeAge integer
  
  FutureRiskDateOfChangeDate string
  
  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/{SavingsGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings/{SavingsGUID} \
 -H "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",
    "ATRSlot": 1,
    "OriginalInvestmentValue": 1500,
    "OriginalInvestmentDate": "2023-04-20",
    "OriginalInvestmentPercentageWithdrawn": 15,
    "BackOfficeID": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
    "BackOfficeSync": 1,
    "PolicyNumber": 134300454,
    "ProviderCode": "8379dc94-3bcf-e011-87a9-b8ac6f1693a9",
    "DefaultAccount": 1,
    "ISASpecialType": 1,
    "FutureRiskLevelChange": 1,
    "FutureRiskLevel": 17,
    "FutureRiskDateOfChangeBasis": 4,
    "FutureRiskDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
    "FutureRiskDateOfChangeAge": 55,
    "FutureRiskDateOfChangeDate": "2069-05-04",
    "FormattedValues": {
      "Value": "£150,000",
      "ATRSlot": "Medium",
      "ValueDate": "20/04/2023",
      "SavingsType": "Structured Product",
      "ProviderCode": "1st Source Direct",
      "DependantGUID": "Diane Edwards",
      "DefaultAccount": "No",
      "ISASpecialType": "Junior ISA",
      "MinimumBalance": "£10,000",
      "FutureRiskLevel": "Lowest",
      "FutureRiskLevelChange": "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."
}