Get incomes

GET /api/v2/household/{HouseholdGUID}/incomes
Bearer auth

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

Path parameters

  • HouseholdGUID string(uuid) Required

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

Responses

GET /api/v2/household/{HouseholdGUID}/incomes 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/incomes \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": [
    {
      "IncomeGUID": "E4A4A332-C53C-4C33-8D5B-1B846C3D6D6D",
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "IncomeDescription": "My wages",
      "IncomeType": 1,
      "TaxBasis": 1,
      "IncomeAmount": 45500.1,
      "JointOwnerClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "Frequency": 12,
      "BenefitInKindAmount": 2500.1,
      "StartBasis": 4,
      "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "StartAge": 42,
      "StartDate": "2023-05-04",
      "EndBasis": 4,
      "EndEventGUID": "1A58F6C8-90BD-4D2D-9B22-3E1F9C8E15E7",
      "EndAge": 65,
      "EndDate": "2069-02-01",
      "LinkedAssetGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "SumAssured": 100000.1,
      "DeathInService": 1,
      "DeathMultiple": 4.5,
      "DeathPolicyType": 1,
      "FutureLevelChange": 1,
      "FutureGrossAmount": 10000,
      "FutureDateOfChangeBasis": 4,
      "FutureDateOfChangeEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "FutureDateOfChangeAge": 55,
      "FutureDateOfChangeDate": "2069-05-04",
      "FormattedValues": {
        "EndBasis": "Event",
        "TaxBasis": "Taxable",
        "Frequency": "Paid Annually",
        "IncomeType": "Salary",
        "StartBasis": "Event",
        "SumAssured": "£100,000",
        "EndEventGUID": "API's State Pension Age",
        "IncomeAmount": "£45,500",
        "DeathMultiple": "x4.5",
        "DeathInService": "Yes",
        "StartEventGUID": "API's State Pension Age",
        "DeathPolicyType": "Registered group life",
        "LinkedAssetGUID": "Our House",
        "FutureGrossAmount": "£10,000",
        "FutureLevelChange": "Yes",
        "BenefitInKindAmount": "£2,500",
        "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."
}