Get income options

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

This endpoint provides a comprehensive list of valid options for each field. The response example displayed is only a summarised version of the actual list. By using this endpoint, a complete list of available options for each field can be retrieved.

Path parameters

  • HouseholdGUID string(uuid) Required

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

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
      • IncomeType object
        Hide IncomeType attributes Show IncomeType attributes object
        • 1 string

          Value is Salary.

        • 6 string

          Value is Self-Employed.

        • 5 string

          Value is State Benefits.

      • Frequency object
        Hide Frequency attributes Show Frequency attributes object
        • 120 string

          Value is One-off.

        • 52 string

          Value is Paid Weekly.

        • 26 string

          Value is Paid Fortnightly.

      • StartBasis object
        Hide StartBasis attributes Show StartBasis attributes object
        • 1 string

          Value is Current.

        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

      • StartEventGUID object
        Hide StartEventGUID attributes Show StartEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • EndBasis object
        Hide EndBasis attributes Show EndBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • EndEventGUID object
        Hide EndEventGUID attributes Show EndEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.

      • TaxBasis object
        Hide TaxBasis attributes Show TaxBasis attributes object
        • 1 string

          Value is Taxable.

        • 2 string

          Value is Non-taxable.

      • LinkedAssetGUID object
        Hide LinkedAssetGUID attribute Show LinkedAssetGUID attribute object
        • 9D1BBA6-9C63-4F6F-BD6E-2C63B63B3B5C string

          Value is Our House.

      • BackOfficeSync object
        Hide BackOfficeSync attributes Show BackOfficeSync attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is Only update from back office.

      • DeathInService object
        Hide DeathInService attributes Show DeathInService attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • DeathPolicyType object
        Hide DeathPolicyType attributes Show DeathPolicyType attributes object
        • 1 string

          Value is Registered group life.

        • 2 string

          Value is Excepted group life.

      • FutureLevelChange object
        Hide FutureLevelChange attributes Show FutureLevelChange attributes object
        • 1 integer

          Value is Yes.

        • 2 integer

          Value is No.

      • FutureDateOfChangeBasis object
        Hide FutureDateOfChangeBasis attributes Show FutureDateOfChangeBasis attributes object
        • 2 string

          Value is Specific Age.

        • 3 string

          Value is Specific Date.

        • 4 string

          Value is Event.

      • FutureDateOfChangeEventGUID object
        Hide FutureDateOfChangeEventGUID attributes Show FutureDateOfChangeEventGUID attributes object
        • 8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B string

          Value is Tony's State Pension Age.

        • 1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P string

          Value is Tina's State Pension Age.

        • E8F8B580-0D24-45B7-9DA1-8F11F64B6909 string

          Value is Tina's Birthday.
  • 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}/incomes/options 
curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/incomes/options' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "IncomeType": {
      "1": "Salary",
      "6": "Self-Employed",
      "5": "State Benefits"
    },
    "Frequency": {
      "120": "One-off",
      "52": "Paid Weekly",
      "26": "Paid Fortnightly"
    },
    "StartBasis": {
      "1": "Current",
      "2": "Specific Age",
      "3": "Specific Date"
    },
    "StartEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "EndBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "EndEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    },
    "TaxBasis": {
      "1": "Taxable",
      "2": "Non-taxable"
    },
    "LinkedAssetGUID": {
      "9D1BBA6-9C63-4F6F-BD6E-2C63B63B3B5C": "Our House"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    },
    "DeathInService": {
      "1": "Yes",
      "2": "No"
    },
    "DeathPolicyType": {
      "1": "Registered group life",
      "2": "Excepted group life"
    },
    "FutureLevelChange": {
      "1": "Yes",
      "2": "No"
    },
    "FutureDateOfChangeBasis": {
      "2": "Specific Age",
      "3": "Specific Date",
      "4": "Event"
    },
    "FutureDateOfChangeEventGUID": {
      "8C31BBA6-9C63-4F6F-BD6E-2C63B63B3B3B": "Tony's State Pension Age",
      "1A2B3C4D-5E6F-7G8H-9I0J-1K2L3M4N5O6P": "Tina's State Pension Age",
      "E8F8B580-0D24-45B7-9DA1-8F11F64B6909": "Tina's Birthday"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}