Get assets

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

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

Path parameters

  • HouseholdGUID string(uuid) Required

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

Responses

GET /api/v2/household/{HouseholdGUID}/assets 
curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/assets \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "data": [
    {
      "AssetGUID": "E3AEEF8D-3A6F-44B5-BA6D-8E8C7646C9D6",
      "ClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "AssetDescription": "Our House",
      "AssetType": 1,
      "CurrentValue": 450000.1,
      "JointOwnerClientGUID": "3F0B1C88-6D80-4C17-BB3E-1D68E6D26405",
      "AssetPurchased": 1,
      "StartBasis": 4,
      "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "StartAge": 65,
      "StartDate": "2023-05-04",
      "PurchasedValue": 300000.1,
      "AssetDisposal": 1,
      "EndBasis": 3,
      "EndEventGUID": "1A58F6C8-90BD-4D2D-9B22-3E1F9C8E15E7",
      "EndAge": 65,
      "EndDate": "2069-01-01",
      "ClearLiabilities": 1,
      "TaxBasis": 1,
      "ValueDate": "2023-04-25",
      "BackOfficeID": 13573,
      "BackOfficeSync": 1,
      "FormattedValues": {
        "EndDate": "01/01/2069",
        "EndBasis": "Specific Date",
        "TaxBasis": true,
        "AssetType": "Main Residence",
        "ValueDate": "25/04/2023",
        "CurrentValue": "£450,000",
        "AssetDisposal": true,
        "AssetPurchased": true,
        "PurchasedValue": "£300,000",
        "ClearLiabilities": true
      }
    }
  ]
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to view the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Household not found."
}