Get tax year status

GET

/v1/portfolios/{portfolioId}/tax-years/status

Whether each financial year can be trusted, without returning any money. A locked year carries drift: 0 NotApplicable, 1 InSync, 2 Drifted. Drifted means records inside a locked year have changed since it was locked, so the snapshot the tax-years endpoint reports for that year no longer matches what the reports would produce today, and the year needs relocking before its figures are used. An unlocked year carries readiness instead: ready is false when a record bucket is incomplete and missingBuckets names them. The current financial year carries neither, because it is not finished. Call this before trusting a locked year's figures.

Access

OAuth scope: tax:read

Available on: every plan, including free trials

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "years": [
        {
            "financialYear": 0,
            "drift": 0,
            "readiness": {
                "ready": true,
                "missingBuckets": [
                    "string"
                ]
            }
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429

Modified at 2026-09-17 10:19:59

List tax years

Get Taxable Income report