Get asset

GET /api/v2/household/{HouseholdGUID}/assets/{AssetGUID}

Bearer auth

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

Path parameters

HouseholdGUID string(uuid) Required

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

The AssetGUID 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
  
  AssetGUID string(uuid)
  
  ClientGUID string(uuid)
  
  AssetDescription string
  
  AssetType integer
  
  CurrentValue number(float)
  
  JointOwnerClientGUID string(uuid)
  
  AssetPurchased integer
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  PurchasedValue integer
  
  AssetDisposal integer
  
  EndBasis integer
  
  EndEventGUID string(uuid) | null
  
  EndAge integer
  
  EndDate string
  
  ClearLiabilities integer
  
  TaxBasis integer
  
  ValueDate string(date)
  
  BackOfficeID string
  
  BackOfficeSync integer
  
  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}/assets/{AssetGUID}

curl \
 -X GET https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/assets/{AssetGUID} \
 -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": 42,
    "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": "F7FBB6B1-2D90-485C-AE89-9F9FA0426F1E",
    "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."
}