Set up an Inland Revenue integration

Overview

With TaxLab’s Inland Revenue (IR) integration, you can easily e-file returns directly with IR and receive correspondence. If you’re a tax agency, the connection also retrieves tax payment transactions and can automatically import your client list, creating entities for each client in TaxLab. You’ll need to do this for each tax agent or client list you want to connect.

This article will take you through the process of authenticating your TaxLab organisation with IR’s Application gateway and setting up the IR integration.

Inland Revenue Application Gateway

The Inland Revenue Application Gateway is what authenticates the link between your TaxLab organisation and IR’s services. Once the gateway has been authenticated, you can add this to your Inland revenue integration which will allow IR data to be sent and received by the entities on those lists, in TaxLab.

You can only add the gateway to the client list/s you have access to. So one gateway may contain one, or many lists, depending on which user performs the authentication.

For Tax Agents:

For non-tax agents:

In order to successfully authenticate an IR application gateway you must have ‘Owner’ or ‘Administrator’ access, with ‘File’ rights for Income tax, in myIR to the client/taxpayer or the tax agency client list. You can read more about IR access for Tax Agents here.

Authenticate the application gateway

1. From your TaxLab home page, click Administration > Under Settings > click Integrations.
2. In Integrations, click Add > select Inland Revenue Application Gateway.
   
3. Assign a display name to the gateway. This should be easily identifiable to you and other users.
4. Click Confirm.
   
5. Next, you'll be redirected to the Inland Revenue website, where you'll be prompted to provide your myIR Username and Password.
   • For tax agents, enter your myIR login details for the tax agency client lists you wish to connect.
   • For non-tax agents, enter your myIR login details that you use to access the entity/entities in myIR.
6. Click Log in.
7. IR will prompt you to review their ‘conditions of use’ and authorise the connection to TaxLab.
   
8. Once you’ve authorised the access, you will be redirected back to TaxLab.

Add the Inland Revenue integration

Once your organisation has an IR Application Gateway authenticated, you next need to set up the Inland Revenue integration. This is what your entities are added to, to send and receive information from IR. For Tax agents you will need one IR integration per client list, and for non-tax agents you will need one IR integration per entity or Consolidated tax group. 

The authenticated IR Application Gateway that you created in the previous step can be used for multiple IR integrations. This means that if you have access to multiple entities or client lists under a single myIR login, you can reuse the same application gateway for each IR integration.

1. From the TaxLab Integrations page, click Add > Select Inland Revenue.
   
2. Assign a display name to the integration. This should be easily identifiable, with reference to the client list name or taxpayer name.
3. Choose whether this is for a tax agency or not (Yes or No).
   1. For Tax agents, enter the IRD number for your Tax agency and Client List ID.
   2. For Non-tax agents, enter the IRD number for the entity or the nominated member entity's IRD number for a Consolidated tax group.
      
4. Under Inland Revenue Application Gateway Connection, click the dropdown arrow on the right and select the Gateway needed for this integration.
   
5. Under Inland Revenue Correspondence, select your preference. This feature allows you to retrieve letters from IR and automatically create Correspondence tasks based on the selected option.(please note that additional pricing may apply. For further details, please contact us at [email protected]).
   
6. Note: You do not need to complete or confirm the Third Party Data API Key.
7. Click Confirm.

Do I need to set up more than one IR integration?

For Tax agents: each client list will require its own IR integration. However you will not need a separate Application Gateway for each, if you have multiple client lists accessible under one IR login.

For non-tax agents: If you access your entities in myIR via separate logins then you’ll need to set up an Application Gateway for each login. Every entity will need its own IR integration.

Changing a gateway

If you need to update an IR application gateway connection, such as when the person who originally set it up is no longer with the organisation, follow these steps:

1. Create a new gateway. 
2. Update the integration: Once the new gateway has been created, click the settings cog next to the IR connection for the entity to link it to the new gateway.

Note: An Admin can edit an IR integration regardless of who created it.

Inland Revenue mail retrieval options

This feature allows you to retrieve letters from Inland Revenue and automatically create Correspondence tasks based on the selected option. Please note that additional pricing may apply. For further details, please contact us at [email protected]).

The available options are: 

No correspondence: Does not retrieve any letters from Inland Revenue.

All correspondence: Retrieves all taxpayer letters from Inland Revenue.

Correspondence sent to tax agent: Retrieves only taxpayer letters for tax types where Inland Revenue sends mail to the tax agent. 

Correspondence sent to taxpayer: Retrieves only taxpayer letters for tax types where Inland Revenue sends mail to the taxpayer.

What's next:

Now you can add entities to your organisation.

Related articles

Learn how to Reauthenticate an IR application gateway. 

Learn more about Correspondence Tasks.