List tax years

One row per financial year the portfolio has records for, oldest first, with the capital loss position carried through them. lossesCreated, lossesApplied and remainingLossBalance are the recorded losses and their applications; remainingLossBalance is the balance carried into the next year and currentCapitalLossBalance is the balance carried forward from the last year. capitalGainLoss and taxableIncome are only present when isLocked is true, because they are read from the snapshot taken when the year was locked; a null on an unlocked year does not mean zero, it means the year has never been settled and the figure would have to be recomputed from live records by calling the tax-overview or capital-gains-tax endpoints for that year. methodName is the cost base method the year is set to use. isDataRandomized always returns false on this API; the web app sets it when it scrambles decimals behind its paywall, which this API never does.

Access

OAuth scope: tax:read

Plan feature: Capital Gains Tax Report

Available on: Basic, Standard, Premium and Pro

Free trial: not available

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "baseCurrencyCode": "string",
    "currentCapitalLossBalance": 0,
    "isDataRandomized": true,
    "years": [
        {
            "financialYear": 0,
            "isLocked": true,
            "lockMode": 0,
            "lockedAt": "2019-08-24T14:15:22.123Z",
            "capitalGainLoss": 0,
            "taxableIncome": 0,
            "methodId": 0,
            "methodName": "string",
            "lossesCreated": 0,
            "lossesApplied": 0,
            "remainingLossBalance": 0
        }
    ]
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429

Request

Request Code Samples

Responses