Estimate a refund
estimate_refundEstimate the reclaimable withholding tax on one dividend or interest payment for a source/residence country pair, with the treaty rate, filing form and deadline. Country codes are ISO alpha-2; payment_date is YYYY-MM-DD.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| is_franked | No | ||
| entity_type | No | retail | |
| holding_pct | No | ||
| income_type | No | dividend | |
| gross_amount | Yes | ||
| payment_date | Yes | ISO date YYYY-MM-DD | |
| holding_months | No | ||
| is_arms_length | No | ||
| source_country | Yes | ||
| withheld_amount | No | ||
| tax_payment_date | No | Authoritative withholding-tax payment date when the deadline runs from tax payment | |
| residence_country | Yes | ||
| withheld_rate_pct | No | ||
| is_portfolio_interest | No |