Get expenditure

GET /api/v2/household/{HouseholdGUID}/expenditure/{ExpenditureGUID}

Bearer auth

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

Path parameters

HouseholdGUID string(uuid) Required

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

The ExpenditureGUID 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
  
  ExpenditureGUID string(uuid)
  
  ClientGUID string(uuid)
  
  ExpenditureDescription string
  
  ExpenditureType integer
  
  ExpenditureAmount number(float)
  
  SumAssured number(float)
  
  AmountAfterDeath number(float)
  
  Frequency integer
  
  JointOwnerClientGUID string(uuid)
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  EndBasis integer
  
  EndEventGUID string(uuid) | null
  
  EndAge integer
  
  EndDate string
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  FutureLevelChange integer
  
  FutureGrossAmount number(float)
  
  FutureDateOfChangeBasis integer
  
  FutureDateOfChangeEventGUID string(uuid)
  
  FutureDateOfChangeAge integer
  
  FutureDateOfChangeDate 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}/expenditure/{ExpenditureGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/expenditure/{ExpenditureGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": {
    "ExpenditureGUID": "E3AEEF8D-3A6F-44B5-BA6D-8E8C7646C9D6",
    "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
    "ExpenditureDescription": "API Expenditure",
    "ExpenditureType": 1,
    "ExpenditureAmount": 1500,
    "SumAssured": 1500,
    "AmountAfterDeath": 1250,
    "Frequency": 12,
    "JointOwnerClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
    "StartBasis": 4,
    "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
    "StartAge": 42,
    "StartDate": "2023-05-04",
    "EndBasis": 3,
    "EndEventGUID": "1A58F6C8-90BD-4D2D-9B22-3E1F9C8E15E7",
    "EndAge": 65,
    "EndDate": "2069-02-01",
    "BackOfficeID": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
    "BackOfficeSync": 1,
    "FutureLevelChange": 1,
    "FutureGrossAmount": 10000,
    "FutureDateOfChangeBasis": 4,
    "FutureDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
    "FutureDateOfChangeAge": 55,
    "FutureDateOfChangeDate": "2069-05-04",
    "FormattedValues": {
      "EndDate": "01/02/2069",
      "EndBasis": "Specific Date",
      "Frequency": "per month",
      "StartBasis": "Event",
      "SumAssured": "£1,500",
      "StartEventGUID": "Tom's State Pension Age",
      "ExpenditureType": "Essential",
      "AmountAfterDeath": "£1,250",
      "ExpenditureAmount": "£1,500",
      "FutureGrossAmount": "£10,000",
      "FutureLevelChange": "Yes",
      "FutureDateOfChangeDate": "04/05/2069",
      "FutureDateOfChangeBasis": "Event",
      "FutureDateOfChangeEventGUID": "API's State Pension Age"
    }
  }
}

Response examples (403)

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

Response examples (404)

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