Lodgment Management is a sub-domain of Obligation Management (OBLMGT). This page contains information and artefacts for Digital Service Providers (DSPs) who have or are interested in developing web services that enable a business or their intermediary to manage their lodgment obligations to the ATO. The services described below are only deployed on the SBR ebMS3 platform.
For ease of use, services have been organised into the following business processes:
- Lodgment obligations – Allows users to notify the ATO that an income tax return is not necessary for a given year or into the future.
- Seek a ruling – Allows users to submit a request for a Private Ruling on a tax matter.
- Review lodgment history – Allows an agent to view the status of a single client's income tax lodgment history, by providing the lodgment status for the current tax year, previous three years history, the last year lodged, and up to 16 years history where the status is not lodged. A separate service is also available to access to list that includes expected due/overdue forms and payment dates, as well as lodgment history for Activity Statement, Income Tax and FBT returns.
- Lodgment progress and outcome – Allows users to view the progress of return(s)/lodgment(s), with a separate service allowing access to the outcome details for issued individual assessments and supporting validation of the ATO processing against what was lodged.
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.
Lodgment obligations
Service Name: Lodgment Not Necessary (LDGNN)
| Service Version | 0002.2021 |
| Service Actions | Submit – Allows for the submission of a Non Lodgment Advice (NLA) for Income Tax Returns or Taxable Payment Annual Reports where a return or report is not necessary for a given year or into the future. |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO LDGNN.0002 2021 Package v1.0 Contents.docx | 1.0 | Final | 208KB | 23 September 2021 |
| ATO LDGNN.0002 2021 Package v1.0.zip | 1.0 | Final | 669KB | 23 September 2021 |
Service Name: Client Update Return Not Necessary (CURNN)
| Service Version | 0002.2016 |
| Service Actions | Lodge (submit) – Allows an intermediary to notify the ATO if a client is no longer required to lodge a tax return for specified year/s (return not necessary – RNN) or from a specified year (further return not necessary – FRNN). |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO CURNN.0002 2016 Package v1.7 Contents.docx | 1.7 | Final | 220KB | 01 September 2022 |
| ATO CURNN.0002 2016 Package v1.7.zip | 1.7 | Final | 438KB | 01 September 2022 |
Service Name: Deferral (DFRL.0002 2018) DEPRECATED
- The DFRL.0002 version is deprecated and is no longer available to build against - product whitelisting is closed.
- The actual deactivation date can be found in the Service Registry.
- For those in the build phase that are about to enter in to or have starting testing in EVTE, please contact DPO for guidance.
Seek a ruling
Service Name: Private Ruling (PR)
| Service Version | 0001.2015 |
| Service Actions | Submit — Allows for submission of a Private Ruling (PR) application behalf of a client or a group of clients along with up to six unstructured attachments (each up to 10MB in size) to support the application. |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO PR.0001 2015 Business Implementation Guide.docx | 1.1 | Final | 251KB | 16 November 2017 |
| ATO PR.0001 2015 Package v1.4 Contents.docx | 1.4 | Final | 244KB | 20 September 2018 |
| ATO PR.0001 2015 Package v1.4.zip | 1.4 | Final | 315KB | 20 September 2018 |
Review lodgment history
Service Name: Income Tax Lodgment Status (ITLDGSTS)
| Service Version | 0001.2014 |
| Service Action | List – Allows a Tax Agent to enquire into the status of a single client’s income tax lodgment history. The income tax history returned will show the lodgment status for the current tax year and previous three years history, the last year lodged and up to 16 years history where the status is not lodged. |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO ITLDGSTS.0001 2014 Business Implementation Guide.docx | 1.0 | Final | 224KB | 30 July 2015 |
| ATO ITLDGSTS.0001 2014 Package v1.4 Contents.docx | 1.4 | Final | 220KB | 7 December 2017 |
| ATO ITLDGSTS.0001 2014 Package v1.4.zip | 1.4 | Final | 477KB | 7 December 2017 |
Lodgment progress and outcome
Service Name: Lodgment Progress (LDGPROG)
| Service Version | 0001.2017 |
| Service Action | List – Provides details of the progress of an income tax return(s)/lodgment(s). |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO LDGPROG 0001.2017 Business Implementation Guide | 1.2 | Final | 257KB | 19 March 2020 |
| ATO LDGPROG.0001 2017 Package v.1.1 Contents.docx | 1.1 | Final | 196KB | 21 May 2020 |
| ATO LDGPROG.0001 2017 Package v1.1.zip | 1.1 | Final | 1.1MB | 21 May 2020 |
Service Name: Lodgment (LDG)
| Service Version | 2023 |
| Service Actions |
List – Provide tax agents, business intermediaries and business a list of the client’s expected and received lodgments. The information returned includes, but is not limited to: Financial Year, Lodgment Status, Period Status, Form types, Lodgment due dates, Payment Due Dates and Lodgment Received Dates. Get – Allows tax agents to retrieve the details of their clients processed income tax returns from ATO systems. The 2019 Lodgment service includes processed individual income tax returns for 2017 and 2019 onwards. 2019 includes schedule details for deductions. 2020 onwards include schedule details for deductions, income, capital gains tax, non-resident foreign income and multi-property rent. |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| ATO LDG 2023 Package v0.1 Contents.docx | 0.1 | Draft | 219KB | 19 January 2023 |
| ATO LDG 2023 Package v0.1.zip | 0.1 | Draft | 1.99MB | 19 January 2023 |
| Service Version |
0002.2019 |
| Service Actions |
Get – Provides tax agents, business intermediaries and business with visibility of lodged income tax returns as recorded in ATO systems. This interaction will only provide visibility of processed income tax returns. The 2019 version includes 2017, 2019, 2020, 2021 and 2022 processed individual income tax returns, including deductions associated form information for 2019 and deductions, income details, capital gains tax, non-resident foreign income and rental properties associated form information for 2020 |
| Name | Version number | Status | Size | Published date |
|---|---|---|---|---|
| 1.6 | Final | 214KB | 13 October 2022 | |
| 1.6 | Final | 1.09MB | 13 October 2022 | |
|
ATO LDG.0002 2019 Business Implementation Guide Note: This business implementation guide contains information for LDG Get service action only. A new implementation guide will be released in future to include information for both LDG List and Get service actions. |
1.3 | Final | 165KB | 17 February 2022 |
Service Name: Assessment (ASMT)
| Service Version |
0003.2018 |
| Service Actions |
List – Returns a list of issued individual assessments for the nominated client, account and/or periods. Get – For a specific assessment, this interaction will return the assessment details that determined the assessment outcome, and details of fields that have been adjusted. In addition to the 2016 and 2017 financial year, assessment outcome details for the 2018 and 2019 financial years (including early lodgers for the 2020 financial year) are returned. |
| Name | Version number | Status | Size | Published dated |
|---|---|---|---|---|
| 1.1 | Final | 243KB | 26 March 2020 | |
| ATO ASMT.0003 2018 Package v1.6 Contents.docx | 1.6 | Final | 231KB | 20 May 2021 |
| ATO ASMT.0003 2018 Package v1.6.zip | 1.6 | Final | 947KB | 20 May 2021 |
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 |