Employer Obligations (EO)


This page contains information and artefacts for Software Developers who have or are interested in developing web services that enable an Employer to fulfil their reporting obligations to the ATO.

The web services deployed to date are:

The ATO Common Message Implementation Guide (cMIG) needs to be read in conjunction with the artefacts within each package.

The ATO Service Registry provides information on the relationships between services/messages, business applicability (the year/s active), along with channel and environment deployment information.

Employee Withholding (EMPWTH)

The Employee Withholding (EMPWTH) and Employee Withholding Outcome (EMPWTHOC) services have been removed after extensive consultation with industry resulting in deferral of the employee commencement service through myGov. Progress on this change will be available at Softwaredevelopers.ato.gov.au/STP

Payment Summaries (PS)

Whilst the ATO has multiple versions of the PS service in EVTE and Production via the SBR Core Services platform, it is recommended any new Software Developers that are looking to consume PS web services develop from the most current version. Information on deprecation dates and deactivation can be found in the ATO Service Registry.

PS.0005 (2018)

NameVersion NumberStatusSizePublished date
ATO PS.0005.2018 Package v0.1 Contents.docx0.1Draft230KB20 July 2017
ATO PS.0005.2018 Package v0.1.zip0.1Draft178KB20 July 2017

PS.0004 (2017)

Name Version Number StatusSize Published date
ATO PS.0004 2017 Package v1.0 Contents.docx 1.0 Final 331KB 20 April 2017
ATO PS.0004 2017 Package v1.0.zip 1.0 Final 614KB 20 April 2017

PS.0002 (2012) and PS.0003 (2013) DEPRECATED

  • The PS.0002 and PS.0003 versions are deprecated and are no longer available to build against - product whitelisting is closed.
  • The actual deactivation dates 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 your account manager for guidance.

Payroll Event (PAYEVNT)

Payroll Event (PAYEVNT) services provide business or their registered intermediary the ability to report payroll run information to the ATO as required by Single Touch Payroll (STP).

The web service messages are exchanged using the ATO ebMS3 protocol with the message payload constructed using the XML format.  The SBR AU Dictionary has been used to define the elements within the messages.

PAYEVNT.0002 (2017)

Name Version number StatusSize Published date
ATO PAYEVNT.0002 2017 Package v1.1 Contents.docx1.1Final251KB19 October 2017
ATO PAYEVNT.0002 2017 Package v1.1.zip1.1Final1.0MB19 October 2017

PAYEVNT.0001 (2016) DEPRECATED

  • The PAYEVNT.0001 2016 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 your account manager for guidance.

Tax File Number Declaration (TFND)

The Tax File Number Declaration (TFND) allows for the lodgment of a tax file number declaration/s by an employer or their intermediary.

  • The TFND.0004 2017 web service messages are exchanged using the ATO ebMS3 protocol with the message payload constructed using the XML format.
  • The TFND.0003 2016 web service messages are exchanged using the SBR Core Services protocol with the message payload constructed using the XBRL format. This Service has not been deprecated in line with the Service Support Versioning Strategy until further consultation has occurred.

TFND.0004 (2017)

Name Version number StatusSize Published date
ATO TFND.0004 2017 Package v0.1 Contents.docx0.1Draft 230KB 27 July 2017
ATO TFND.0004 2017 Package v0.1.zip0.1Draft 784KB 27 July 2017

TFND.0003 (2016)

NameVersion numberStatusSizePublished date
ATO TFND.0003 2016 Package v1.0 Contents.docx1.0Final239KB11 May 2017
ATO TFND.0003 2016 Package v1.0.zip1.0Final439KB11 May 2017

TFND.0001 (2010) and TFND.0002 (2015) DEPRECATED

  • The TFND.0001 and TFND.0002 versions are deprecated and are no longer available to build against - product whitelisting is closed.
  • The actual deactivation dates 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 your account manager for guidance.

Taxable Payments Annual Report (TPAR)

The SBR ATO Taxable Payments Annual Report (TPAR.0002 2017) package and content note, which included new data elements for reporting of government grants and payments, has been removed and is not offered via the SBR platforms. Any software developer interested in consuming the taxable payments annual report for reporting of government grants and payments through the SBR ebMS3 channel is requested to contact the SBR Service Desk.

Note:

    Reporting of government grants and payments has been incorporated in the flat file format and will be able to be lodged via the file  transfer facility in the ATO portals.

    The flat file format must comply with the Electronic Reporting Specification – taxable payments annual report version 2.0.0 available on the ATO software developers website at http://softwaredevelopers.ato.gov.au/TPARspecification.

    Reporting commences on 1 July 2017, with the first annual report due by 28 August 2018. For more information about Taxable payments reporting for government entities refer to www.ato.gov.au/tparGov .

TPAR.0001 2013 service is currently in EVTE and Production on the SBR Core Services platform only.  The service caters for lodgments back to the 2012/13 financial year and forward - for the building and construction industry.

TPAR.0001 (2013)

Name Version number StatusSize Published date
ATO TPAR.0001 2013 Package v2.1 Contents.docx 2.1 Final 201KB 26 March 2015
ATO TPAR.0001 2013 Package v2.1.zip 2.1 Final 567KB 26 March 2015

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.
NameVersion numberStatusSizePublished date
ATO Service Registry.xlsx2.05Living502KB2 November 2017
ATO Service Characteristic Risk Chart.ppt1.0Final144KB19 October 2017
ATO Service Support Versioning Strategy.docx1.1Final486KB31 August 2017
ATO Taxonomy Architecture and Naming Conventions.docx1.0Final233KB 31 August 2017
SBR ATO Site and Document Maps.xlsx2.0Final484KB31 August 2017
ATO Common Business Implementation Guide.docx0.1Draft766KB10 December 2015
ATO Common Message Implementation Guide.docx3.0Final2.48MB15 September 2016
ATO Message Repository.zip2.68Living305KB16 November 2017
ATO Taxpayer Declaration Guide.docx3.0Final290KB21 September 2017
ATO XML Schema Generation Algorithm.docx1.0Final261KB31 August 2017
ATO Common Record Delimiter Validation Rules.xlsx1.0Final56KB15 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).
NameVersion numberStatusSizePublished date
SBR ebMS3 Web Services Implementation Guide.docx1.5Final2.06MB16 March 2017
SBR ebMS3 SDK Developer Guide.docx1.3Final1.80MB18 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
NameVersion numberTypeSizePublished date
SBR web services implementation guide (WIG)2.2dPDF1.5MB18 February 2016
SBR web services description language (Java)  12.1 KB28 March 2013
SBR web services description language (dotnet)  10.2 KB28 March 2013

Last updated: 19 Oct 2017
Page ID: 40940