Skip to main content

Temporary office hours - Cyclone Gabrielle Our Gisborne office is open 9.00am to 1.00pm.

North Island flooding | Many of you have been affected by the flooding in the North Island and may need help keeping up with your tax obligations. Find out more

Inland Revenue Inland Revenue
  • About us
    • About us
    • IR careers
  • News
    • Media releases
    • Updates
    • Subscribe
    • Seminars
  • Related Websites
    • Tax Technical
    • Tax Policy
    • International
  • Contact us
    • Contact us
    • Media queries
    • Tax Technical queries
    • Tax Policy queries
  • English
Register myIR login
myIR login
Individuals and families Ngā tāngata me ngā whānau
  • IRD numbers Ngā tau IRD
  • Income tax for individuals Te tāke moni whiwhi mō ngā tāngata takitahi
  • File my individual tax return Te tuku i tētahi puka tāke takitahi
  • Support for families Ngā tautoko i ngā whānau
  • KiwiSaver Poua he Oranga
  • Student loans Student loans
  • Self-employed Mahi ā-kiri
  • More... Tāpiri atu…
Business and organisations Ngā pakihi me ngā whakahaere
  • Income tax Tāke moni whiwhi mō ngā pakihi
  • Employing staff Te tuku mahi ki ngā kaimahi
  • KiwiSaver for employers Te KiwiSaver mō ngā kaituku mahi
  • Goods and services tax (GST) Tāke mō ngā rawa me ngā ratonga
  • Non-profits and charities Ngā umanga kore-huamoni me ngā umanga aroha
  • International Tāwāhi
  • More... Tāpiri atu…
Intermediaries and others Ngā takawaenga me ētahi atu
  • Tax agents Ngā māngai tāke
  • Bookkeepers Te kaikaute
  • PAYE intermediaries Ngā takawaenga PAYE
  • Payroll bureaus Ngā tari utu ā-rārangi
  • Digital service providers Ngā kaiwhakarato pūmanawa rorohiko
  • More... Tāpiri atu…
About us
  • About us
  • IR careers
News
  • Media releases
  • Updates
  • Subscribe
  • Seminars
Related Websites
  • Tax Technical
  • Tax Policy
  • International
Contact us
  • Contact us
  • Media queries
  • Tax Technical queries
  • Tax Policy queries
English
Register
myIR login
Inland Revenue
Home
Individuals and families Ngā tāngata me ngā whānau
Popular pages Ngā wharangi rongonui
Cost of Living Payment Utu mō te utu oranga IRD numbers Ngā tau IRD File my individual tax return Te tuku i tētahi puka tāke takitahi Support for families Ngā tautoko i ngā whānau Managing my tax Te whakahaere i taku tāke
More individuals and families
Familes Ngā whānau
Working for Families Working for families Child support Te tautoko tamariki Paid parental leave Te utu tiaki pēpi
Property and Trusts Ngā wharangi rongonui
Trusts and estates Ngā rōpū kaitiaki me ngā rawa tuku iho Property Ngā rawa
Individuals Ngā tāngata
Income tax for individuals Te tāke moni whiwhi mō ngā tāngata takitahi Non-residents Ngā kainoho-tāwāhi Self-employed Mahi ā-kiri Kiwisaver for individuals Kiwisaver mā te tangata takitahi Student loans Ngā pūtea taurewa ākonga Cryptoassets for individuals Ngā rawa whiti-rangi mā te tangata takitahi Unclaimed money
Situations Ngā āhuatanga
I am going overseas Kei te haere ahau ki tāwāhi I received an income tax assessment I whiwhi i ahau tētahi aromatawai tāke moni whiwhi I'm struggling to file and pay my tax
More situations
Business and organisations Ngā pakihi me ngā whakahaere
Popular pages Ngā wharangi rongonui
Covid-19 Businesses and organisations KOWHEORI-19 Ngā pakihi me ngā whakahaere File a companies income tax return - IR4 Te tuku i tētahi puka tāke moni whiwhi kamupene - IR4 Not-for-profits and charities PAYE calculator to work out salary and wage deductions Property Ngā rawa IRD numbers Ngā tau IRD
More business and organisations
Income tax Te tāke moni whiwhi
Types of business income Ngā momo moni whiwhi pakihi Tax rates for businesses Ngā pāpātanga tāke mō te pakihi Balance dates Ngā rā mutunga tau pūtea
GST Tāke hokohoko (GST)
Charging GST Te uta i te tāke hokohoko Claiming GST Te kerēme tāke hokohoko
Employing staff Te tuku mahi ki ngā kaimahi
Register as an employer Te rēhita hei kaituku mahi Paying staff Utu kaimahi Payday filing Te tāpaetanga rā utu Deductions from income Ngā tangohanga mai i ngā moni whiwhi Kiwisaver for employers Te KiwiSaver mō ngā kaituku mahi
International Tāwāhi
International tax for business Te tāke aowhānui mō ngā pakihi
Situations Ngā āhuatanga
I am starting a new business Kei te tīmata au i tētahi pakihi hou I am going to employ someone Kei te tuku mahi ahau ki tētahi tangata My business is making a loss Kei te hapa taku pakihi
More situations
Intermediaries and others Ngā takawaenga me ētahi atu
Intermediaries Ngā takawaenga
Becoming an intermediary Te tū hei takawaenga Getting authority to act Te whiwhi whakamanatanga Executive office holders Ngā kaipupuri tūnga whakahaere Linking client accounts Te honohono pūkete kiritaki Nominated person Te tangata kua whakaingoatia Tax pooling Te whakarōpū tāke Gateway services
More intermediaries and others
Tax agents Ngā māngai tāke
Agents answers Ngā Whakautu Māngai Tax agent status Te tūnga māngai tāke Extension of time arrangements Te whakaroa i ngā whakaritenga wā Managing consolidated groups Te whakahaere rōpū tōpū Income tax for individual clients of tax agents Te tāke moni whiwhi mā ngā kiritaki takitahi a ngā takawaenga News updates for tax agents
More tax agents
Digital service providers Ngā kaiwhakarato ratonga matihiko
Getting started guide About the developer portal Mō te tomokanga kaiwhakawhanake Gateway services architecture Te hanganga ratonga tomokanga Services catalogue Te putumōhio ratonga
More digital service providers
Roles Ngā tūranga
Tax agents Ngā māngai tāke Bookkeepers Ngā kaikaute PAYE intermediaries Ngā takawaenga PAYE Payroll bureaus Ngā tari ripanga utu kaimahi Other representatives Ētahi atu māngai
Search tips

Te ratonga takawaenga Intermediation service

For software providers
For software providers
  • Services catalogue
    • Access
      • Identity and access
      • Intermediation service
      • Software intermediation service

Intermediation is the process of linking an account or customer record belonging to an individual or organisation to a client list of a business intermediary (like a tax agent, bookkeeper or payroll bureau) so the intermediary can act on their behalf.

About the intermediation service

The intermediation service is a SOAP web service that enables intermediaries to:

  • link, delink or update the intermediary client list to their clients' accounts or customer master
  • retrieve clients and client lists that have already been established.

Intermediaries can use this service to create and manage links from a client list to a customer master or their accounts on any tax product.

If you have any questions about using gateway services for the intermediation service, email [email protected]

Intermediaries and others

Intermediation service software development kit (SDK)

This SDK helps you integrate:

  • the schema (XSD) and supporting WSDL for the return service
  • the build pack to view data definitions and response status codes
  • sample request and response messages
  • test scenarios
  • test data.

Intermediation service software developer kit on GitHub 

Use the Getting started guide to find out how to access our sandbox (mock services) and test environments.

Getting started guide

Gateway services capability

The intermediation service provides the following capabilities through defined service operations on the gateway services:

Service operation Description
Link Enables:
  • linking of a business intermediary's client list to a client account
  • a business intermediary's client list to the client's customer master.
  • Delink Enables:
  • delinking of a business intermediary's client list to a client account
  • a business intermediary's client list from the client's customer master.
  • Update Enables:
  • updating of a business intermediary's ability to redirect mail or disbursements on a client account
  • switching of a client account between a business intermediary's client lists.
  • Retrieve client list Enables retrieving of client lists belonging to a business intermediary as well as all of the clients in each list. This can be filtered by client account type or client list ID.
    Retrieve client Enables retrieving of the client attributes between a business intermediary and a linked client or client accounts. This can be filtered by a client’s account type.

    Intermediation service business use cases 

    The following are examples of sequences of the gateway return service operations that could be used to achieve a specific business outcome.

    Keys

    • Gateway service operations: RCL = Retrieve Client List, RC = Retrieve Client
    • The numbers for each use case are the order in which these operations should be called when using this services.
    Use case Gateway service operation
    Link Delink Update RCL RC
    1. Retrieve complete list of clients and then request to link a new client to a client list. 2 1
    2. Link an existing client’s customer master to a client list. 1
    3. Retrieve a client’s details (such as client accounts they have access to, if mail or disbursements are redirected to them) and then update client details. 2 1
    4. Remove a client from a client list. 1 2
    5. View lists of clients that have been approved or are pending approval (authorised payroll bureaus only) 1
    6. Move a client to another client list the intermediary manages. 1

    Supporting services

    Identity and access service

    Software intermediation service

      Tasks

      • Getting started guide

      Topics

      • Working with us
      • Guides and docs for developers
      • Availability of our services

      Other Sites

      • Log in to the developer portal
      • Register for the developer portal

      Moving between Inland Revenue sites

      picto--truck

      Heads up. We're taking you to our old site, where the page you asked for still lives

      Continue to old site
      Last updated: 28 Apr 2021
      Jump back to the top of the page top
      Inland Revenue Inland Revenue

      FOLLOW US

      • Facebook
      • Twitter
      • Youtube
      • LinkedIn
      • Subscribe

      CONTACT US

      • Contact Information
        • Contact us
        • Media queries
        • Tax Policy enquiries
        • Tax Technical enquiries
      • About us
      • Careers
      • International
      • About the site
      • Conditions of use
      • Privacy
      • Glossary
      • Accessibility
      • Copyright
      • MyIR Help
      © Copyright 2023 Inland Revenue
      New Zealand Government
      Shielded website