Skip to main content

Setting up the ATO API connection

Learn how to set up and configure the ATO API connection

Updated this week

Note: You do not need to set up the ATO API for SmartDocs to work.

A short setup video is available in the original article.

If your practice uses Restricted Clients, a separate article is recommended before proceeding.


What you need

You must have the following:

  • Your practice’s ABN

  • Your practice’s TAN (you can add more than one TAN)

  • Principal authority or authorisation administrator access in ATO RAM


Add the ATO API in SmartDocs

  1. Log in to iPracticeHub.

  2. Select Setup > Configuration > Integration.

  3. Click Add item.

  4. Select ATO from the dropdown list.

  5. Enter:

    • API name: ATO API

    • Australian Business Number: enter the ABN

    • Tax Agent Number: enter the TAN

  6. Tick the Lodgment channels you want to enable. These should match the channels you use when manually downloading from the ATO Portal’s Communication History.

  7. Tick Enable API.

  8. Click Update.

Note:
Use the + symbol to add additional TANs.

IMPORTANT: Do not close the setup window until you have completed the ATO registration process as you will need the ATO Software ID and other details provided in this popup window.


Register the API in ATO RAM

You must update your ATO Relationship Authorisation Manager (RAM) to give SmartDocs access to your ATO documents.

Follow the instructions under Add or remove a software ID on the ATO webpage

To access the RAM, click here.


Important notes about ATO API lodgment channels

  • Digital Agent: Sends digital communications to Online Services for Tax Agents.

  • ATO Online: Used for activity statement notices and Statements of Tax Record.

  • MyGov: Where clients receive ATO documents if they have linked MyGov.

  • MyGov emails: Only notification emails—no PDFs are included.

  • Paper: For clients who have paper communications enabled.

If you want to import all ATO‑issued documents, enable the following channels:

  • ATO Online

  • Digital Agent

  • MyGov

  • Paper

Do not enable:

  • Email

  • SMS (SmartDocs cannot currently process these HTML‑based channels)

You may additionally enable:

  • Tax receipts

  • MyGov emails (notification only)

Did this answer your question?