Get asset options

GET /api/v2/household/{HouseholdGUID}/assets/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

      Additional properties are allowed.

      Hide data attributes Show data attributes object
      • AssetType object

        Additional properties are allowed.

        Hide AssetType attributes Show AssetType attributes object
        • 1 string

          Value is Main Residence.

        • 2 string

          Value is Other Property.

        • 3 string

          Value is Buy to Let Property.

        • 4 string

          Value is Business Interests.

        • 5 string

          Value is Vehicle.

        • 6 string

          Value is Other Asset.

      • StartBasis object

        Additional properties are allowed.

        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

        Additional properties are allowed.

        Hide StartEventGUID attributes Show StartEventGUID attributes object
      • EndBasis object

        Additional properties are allowed.

        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

        Additional properties are allowed.

        Hide EndEventGUID attributes Show EndEventGUID attributes object
      • AssetPurchased object

        Additional properties are allowed.

        Hide AssetPurchased attributes Show AssetPurchased attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • AssetDisposal object

        Additional properties are allowed.

        Hide AssetDisposal attributes Show AssetDisposal attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

        • 3 string

          Value is On death.

      • ClearLiabilities object

        Additional properties are allowed.

        Hide ClearLiabilities attributes Show ClearLiabilities attributes object
        • 1 string

          Value is Yes.

        • 2 string

          Value is No.

      • TaxBasis object

        Additional properties are allowed.

        Hide TaxBasis attributes Show TaxBasis attributes object
        • 1 string

          Value is Residential property.

        • 3 string

          Value is Other asset.

        • 2 string

          Value is Not subject to CGT.

      • BackOfficeSync object

        Additional properties are allowed.

        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.
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 404 application/json

    Household not found

    Hide response attributes Show response attributes object
GET /api/v2/household/{HouseholdGUID}/assets/options 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/assets/options \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": {
    "AssetType": {
      "1": "Main Residence",
      "2": "Other Property",
      "3": "Buy to Let Property",
      "4": "Business Interests",
      "5": "Vehicle",
      "6": "Other Asset"
    },
    "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"
    },
    "AssetPurchased": {
      "1": "Yes",
      "2": "No"
    },
    "AssetDisposal": {
      "1": "Yes",
      "2": "No",
      "3": "On death"
    },
    "ClearLiabilities": {
      "1": "Yes",
      "2": "No"
    },
    "TaxBasis": {
      "1": "Residential property",
      "3": "Other asset",
      "2": "Not subject to CGT"
    },
    "BackOfficeSync": {
      "1": "Yes",
      "2": "No",
      "3": "Only update from back office"
    }
  }
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}