Get tax overview for a period

The capital gains and taxable income position for one portfolio over one period, as the tax reports would state it. capitalGainsTaxSummary carries short and long term gains, current year losses, the CGT concession, and carry-forward losses applied and remaining. taxableIncomeSummary carries dividend, interest, crypto and foreign income, franking credits and the foreign tax offset. taxReadiness counts the records that are still incomplete and its isValid flag is false when any bucket fails, in which case the figures are computed over records the portfolio owner has not confirmed and are not final. Period is a date range, not a financial year: pass the first and last day of the year you want. Figures come from the same services as the capital gains tax and taxable income reports on this API, so use those endpoints for the parcel-level detail behind these totals.

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

{
    "periodStart": "2019-08-24T14:15:22.123Z",
    "periodEnd": "2019-08-24T14:15:22.123Z",
    "capitalGainsTaxSummary": {
        "totalCapitalGains": 0,
        "shortTermCapitalGains": 0,
        "longTermCapitalGains": 0,
        "totalCapitalLosses": 0,
        "capitalGainsSubtotal": 0,
        "cgtConcessionAmount": 0,
        "carryForwardLossesApplied": 0,
        "carryForwardLossesRemaining": 0
    },
    "taxableIncomeSummary": {
        "totalIncome": 0,
        "dividendIncome": 0,
        "interestIncome": 0,
        "dividendInterestIncome": 0,
        "cryptoIncome": 0,
        "frankingCredits": 0,
        "foreignIncome": 0,
        "foreignTaxOffset": 0,
        "totalTaxableIncome": 0,
        "netCapitalGain": 0,
        "totalAssessableIncome": 0
    },
    "taxSettings": {
        "saleAllocationMethod": "string",
        "portfolioBaseCurrencyCode": "string"
    },
    "taxReadiness": {
        "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
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠429

Get tax overview for a period

Request

Request Code Samples

Responses