This page contains links to information and artefacts for Software Developers who have or are interested in developing web services that enable a business or their registered intermediary to fulfil their income tax obligations to the ATO.
- Individual income tax returns (IITR)
The ATO currently offers IITR services from 2014 onward. IITR is only available via the SBR ebMS3 platform.
- Non-individual Income Tax Returns (NITR)
The ATO offers NITR web services from 2011 onwards on the SBR Core Services platform. 2014 services onward are also available on the SBR ebMS3 platform.
Shared schedule information
The 2014 and future services for IITR and NITR share one schedule - Capital Gains Tax Schedule (CGTS).
2015 and future services for IITR and NITR share two additional schedules - Payment Summary Schedule (PSS) and Rental Schedule (RS).
Shared schedule artefacts can be found within each relevant zip file for ease of use.
ATO Common Information Artefacts
The ATO has a number of documents that are common across all services and need to be read with any service specific artefacts.
Common artefacts are:
- ATO Service Registry (SR)
The Service Registry lists all services and related messages offered over SBR Core Services and ebMS3 platforms. It also has dates when services are expected to be deployed into the External Vendor Test Environment (EVTE) and Production (PROD).
- ATO Service Characteristics Risk Chart
The Characteristics Risk Chart describes the way in which the ATO classifies APIs. This artefact needs to be read in conjunction with the Service Registry in order to understand how Risk Profiles have been allocated against Service Actions.
- ATO Service Support Versioning Strategy
The ATO Service Support Versioning Support PowerPoint outlines key concepts, life cycle states of a service, principles for supporting versions and the decommissioning process.
- SBR ATO Site and Document Maps (SDMPS)
The SBR ATO Site and Document Maps (SDMPS) spreadsheet contains site maps for ATO content on sbr.gov.au and SBR Share File (with links where possible), ATO Acronyms/Initialisms with their full form name and the ATO High Level Document Map.
- ATO Taxonomy Architecture and Naming Conventions
The ATO Taxonomy Architecture and Naming Conventions document outlines the differences between ATO and SBR generated taxonomies, along with naming conventions for files.
- ATO Common Business Implementation Guide (cBIG)
The ATO Common Business Implementation Guide (cBIG) forms part of the broader suite of documents used by the ATO to describe the business context and client usage of the web services offered by the ATO through the SBR platform. The document also provides high level guidance and reference to additional documentation to assist software developers understand what is required at key points throughout the development lifecycle.
- ATO Common Message Implementation Guide (cMIG)
The ATO Common MIG (cMIG) forms part of the broader suite of documents used by the ATO to describe the way in which software developers must implement messages. In particular, it describes the ATO specific requirements to ensure those messages are both SBR and ATO compliant.
- ATO Message Repository (MR)
The ATO message repository (MR) contains the majority of ATO response messages. Some services have response messages packaged separately and these can be found within the service zip package.
- ATO Taxpayer Declaration Guide (TPDec)
This document provides guidance regarding the provision of taxpayer declarations in association with approved forms lodged to the ATO via SBR. It addresses the declaration to be given by the taxpayer to their tax agent prior to the Tax agents' submission of the approved form to the ATO. For further information about the declaration and signing statement made by a tax agent lodging via SBR refer to the ATO cMIG.
- ATO XML Schema Generation Algorithm
This document describes the algorithm used to generate XML Schemas from the Message Structure Table (MST) spreadsheet/s. This algorithm will be applied to services produced from May 2017 onwards.
- ATO Common Record Delimiter Validation Rules
This document describes the validation that is applied to any message received in the eCommerce Bulk format. These rules apply to messages received via the SBR2 platform or the ATO’s Bulk Data Exchange. The format is covered in the ATO Common Message Implementation Guide.
|Name||Version number||Status||Size||Published date|
|ATO Service Registry.xlsx||2.05||Living||502KB||2 November 2017|
|ATO Service Characteristic Risk Chart.ppt||1.0||Final||144KB||19 October 2017|
|ATO Service Support Versioning Strategy.docx||1.1||Final||486KB||31 August 2017|
|ATO Taxonomy Architecture and Naming Conventions.docx||1.0||Final||233KB||31 August 2017|
|SBR ATO Site and Document Maps.xlsx||2.0||Final||484KB||31 August 2017|
|ATO Common Business Implementation Guide.docx||0.1||Draft||766KB||10 December 2015|
|ATO Common Message Implementation Guide.docx||3.0||Final||2.48MB||15 September 2016|
|ATO Message Repository.zip||2.68||Living||305KB||16 November 2017|
|ATO Taxpayer Declaration Guide.docx||3.0||Final||290KB||21 September 2017|
|ATO XML Schema Generation Algorithm.docx||1.0||Final||261KB||31 August 2017|
|ATO Common Record Delimiter Validation Rules.xlsx||1.0||Final||56KB||15 June 2017|
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.5||Final||2.06MB||16 March 2017|
|SBR ebMS3 SDK Developer Guide.docx||1.3||Final||1.80MB||18 June 2015|
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)||12.1 KB||28 March 2013|
|SBR web services description language (dotnet)||10.2 KB||28 March 2013|
Last updated: 09 Mar 2017
Page ID: 40929