Get tax readiness

Report whether a portfolio's records are complete enough to run the tax
reports for a financial year. Covers holdings, trades, dividends, crypto
income and trust income, lists the holdings that fail with the reason for
each, and lists the earlier years that still need a cost base method locked.

Access

OAuth scope: tax:read

Available on: every plan, including free trials

Responses

🟢200OK

application/json

Success

Bodyapplication/json

Example

{
    "targetFinancialYear": 0,
    "currentYear": {
        "readiness": {
            "holdings": {
                "total": 0,
                "totalValid": 0,
                "totalInvalid": 0,
                "isValid": true
            },
            "trades": {
                "total": 0,
                "totalValid": 0,
                "totalInvalid": 0,
                "isValid": true
            },
            "dividends": {
                "total": 0,
                "totalValid": 0,
                "totalInvalid": 0,
                "isValid": true
            },
            "cryptoIncome": {
                "total": 0,
                "totalValid": 0,
                "totalInvalid": 0,
                "isValid": true
            },
            "trustIncome": {
                "total": 0,
                "totalValid": 0,
                "totalInvalid": 0,
                "isValid": true,
                "unfinalisedHoldings": [
                    {
                        "holdingId": 0,
                        "symbol": "string",
                        "companyName": "string",
                        "dividendCount": 0,
                        "hasPrePopulatedData": true,
                        "missingFinancialYears": [
                            "string"
                        ]
                    }
                ]
            },
            "isValid": true
        },
        "invalidHoldings": [
            {
                "holdingId": 0,
                "symbol": "string",
                "companyName": "string",
                "reasons": [
                    "string"
                ]
            }
        ],
        "isComplete": true
    },
    "history": {
        "yearsToConfirm": [
            {
                "financialYear": 0,
                "isLocked": true,
                "methodName": "string",
                "reasons": [
                    "string"
                ]
            }
        ],
        "isConfirmed": true
    },
    "isReady": true
}

🟠429

Request

Request Code Samples

Responses