Get improvement

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

Bearer auth

This endpoint allows users to retrieve an improvement for a clients household asset.

Path parameters

HouseholdGUID string(uuid) Required

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

The AssetGUID for the improvement you want to retrieve.
ImprovementGUID string(uuid) Required

The ImprovementGUID you want to retrieve.

Query parameters

ExcludeFormattedValues string

If set to any value, formatted values will be excluded from the response.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- data array[object]
  
  Hide data attributes Show data attributes object
  
  TransactionGUID string(uuid)
  
  TransactionType integer
  
  AssetGUID string(uuid)
  
  Description string
  
  TransactionAmount integer
  
  AssetIncrease integer
  
  StartBasis integer
  
  StartEventGUID string(uuid)
  
  StartAge integer
  
  StartDate string
  
  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}/improvements/{ImprovementGUID}

curl \
 --request GET 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/assets/{AssetGUID}/improvements/{ImprovementGUID}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "data": [
    {
      "TransactionGUID": "E3AEEF8D-3A6F-44B5-BA6D-8E8C7646C9D6",
      "TransactionType": 10,
      "AssetGUID": "4D09A1F6-035E-437F-9B45-842C789D9D9D",
      "Description": "Our House",
      "TransactionAmount": 5000.1,
      "AssetIncrease": 10000.1,
      "StartBasis": 3,
      "StartEventGUID": "F3AAED8D-3A5F-44B5-BC6D-9E8C7646C9D7",
      "StartAge": 42,
      "StartDate": "2024-01-01",
      "FormattedValues": {
        "AssetGUID": "Our House",
        "StartDate": "01/01/2024",
        "StartBasis": "Specific Date",
        "AssetIncrease": "£10,000",
        "TransactionType": "Asset Improvement",
        "TransactionAmount": "£5,000"
      }
    }
  ]
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to view the household."
}

Response examples (404)

{
  "success": false,
  "message": "Household not found."
}