Investment income reporting through gateway services lets organisations securely file investment income information to us through defined service operations. Use this service to file investment income information or amend a previously filed return.
Investment income reporting through the gateway services is available for the following withholding tax product types:
- Approved issuer levy (AIL)
- Dividend withholding tax (DWT)
- Interest pay as you earn (IPS)
- Non-resident withholding tax (NRT)
- Resident withholding tax (RWT)
- Portfolio investment entities (PIE) attributed income.
Gateway services capability for investment income reporting
The gateway service used for investment income reporting is the Return service. It provides the following capabilities through defined service operations:
| Service operation | Description |
|---|---|
| Prepop | Not applicable for investment income reporting. |
| File | Enables payers to submit investment income information for a specific reporting period and if required submit amendments to previously filed investment income information. |
| RetrieveStatus | Provides the processing status of previously filed investment investment income information for a specific reporting period. |
| RetrieveReturn | Provides a copy of previously filed investment income information for a specific reporting period. |
| RetrieveFilingObligation | Not applicable for investment income reporting. |
| Retrieve list | Not applicable for investment income reporting. |
Investment income reporting - gateway services software developer kit
Investment income reporting business use cases
The following use cases are examples of sequences of the gateway service operations that can be used to achieve a specific business outcome when providing investment income information.
The numbers for each use case are the order in which these operations should be called when using this service.
| Number | Use cases | File | Retrieve status | Retrieve return |
|---|---|---|---|---|
| 1 | File a single IIR return for a month period and subsequently optionally retrieve return status. | 1 | 2* | |
| 2 | File multiple IIR returns for a month period and subsequently optionally retrieve return status. | 1 | 2* | |
| 3 | Amend one or more line items in an IIR return as a single filer. | 1 | ||
| 4 | Amend one or more line items in an IIR return as a multi-filer. | 1 | ||
| 5 | Replace all data in an IIR return (Reverse Replace) - file an amended single IIR return the same period for all transactions. | 1 | ||
| 6 | Intermediary files an IIR return on behalf of a payer for a specific period and optionally retrieve return status. | 1 | 2* | |
| 7 | Retrieve IIR return as a single filer for the specific period. | 1 | ||
| 8 | Retrieve IIR return as a multi-filer for a specific period. | 1* | 2 |
Note: * indicates optional process steps
PIE business use cases
The following use cases are examples of sequences of the gateway service operations that can be used to achieve a specific business outcome when providing PIE investment income information.
The numbers for each use case are the order in which these operations should be called when using this service.
| Number | Use cases | File | Retrieve status | Retrieve return |
|---|---|---|---|---|
| 1 | File a periodic PIE return (IR852) using a gateway interface. | 1 | ||
| 2 | File investor certificate PIE returns (IR854) using a gateway interface. | 1 | ||
| 3 | File an annual reconciliation PIE return (IR853) using a gateway interface. | 1 | ||
| 4 | Amend a periodic PIE return (IR852) using a gateway interface. | 1 | 2* | |
| 5 | Amend an investor certificate PIE return (IR854) using a gateway interface | 1 | 2* | |
| 6 | Amend an annual reconciliation PIE return (IR853) using a gateway interface. | 1 | 2* | |
| 7 | Retrieve the status of a PIE return using a gateway interface. | 1 | ||
| 8 | Retrieve a previously filed PIE return using a gateway interface. | 1 | 2 |
Note: * indicates optional process steps
Download detailed use cases and process flows for an investment income reporting tax type:
Please choose a Content Collection
Moving between Inland Revenue sites
Heads up. We're taking you to our old site, where the page you asked for still lives