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 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.

Employee Withholding and Super Notification Details (EMPWTHSPRDTL)

Employee Withholding and Super Notification Details (EMPWTHSPRDTL) service allow employers (or their business intermediaries) to retrieve their employees’ TFN declaration and choice of super fund details which have been submitted via ATO Online.

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.

EMPWTHSPRDTL.0001 (2018)

This service has been deactivated and replaced by EMPWTHSPRDTL.0002 (2018)

EMPWTHSPRDTL.0002 (2018)

Name Version number Status Size Published date
ATO EMPWTHSPRDTL.0002 2018 Package v1.0 Contents.docx 1.0 Final 236KB 06 December 2018
ATO EMPWTHSPRDTL.0002 2018 Package v1.0.zip 1.0 Final 712KB 06 December 2018

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)

Name Version Number Status Size Published date
ATO PS.0005.2018 Package v1.0 Contents.docx 1.0 Final 229KB 17 May 2018
ATO PS.0005.2018 Package v1.0.zip 1.0 Final 14.0MB 17 May 2018

PS.0004 (2017)

Name Version Number Status Size 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.

DSPs will need to demonstrate that they have tested against both the submit and update service actions.

PAYEVNT.0003 (2018)

Name Version number Status Size Published date
ATO PAYEVNT.0003 2018 Package v1.3 Contents.docx 1.3 Final 243KB 18 April 2019
ATO PAYEVNT.0003 2018 Package v1.3.zip 1.3 Final 1.8MB 18 April 2019

PAYEVNT.0002 (2017) - Deactivated

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.0005 2019 and 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.0005 (2019)

Name Version number Status Size Published date

ATO TFND.0005 2019 Package v1.0 Contents.docx

 1.0 Final 226KB 18 April 2019
ATO TFND.0005 2019 Package v1.0.zip 1.0 Final 854KB 18 April 2019

 

TFND.0004 (2017)

Name Version number Status Size Published date
ATO TFND.0004 2017 Package v1.0 Contents.docx 1.0 Final 234KB 7 February 2019
ATO TFND.0004 2017 Package v1.0.zip 1.0 Final 784KB 7 February 2019

TFND.0003 (2016)

Name Version number Status Size Published date
ATO TFND.0003 2016 Package v1.2 Contents.docx 1.2 Final 241KB 18 October 2018
ATO TFND.0003 2016 Package v1.2.zip 1.2 Final 564KB 18 October 2018

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 Status Size 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

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.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 PDF 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: 
3 October 2019
Page ID: 
257