Skip to main content

2023 Income tax assessments | From now until the end of July we’re issuing income tax assessments. Most people will receive theirs by 10 June. Timelines at the end of the tax year.

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

Ngā whakahaerenga SOAP me te hanganga karere SOAP operations and message structure

For software providers
For software providers
  • Guides and docs for developers
    • Gateway services architecture
      • Communication standards
      • Security measures for gateway services
      • Service endpoints
      • SOAP operations and message structure
      • Response status codes

Our SOAP web services operations contain requests and responses with common structure and fields. These are used across different schemas and tax types for reusable service design architecture.

XSD schema structure

The XSD schema structure for gateway services are:

  • Common.xsd
  • ServiceCommon.xsd
  • SpecificProduct.xsd

All schemas for different services import a common.xsd which has some data types specific to Inland Revenue.

This common.xsd will be used in other gateway services outside of the //namespace and must be kept up to date.

You can view and download the operations, schemas and data definitions for each service in our services catalogue.

Services catalogue

SOAP messages structure

All messages require a header containing the Action: parameter. The body must contain a structured XML payload.

Refer to the WSDL for the correct addresses. Refer to samples or the WSDL element wsdl:binding/soap12:operation/soapAction for the URL to use.

The online WSDLs for gateway services define an 'any' XML request and response structure, which then relies on a group of XSDs to define the data structure of those requests and responses.

Each request and response type will define a lower, 'wrapper' element. To simplify analysis and code generation, a development-oriented version of the WSDL and XSDs is provided with the build pack that has the 'any' elements replaced with relevant types.

Schema (XSD) validations

When you send structured XML through gateway this will be checked against our published XSDs.

This is partially a late binding validation, performed after an authentication review. The message structure of these services is a simple request/response.

The XML request will be checked for well-formed XML before the schema validation. Responses to these requests will be in XML format and defined by the same schemas as requests.

Any XML submissions in the body that do not match the provided schemas will not be accepted. Incorrect namespaces will also fail validation against the published schemas.

Any malformed XML will instantly be rejected before any schema validation.

<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope"

xmlns:sft="https://services.ird.govt.nz/GWS/SoftwareIntermediation/"

xmlns:gcl="https://services.ird.govt.nz/GWS/SoftwareIntermediation/:types/RetrieveClientListRequest"

xmlns:a="http://www.w3.org/2005/08/addressing">

     <soap:Header>

 <a:Action>https://services.ird.govt.nz/GWS/SoftwareIntermediation/SoftwareIntermediation/Operation</a:Action> 

     </soap:Header>

     <soap:Body>

<sft:RetrieveClientList>

     <sft:RetrieveClientListRequestMsg>

         <rcl:RetrieveClientListRequestWrapper>

             <RetrieveClientListRequest xmlns:xsi…

                <…XML payload…>

             </RetrieveClientListRequest>

         </rcl:RetrieveClientListRequestWrapper>

     </sft:RetrieveClientListRequestMsg>

</sft:RetrieveClientList>

     </soap:Body>

</soap:Envelope>

<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope"  xmlns:a=http://www.w3.org/2005/08/addressing

xmlns:si=http://services.ird.govt.nz/GWS/SoftwareIntermediation/

xmlns:b=http://services.ird.govt.nz/GWS/SoftwareIntermediation/:types/RetrieveClientListResponse

xmlns:i=http://www.w3.org/2001/XMLSchema-instance

xmlns:cmn="urn:www.ird.govt.nz/GWS:types/Common.v1">

      <s:Header>

<a:Action s:mustUnderstand="1">

https://services.ird.govt.nz/GWS/SoftwareIntermediation/SoftwareIntermediation/RetrieveClientListResponse

</a:Action>

      </s:Header>

      <s:Body>

            <si:RetrieveClientListResponse >

 <si:RetrieveClientListResult>

        <b:RetrieveClientListResponseWrapper>

             <cmn:RetrieveClientListResponse>

                <cmn:statusMessage>

                    <cmn:statusCode>0</statusCode>

                    <cmn:errorMessage/>

                </cmn:statusMessage>

             </cmn:RetrieveClientListResponse>

                     </b:RetrieveClientListResponseWrapper>

               </si:RetrieveClientListResult>

           </si:RetrieveClientListResponse>

       </s:Body>

</s:Envelope>

    Tasks

    • Getting started guide

    Topics

    • Services catalogue
    • Gateway services architecture
    • What you need to know to integrate with us

    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

    SHARE THIS PAGE

    • Email this page
    • Linkedin
    • Facebook
    • Twitter

    SHARE THIS PAGE

    • About the site
    • Conditions of use
    • Privacy
    • Glossary
    • Accessibility
    • Copyright
    • MyIR Help
    © Copyright 2023 Inland Revenue
    New Zealand Government
    Shielded website