GST is a 15% tax added to the price of most goods and services in New Zealand, including imported goods and services. Anyone registered for GST must file returns.
Filing GST through our gateway services
The GST application programming interface (API) lets businesses:
- file returns in real time
- amend returns
- retrieve a return due date
- query return status
- retrieve previously filed returns.
When a GST return is filed, the difference between the amount of GST collected and paid needs to be worked out. Any software built will need to include this function.
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 service capability for GST
The gateway service used for GST is the return service. It provides the following capabilities through defined service operations:
| Service operation | Description |
|---|---|
| Prepop | Provides information in prepopulated fields. |
| File | Lets customers file a GST return and amend previously filed returns. |
| RetrieveStatus | Provides the processing status of previously filed GST returns. |
| RetrieveReturn | Provides a copy of previously filed GST returns. |
| RetrieveFilingObligation | Provides the next due date for GST returns. |
GST 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: RS = Retrieve Status, RR = Retrieve Return, RFO = Retrieve Filing Obligation
- 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 | ||||
|---|---|---|---|---|---|
| File | Prepop | RS | RR | RFO | |
| 1. File a GST return | 2 | 1 | |||
| 2. Retrieve the status of previously filed GST returns and next filing obligation | 1 | 2 | |||
| 3. Retrieve filed GST returns | 1 | ||||
| 4. Amend and file GST returns | 2 | 1 | |||