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 client list you want to integrate with TaxLab.

This article will take you through the process of enabling your myIR credentials and setting up the IR integration.

Inland Revenue - myIR credential

The myIR credential is what enables the integration between your TaxLab organisation and IR’s services. Once your credentials have been enabled, you can add this to your IR integration which will allow IR data to be sent and received by the entities on those lists, in TaxLab.

You can add your myIR credential to the client list/s and businesses you have the right access to. So one myIR credential may enable many IR integrations, depending on which user performs the authentication.

For Tax Agent integrations:

For Customer integrations:

Add your myIR credential

To successfully enable your myIR credential you must have ‘Owner’ or ‘Administrator’ access, with ‘File’ rights for Income tax, in myIR to the client/business or the tax agency client list. You can read more about IR access for Tax Agents here.

We recommend checking your access rights in myIR before completing the steps below. 

1. From your TaxLab home page, click Administration > Under Settings > click Integrations.
2. In Integrations, click Add > select Inland Revenue - myIR credential.
3. Assign a display name to your myIR credential. 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 business, enter your myIR login details that you use to access the business(es) in myIR.
6. Click Log in.
7. IR will prompt you to review their ‘conditions of use’ and authorise TaxLab access to IR.
   
8. Once you’ve authorised the access, you will be redirected back to TaxLab.

Add an Inland Revenue integration

Once your organisation has a myIR credential added, you next need to set up the IR 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 businesses 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 businesses or client lists under a single myIR login, you can reuse the same myIR credential for each IR integration.

1. From the TaxLab Integrations page, click Add:
   • If you're a Tax agent select Inland Revenue - Tax Agent integration
   • If you're a Business select Inland Revenue - Customer integration
2. Assign a display name to the integration. This should be easily identifiable, with reference to the client list name or business name.
3. Enter your Tax agency or Customer IR number:
   • For Tax agency integrations, you'll need to enter your Tax agency IRD number and the client list ID number.
   • For Customer integrations, you'll need to enter the IRD number for the business.
4. Under myIR credential, click the dropdown arrow on the right and select the myIR credential needed for this integration.
5. Click Save.

Do I need to set up more than one Inland Revenue - integration?

For Tax agent integrations: Each client list will require its own IR integration. However if you have access to more than one client list on your Tax agency you will not need to set up another myIR credential.

For Customer integrations: If you access your business in myIR via separate logins then you’ll need to set up a myIR credential for each login. Every entity will need its own IR integration.

Changing a myIR credential

If you need to update a myIR credential, such as when the person who originally set it up is no longer with the organisation, follow these steps:

1. Create a new myIR credential. 
2. Update the integration: Once the new myIR credential has been created, click the settings cog to the right IR integration.
3. Click the x to remove the previous myIR credential.
4. Use the drop down arrow on the right to select the new myIR credential.
5. Click Save.

Note: A user with Administrator access in the TaxLab organisation can edit an IR integration regardless of who created it.

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.