# Turn myIR into an API > Read your GST periods, notices of assessment and saved returns from myIR with one API call each. Or have a workflow check each GST account on the 20th and email you the periods still to file before the 28th. Page: https://fous.com/automate/myir Updated: 2026-11-12 Works with your own myIR account. Fous is an independent product. ## What you can build on myIR ### Get GST periods and filing status Opens Returns and transactions next to a GST account and reads each period, whether it still shows a File return link, and the amount assessed. - Takes: IRD number, periods back (optional) - Returns: Period end, filed or not filed, date received, GST to pay or refund ### Get acknowledgements and notices of assessment Reads the return acknowledgements and notices of assessment that myIR holds for one account, newest first. - Takes: IRD number, tax type (optional), issued since (optional) - Returns: Document type, tax type, period, date issued, amount ### Find saved returns not yet submitted Opens each account and lists the returns that were started and saved in myIR but never submitted. - Takes: IRD number - Returns: Account, tax type, period ### Prepare a GST return Selects File return next to a period, chooses GST amounts, fills in sales and income, purchases and expenses and adjustments, then submits or leaves it saved. - Takes: IRD number, period end, nil or not, sales and income, purchases and expenses, adjustments, submit or save - Returns: Period end, GST to pay or refund, submitted or saved ## Automate myIR with a workflow A [workflow](/product/workflows) runs your methods as one process, with nobody at the screen. A schedule or a call from your own system starts it, the steps run in order, and the result arrives in your inbox or in the systems you already use. ### GST periods not yet filed, checked before the 28th Starts: Every month on the 20th at 9:00 (Pacific/Auckland) 1. For each IRD number you name, get the GST periods from Returns and transactions. 2. Keep the periods that still show a File return link. 3. Email you the list, one line per IRD number with the period end. ### New notices of assessment, handed to accounting Starts: Every weekday at 8:00 (Pacific/Auckland) 1. For each IRD number, get the acknowledgements and notices of assessment issued in the last 7 days. 2. Keep the ones that were not there on the last run. 3. Post document type, tax type, period, date issued and amount to your accounting webhook. ### Saved returns left unsubmitted Starts: Every Monday at 8:00 (Pacific/Auckland) 1. For each IRD number, find the returns saved in myIR but not submitted. 2. Stop when there are none. 3. Email you each one with its account, tax type and period. You can run a workflow by hand on every plan, Free included. Schedules and webhook triggers come with the paid plans, from $29 a month. ## Once built, one call from your code Once you have built a [method](/product/methods), it is one POST to /v1/runs from your backend, or a tool an AI agent calls over MCP. This is what “Get GST periods and filing status” would look like. Example request: ``` curl https://api.fous.com/v1/runs \ -H "Authorization: Bearer $FOUS_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "method": "myir.ird.govt.nz/get_gst_periods", "input": { "ird_number": "000-000-000", "periods_back": 3 } }' ``` Example response: ``` { "status": "completed", "data": { "ird_number": "000-000-000", "account": "GST", "periods": [ { "period_end": "2026-10-31", "status": "Not filed", "received": null, "gst_to_pay": null, "gst_refund": null } ], "currency": "NZD", "count": 1 } } ``` An example with invented data, not a ready-made endpoint. The method exists in your organization once you build it, and its name, inputs and fields follow your request. ## MyIR’s own options Inland Revenue's gateway services file returns such as GST and payday employment information, but they are offered to digital service providers, who register, are approved and build them into their software. You use them through that software with your myIR logon. Correspondence cannot go through gateway services: secure messages stay in myIR. | Option | What it covers | What it takes | | --- | --- | --- | | Gateway services | GST and payday filing returns, prepopulated GST figures and the next filing obligation, in software that has built them. | Software from a provider that registered and was approved, and your own myIR logon with the right level of access. | | myIR file upload | Payday employment information each pay cycle, and employee details for new and departing employees, as files from your payroll software. | A myIR logon. Employment information is due on payday or within 2 days of it. | | myIR by hand | Returns and transactions for each account, GST returns, saved returns, secure web messages and documents Inland Revenue asked for. | A myIR logon for each person, with two-step verification. | Read on November 12, 2026: [Gateway services for intermediaries](https://www.ird.govt.nz/topics/intermediaries/gateway-services), [About the developer portal](https://www.ird.govt.nz/digital-service-providers/guides-and-docs/about-the-developer-portal), [Payday filing through file upload services](https://www.ird.govt.nz/digital-service-providers/services-catalogue/returns-and-information/payday-filing/payday-filing-through-file-upload-services). ## Signing in to myIR myIR signs you in with a username and password, and two-step verification is compulsory: a security code by email, text message or an authenticator app, or a passkey. A new code is asked at each login unless you use a passkey or a device trusted for up to 90 days. With Fous you sign in once with your own logon: it is sealed with AES-256, an emailed code is handled and an expired session is signed back in. ## Worth knowing - **GST is due on the 28th, with two exceptions**: Returns and payment are due by the 28th of the month after the period ends, except 7 May for March and 15 January for November. Nil returns must be filed too, and extensions are not available. - **One logon per person, clients linked first**: Each staff member needs their own myIR logon. Agents get client lists through Manage agency, and a client must be linked to the agency before anyone can act on it. - **After a not filed letter, check myIR first**: If you get a letter saying a GST return was not filed, check whether myIR shows the return as received. If it does, nothing more is needed. If not, file a new return. - **Payday filing has a 2-day window**: Employment information is filed each pay cycle, on payday or within 2 days of it. New and departing employees go in separately, as employee details. ## More in Government: East and South-East Asia, Oceania - [登記情報提供サービス](https://fous.com/automate/registry-information-service.md) - [Cổng thông tin hóa đơn điện tử](https://fous.com/automate/hoadondientu.md) - [SIPP Online](https://fous.com/automate/sipp-online.md) - [Edabu](https://fous.com/automate/edabu.md) - [PhilHealth EPRS](https://fous.com/automate/philhealth-eprs.md) - [Virtual Pag-IBIG for Employers](https://fous.com/automate/virtual-pag-ibig-for-employers.md) - [KWSP i-Akaun (Majikan)](https://fous.com/automate/kwsp-i-akaun-majikan.md) - [自然人电子税务局（扣缴端）](https://fous.com/automate/natural-person-e-tax-bureau-withholding.md) - [eMPF Platform](https://fous.com/automate/empf-platform.md) - [My.SSS Employer Portal](https://fous.com/automate/my-sss-employer-portal.md) - [SSO e-Service](https://fous.com/automate/sso-e-service.md) - [BIR eFPS](https://fous.com/automate/bir-efps.md) - [RD e-Filing](https://fous.com/automate/rd-e-filing.md) - [全国统一规范电子税务局](https://fous.com/automate/china-e-tax-bureau.md) - [Coretax DJP](https://fous.com/automate/coretax-djp.md) - [MyTax](https://fous.com/automate/mytax.md) Other industries: [EPFO Unified Portal (Employer)](/automate/epfo-unified-portal-employer), [IATA BSPlink](/automate/iata-bsplink), [Previred](/automate/previred), [CAC Company Registration Portal](/automate/cac-company-registration-portal), [Segurança Social Direta](/automate/seguranca-social-direta), [FCA RegData](/automate/fca-regdata). ## Frequently asked questions ### Does myIR have an API? Not one you call yourself. Inland Revenue's gateway services file returns such as GST and payday information, but digital service providers that register and are approved build them into their software, and you use them there with your myIR logon. Secure messages and anything your software lacks stay in myIR. ### Can I send Inland Revenue a message through gateway services? No. Correspondence cannot go through gateway services, so requests go by secure web message in myIR. Return acknowledgements and notices of assessment are in myIR or come through the document service in your software. ### Where do I find a GST return I started but did not submit? Log back in to myIR and open the account the return belongs to: the saved return is there to finish and submit. A workflow can check each account every week and email you any saved return still waiting. ### When is my GST return due? By the 28th of the month after the period ends, with payment due the same day. The period ending 31 March is due 7 May and the period ending 30 November is due 15 January. There are no extensions, and nil returns must still be filed. ### Is Fous affiliated with Inland Revenue? No. Fous is an independent product. You use it with your own myIR logon, and a method reads and does only what that logon can. Fous is an independent product: it is not affiliated with, endorsed by or sponsored by the operator of myIR (Inland Revenue, New Zealand). The name is used only to say which system this page is about. Something here wrong or out of date? Write to legal@fous.com.