Skip to main content

Planned system outage | Our online services (including myIR and submitting information using software providers) will be unavailable from 6pm Friday 14 to approximately 4pm Sunday 16 March while we complete some system upgrades. The outage will not affect any saved drafts or web requests in myIR, our website, general tools and calculators. We apologise for any inconvenience this causes.

Hamilton (Home Straight) public counter is temporarily closed | Our Hamilton Public Counter will be closed from Monday 3 March 2025 and re-opens on Monday 17 March 2025. For anything urgent, you can call our contact centre.

The income service enables digital service providers to retrieve a customer’s income profile data reported to Inland Revenue. 

How the income service works

The income service enables access to a customer's income and tax data from all known income sources for a specific date range. It returns income data that consists of the income source, date income was recognised, income type, amount, and any deductions from that income.

Income data is accessible by an intermediary who's linked to the customer’s income tax account or the customer to whom the income belongs.

When integrated through our gateway services it can be used to match investment and income data to what we have recorded.

For access to myIR file upload and gateway services detailed technical documentation, register your organisation or login to Gateway customer support portal using the links below.

Gateway services capabilities for the income service

The gateway service used for the income service is the income API. It provides the following capabilities through defined service operations:

Service operation Description
Post Retrieves income information from Inland Revenue.
Requires an IRD number, a 'from' date, and an optional 'to' date.

The income service business use case

The following is an example of a business use case on the income service that could be used to achieve a specific business outcome.

Number Use case API Call: Post
1 As an intermediary, request income information for a customer and receive this information, then match the income data to what you've recorded for the customer. 1

Supporting services

Identity and access services

Accounting income method (AIM)

Income tax

Investment income reporting

Payday filing

Last updated: 24 Feb 2025
Jump back to the top of the page