This page contains information and artefacts for web services that enable a Tax Practitioner (TP) to manage their practice information with the ATO.
The ATO provides a number of common artefacts and reference documents to support DSPs (such as the ATO Service Registry and the ATO Service Support Versioning Strategy). These can be found here.
The web services developed to date are:
- Lodgment Program (LDGPRGM)
- Manage Agent Trust (MAT)
- Tax Practitioner Client Management Reports (TPCMR)
Lodgment Program (LDGPRGM)
Lodgment Program Statistics (LDGPRGM) service allows Tax Agents to:
- Track current years progress towards meeting their lodgment program benchmarks for income tax and fringe benefit tax lodgments
- View the previous two years income tax and fringe benefit tax lodgment outcomes
The web service messages are exchanged using the ATO ebMS3 protocol with the message payload constructed using the XML format.
LDGPRGM.0001 (2018)
Name | Version number | Status | Size | Published date |
---|---|---|---|---|
ATO LDGPRGM 0001.2018 Business Implementation Guide (DOCX) | 2.0 | Final | 227KB | 23 August 2018 |
ATO LDGPRGM.0001 2018 Package v1.0.2 Contents (DOCX) | 1.0.2 | Final | 231KB | 30 August 2018 |
ATO LDGPRGM.0001 2018 Package v1.0 (ZIP) | 1.0 | Final | 1.1MB | 26 April 2018 |
Manage Agent Trust (MAT)
The Manage Agent Trust (MAT) service allows a Tax Agent to create, maintain and remove a Tax Practitioner's trust account.
Upon providing details of their trust account, this will then enable the Tax Practitioner to receive the EFT reconciliation report which shows details of each EFT refund sent to the tax agent's or BAS agent's nominated trust account. Refer to the Tax Practitioner Client Management Reports MIG (TPCMR) for EFT reconciliation report for implementation details.
The web service messages are exchanged using the ATO ebMS3 protocol with the message payload constructed using the XBRL format.
MAT.0001 (2015)
Name | Version number | Status | Size | Published date |
---|---|---|---|---|
ATO MAT.0001 2015 Package v1.0 Contents (DOCX) | 1.0 | Final | 212KB | 19 April 2018 |
ATO MAT.0001 2015 Package v1.0 (ZIP) | 1.0 | Final | 366KB | 19 April 2018 |
Tax Practitioner Client Management Reports (TPCMR)
Tax Practitioner Client Management Reports (TPCMR) is a suite of services based on those currently available through the Electronic Lodgment Service (ELS) and provides the following:
1. Manage Report Subscription - allows for the addition or deletion of a subscription to the following report:
- Electronic Funds Transfer Subscription (which enables the tax practitioner to receive the EFT reconciliation report which provides details of each EFT refund sent to the tax agent's or BAS agent's nominated trust account).
2. On Demand Report - allows for the request of a specific report to be generated. The following reports can be requested On Demand/ad-hoc basis:
- Activity Statement Client - provides tax practitioners with information about their client's Activity Statement lodgments.
- Activity Statement Lodgment - provides tax practitioners with information about their client's Activity Statement lodgments and relevant Document Identification number [DIN] information.
- List Income Tax Return - provides tax practitioners with information about their client's income tax lodgments.
3. Get Report - allows the tax practitioner to retrieve a generated report that can include either a subscribed, compulsory or on demand report. In addition to the subscribed and on demand reports, the following compulsory report can be retrieved:
- Income Tax Lodgment Performance Report - provides tax practitioners with statistical information regarding the status and number of tax lodgments lodged during a lodgment period. The generation of these reports to tax practitioners will be initiated by the ATO periodically or at specific points in time when required. Tax practitioners do not have the choice to opt-out from receiving compulsory reports.
The web service messages are exchanged using the ATO ebMS3 protocol with the message payload constructed using the XBRL format.
TPCMR (2014)
Name | Version number | Status | Size | Published date |
---|---|---|---|---|
ATO TPCMR 2014 Business Implementation Guide (DOCX) | 1.2 | Final | 423KB | 20 July 2023 |
ATO TPCMR 2014 Package v1.12 Contents (DOCX) | 1.12 | Final | 231KB | 20 June 2024 |
ATO TPCMR 2014 Package v1.12 (ZIP) | 1.12 | Final | 827KB | 20 June 2024 |
SBR ebMS3 webservices artefacts
The Australian Taxation Office has developed an ebMS/AS4 implementation extending on the SBR initiative to simplify Business to Government reporting obligations and aligning with the messaging standards chosen for Superannuation Reform. While this implementation replaces the existing SBR message wrapping, it does not replace the eXtensible Business Reporting Language (XBRL) body provided in SBR web services, in fact the ATO implementation of the new system reuses the existing SBR XBRL message body for the majority of the services provided in the new format.
The following information describes how to implement web services consuming the ebMS3/AS4 messaging standard (SBR ebMS3).
- SBR ebMS3 web service implementation guide
The SBR ebMS3 web service implementation guide (WIG) describes common technical components and services that are re-used by all business services. The common services include whole of government gateways that expose services and supports the protocol for message exchange, standard message types, standard response time service levels, standard message structures, a security token service, and a standardised approach to handling business error conditions and transport exceptions.
There is a separate SBR Core Services WIG. - SBR ebMS3 software developer kit guide
The SBR ebMS3 software developer kit (SDK) guide identifies the key components and functionality that comprise the SDK solution. Some of these components are re-used from the previously released SBR Core Services SDK and hence the reader is pointed to the reference for existing documentation. For the new components, this document will outline the usage details and the API specification (where applicable).
Name | Version number | Status | Size | Published date |
---|---|---|---|---|
SBR ebMS3 Web Services Implementation-Guide (DOCX) | 1.7 | Final | 1.96MB | 14 December 2017 |
SBR ebMS3 SDK Developer Guide (DOCX) | 1.4 | Final | 1.87MB | 13 August 2020 |
SBR Core Service webservice
The web services components that are available online include:
- Web Services Description Language (WSDL) files
- Web Services Implementation Guide (WIG)
- Web services policy files
- Security token message samples
Name | Version number | Type | Size | Published date |
---|---|---|---|---|
SBR web services implementation guide (WIG) | 2.2d | 1.5MB | 18 February 2016 | |
SBR web services description language (Java) | NA | Java | 12.1 KB | 28 March 2013 |
SBR web services description language (dotnet) | NA | DOTNET | 10.2 KB | 28 March 2013 |