Turn myIR into an API

What you can build on myIR

• Get GST periods and filing status

  Build this

  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

  Build this

  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

  Build this

  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

  Build this

  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 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

  Build this

  Starts

  Every month on the 20th at 9:00 (Pacific/Auckland)

  Step 1

  For each IRD number you name, get the GST periods from Returns and transactions.

  Step 2

  Keep the periods that still show a File return link.

  Step 3

  Email you the list, one line per IRD number with the period end.

• New notices of assessment, handed to accounting

  Build this

  Starts

  Every weekday at 8:00 (Pacific/Auckland)

  Step 1

  For each IRD number, get the acknowledgements and notices of assessment issued in the last 7 days.

  Step 2

  Keep the ones that were not there on the last run.

  Step 3

  Post document type, tax type, period, date issued and amount to your accounting webhook.

• Saved returns left unsubmitted

  Build this

  Starts

  Every Monday at 8:00 (Pacific/Auckland)

  Step 1

  For each IRD number, find the returns saved in myIR but not submitted.

  Step 2

  Stop when there are none.

  Step 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, 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.

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
    }
  }'

{
  "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.

Read on November 12, 2026: Gateway services for intermediaries, About the developer portal, 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

• 登記情報提供サービス
• Cổng thông tin hóa đơn điện tử
• SIPP Online
• Edabu
• PhilHealth EPRS
• Virtual Pag-IBIG for Employers
• KWSP i-Akaun (Majikan)
• 自然人电子税务局（扣缴端）
• eMPF Platform
• My.SSS Employer Portal
• SSO e-Service
• BIR eFPS
• RD e-Filing
• 全国统一规范电子税务局
• Coretax DJP
• MyTax

Other industries: EPFO Unified Portal (Employer), IATA BSPlink, Previred, CAC Company Registration Portal, Segurança Social Direta, FCA RegData.