Add income to a holding

POST

/v1/holdings/{holdingId}/income

Records an income event against a holding. The holding's type determines the income kind:
supply the dividend block for stock or unlisted (custom) holdings, or the crypto
block for crypto holdings. Adding crypto income also creates a linked staking-reward trade
that increases the holding's quantity. Income cannot be added to a cash holding.

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params

application/json-patch+json

Example

{
    "dividend": {
        "holdingId": 0,
        "paidDate": "2019-08-24T14:15:22.123Z",
        "exDividendDate": "2019-08-24T14:15:22.123Z",
        "franked": 0,
        "frankingCredits": 0,
        "unfranked": 0,
        "isReinvested": true,
        "noOfReinvestedShares": 0,
        "priceOfReinvestedShares": 0,
        "isTrustIncome": true,
        "isForeignIncome": true,
        "exchangeRate": 0,
        "foreignTaxWithheld": 0,
        "excludeFromTax": true,
        "notes": "string",
        "isConfirmed": true,
        "dividendCurrency": "string",
        "baseCurrencyCode": "string",
        "interestIncome": 0,
        "taxDeferredAmount": 0,
        "foreignSourceIncome": 0,
        "discountedCapitalGains": 0,
        "nonDiscountedCapitalGains": 0,
        "cgtConcession": 0,
        "nonAssessable": 0,
        "amitCostBaseIncrease": 0,
        "amitCostBaseDecrease": 0,
        "tfnWithholdingTax": 0,
        "otherNetFsi": 0,
        "licCapitalGain": 0,
        "amitSource": 0,
        "isAMITConfirmed": true,
        "amitConfirmedDate": "2019-08-24T14:15:22.123Z",
        "amitNotRequired": true,
        "amitNotRequiredReason": "string"
    },
    "crypto": {
        "receivedDate": "2019-08-24T14:15:22.123Z",
        "quantity": 0,
        "price": 0,
        "typeId": 0,
        "notes": "string"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/holdings//income' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "dividend": {
        "holdingId": 0,
        "paidDate": "2019-08-24T14:15:22.123Z",
        "exDividendDate": "2019-08-24T14:15:22.123Z",
        "franked": 0,
        "frankingCredits": 0,
        "unfranked": 0,
        "isReinvested": true,
        "noOfReinvestedShares": 0,
        "priceOfReinvestedShares": 0,
        "isTrustIncome": true,
        "isForeignIncome": true,
        "exchangeRate": 0,
        "foreignTaxWithheld": 0,
        "excludeFromTax": true,
        "notes": "string",
        "isConfirmed": true,
        "dividendCurrency": "string",
        "baseCurrencyCode": "string",
        "interestIncome": 0,
        "taxDeferredAmount": 0,
        "foreignSourceIncome": 0,
        "discountedCapitalGains": 0,
        "nonDiscountedCapitalGains": 0,
        "cgtConcession": 0,
        "nonAssessable": 0,
        "amitCostBaseIncrease": 0,
        "amitCostBaseDecrease": 0,
        "tfnWithholdingTax": 0,
        "otherNetFsi": 0,
        "licCapitalGain": 0,
        "amitSource": 0,
        "isAMITConfirmed": true,
        "amitConfirmedDate": "2019-08-24T14:15:22.123Z",
        "amitNotRequired": true,
        "amitNotRequiredReason": "string"
    },
    "crypto": {
        "receivedDate": "2019-08-24T14:15:22.123Z",
        "quantity": 0,
        "price": 0,
        "typeId": 0,
        "notes": "string"
    }
}'

Responses

🟢201Created

application/json

Created

Body

Example

{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "holdingId": 0,
    "receivedDate": "2019-08-24T14:15:22.123Z",
    "quantity": 0,
    "price": 0,
    "fiatTotal": 0,
    "typeId": 0,
    "type": "string",
    "notes": "string",
    "isConfirmed": true,
    "autoAdded": true,
    "incomeTradeId": 0,
    "currencyCode": "string",
    "symbol": "string",
    "exchange": "string",
    "companyName": "string"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2026-07-08 10:04:10

Update Income record

Confirm Income record