Update ETF Distributions ProRata

PUT

/v1/prorata-distributions/{holdingId}

This endpoint is used to accept the AMIT values and then updates all the distributions for the given holding that are between the starting and ending period.
Fields that are omitted or null leave the existing distribution values unchanged; fields sent as 0 explicitly set the pro-rated values to zero.
Amounts are distributed in proportion to each distribution's net amount and rounded to the cent so they sum exactly to the supplied total.
The stored franked amount is derived as the pro-rated franked distributions from trusts (13C) less the pro-rated franking credits (13Q), matching the AMIT form in the web app.
Negative amounts are rejected — AMIT attribution components cannot be negative.

Access

OAuth scope: transactions:write

Available on: every plan, including free trials

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Query Params

Body Params

application/json-patch+json

Example

{
    "frankedDistributionsFromTrusts": 0,
    "shareOfFrankingCreditsFromFrankedDividends": 0,
    "shareOfNonPrimaryProductionIncome": 0,
    "interestIncome": 0,
    "taxDeferredAmount": 0,
    "foreignSourceIncome": 0,
    "discountedCapitalGains": 0,
    "capitalGains": 0,
    "cgtConcession": 0,
    "nonAssessable": 0,
    "amitCostBaseIncrease": 0,
    "amitCostBaseDecrease": 0,
    "shareOfCreditForTFNAmountsWithheld": 0,
    "otherNetFsi": 0,
    "foreignIncomeTaxOffset": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/prorata-distributions/?startingPeriod=undefined&endingPeriod=undefined' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--data '{
    "frankedDistributionsFromTrusts": 0,
    "shareOfFrankingCreditsFromFrankedDividends": 0,
    "shareOfNonPrimaryProductionIncome": 0,
    "interestIncome": 0,
    "taxDeferredAmount": 0,
    "foreignSourceIncome": 0,
    "discountedCapitalGains": 0,
    "capitalGains": 0,
    "cgtConcession": 0,
    "nonAssessable": 0,
    "amitCostBaseIncrease": 0,
    "amitCostBaseDecrease": 0,
    "shareOfCreditForTFNAmountsWithheld": 0,
    "otherNetFsi": 0,
    "foreignIncomeTaxOffset": 0
}'

Responses

🟢200OK

application/json

Success

Body

Example

🟠400Bad Request

🟠401Unauthorized

🟠429

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

Get all portfolio holdings

Add income to a holding