single touch payroll dsp guide to navigating the sbr ... · pdf fileunclassified –...
TRANSCRIPT
Single Touch Payroll
DSP guide to navigating the SBR technical artefacts
Digital Wholesale Services, Australian Taxation Office, December 2017
Objectives • This document is intended for digital services providers (DSPs) who are considering Single Touch Payroll (STP) services, but
who may have had limited exposure to the Standard Business Reporting (SBR) whole of government initiative and the ATO’s implementation through the Digital Wholesale Services (DWS) branch.
• DWS supports the practitioner lodgment service (PLS), SuperStream and STP using a common SBR/eCommerce platform. This scope means there is a large volume of documentation and development artefacts, not all of which are relevant to STP or to the implementation approach a DSP is considering. This document outlines the different technical roles/pathways a DSP can take in the STP ecosystem and the development artefacts that are relevant to each pathway.
• SBR training material which outlines key technical information is available.
Contents Page • Actors, products and implementation approaches in the STP ecosystem - 3
• Message layers and information sources - 4
• Pathways to an STP enabled solution - 5
• Further detail on roles and pathways - 6
• Artefact logical maps: – Pathway 1: Develop a basic STP service - 7
– Pathway 2: Develop an STP service into a product that may be whitelisted - 8
– Pathway 3: Develop a complete STP solution - 9
– Pathway 4: Develop the ebMS3 component -10
– Summary description of artefacts -11
• Artefact locations – sbr.gov.au -12
– SBR Sharefile repository: SDKs and more -13
• Keeping up to date - artefact releases & delivery schedules -14
2
Objectives and contents
UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
Payroll Bureau ebMS Software developer
Payroll Software
ATO approved CAA2
Online Service Provider Employer
ebMS API
Gateway
Legacy Payroll Software
ebMS Embedded
client
Entity that is required to submit STP
reports to the ATO.
Entity that facilitate the transfer of
electronic data messages that are compliant
with ebMS/AS4 standards.
Entity that processes payroll on behalf of
employers.
Entity that is registered with
the TPB to provide tax practitioner
services. Sends STP reports to
the ATO.
Registered Agent TAX/BAS/Payroll
Entity that builds, tests and develops ebMS
compliant software
products to sell. Product is
whitelisted by ATO.
Entity that builds, tests and develops payroll
software products to sell or for internal consumption.
Entity that has gone through the approval
process to become an
approved ATO online service
provider.
ATO whitelisted ebMS Software..
Product is installed into
customers infrastructure.
ATO whitelisted ebMS Software.
Product connects customer
infrastructure to gateway.
Commercial Payroll
software3 that has been
designed to support STP reporting.
Commercial Payroll software
that has not been redesigned to support STP
reporting.
Cloud solution
On Premise/ desktop
Gateway portal Gateway server
On premise infrastructure that a gateway
uses to send electronic data
messages to the ATO.
An online service offering
of gateways that allow employers to upload data
to be transformed
and send to the relevant party.
Implementation approach is in
the cloud.
Implementation approach is on
premise.
Software products Implementation approaches
Actors
There are a range of actors, products and implementation approaches in the STP ecosystem … providing choice to DSPs and employers on STP enablement.
A Digital Service Provider is anyone who develops or provides digital services that assist the Australian community (and business) to meet their tax and super obligations and may include any of the following actors
1. A software developer (SWD) is any person or organisation that technically develops services for internal or external use. A Payroll SWD does so for payroll 2. Cloud Software Authentication and Authorisation - authorisation model that enables businesses to notify an agency of their software provider, so the business can transact
securely with the Whole of Government (WofG) from the cloud 3. Eg Commercial off the shelf software (COTS)
Payroll Software developer1
DSPs
3 UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
Secure Token Service - Vanguard Access Manager - ATO
ebMS3
Signing
SBR Platform Suite
XML Message
Business Management System
(BMS)
MST Validation Rules
STP Business Implementation Guide (BIG)
For the ATO to receive STP data, four key layers need to be understood and in place. There could be one or several actors involved in delivering the completed message to the ATO.
Info
rmatio
n so
urce
s M
ess
age
Lay
ers
Transform
Wrap
Sign
Send
ATO Endpoints for EVTE and PROD
4 UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
Baseline Understanding STP
requirements
Pathway 1 Develop basic STP
service
Pathway 2 Develop an STP
service into a product that may be whitelisted
Pathway 3 Develop complete
STP solution
Pathway 4 Develop ebMS3
component
Examples of the approach the payroll software developer may be taking
• Payroll software developer only using third party components to enable your solution
• Payroll software developer creating STP XML but using third party services to create wrapper /conform and send message to ATO1
• Payroll software developer creating Conforming XML and wrapper but using third party service/ component to send message to ATO1
• Payroll software developer creating Conforming XML and wrapper and building own ebMS3 capability to sign and send message to ATO1
• Transform, wrap and send service providers
• Software developer producing an ebMS3 client for use by third parties
• Parties interested in becoming a Gateway
Business information you will need
• STP Business Implementation Guide
• Scenarios • AUSkey and access
manager
• STP Business Implementation Guide
• Scenarios
• STP Business Implementation Guide
• Scenarios
• STP Business Implementation Guide
• Scenarios • AUSkey and Access
manager.
• STP Business Implementation Guide
• Scenarios • AUSkey and Access
manager.
ATO Technical artefacts you will need
• None • STP Program specific • Selected SBR • Support
• STP Program specific • Selected SBR • Conformance testing • Support
• STP Program specific • SBR platform • Conformance testing • Support
• SBR platform • Support
Other ATO matters to be considered
• Operational Framework (to be confirmed)
• CAA – online service provider kit.
• Operational Framework (to be confirmed)
• Operational Framework (to be confirmed)
• Operational Framework (to be confirmed)
• CAA – online service provider kit.
• Operational Framework (to be confirmed)
• CAA – online service provider kit.
Other information you will need
• Guidance from your service providers
• Guidance from your service providers
• Guidance from your service providers
1. Component could be a client, “API” or cloud service
These layers mean there are different pathways for developers to achieve an STP enabled solution
5 UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
Payroll Software Developer
Payroll Bureau
ebMS Software developer
ATO approved CAA Online Service Provider
Employer
Gateway
Registered Agent BAS provider
• You are building ebMS3 capability into your own inhouse software – See payroll software developer below. • Your existing payroll solution provider is looking after upgrades to your software and how your STP reports
will get to the ATO. • You need to integrate the payroll solution ebMS3 capability and need to know how to sign messages to ATO.
• Your existing software will be upgraded to allow you to process payroll reports for your clients and preparing the STP reports for the ATO.
• You are extending your existing ebMS3 capability to transform, wrap and sign the message to the ATO and looking at how your business model will fit the STP requirements.
• You are upgrading your existing payroll software to include ebMS3 capability to also transform, wrap and sign the message to the ATO.
• Your existing Payroll solutions will be upgraded by your suppliers and you need to understand the business rules for STP and the business appointments you may need to set up.
• You are upgrading your existing payroll software to transform (create XML) and are looking at outsourcing ebMS3 capability.
• You are producing an ebMS3 client for use by third parties and plan to whitelist the product for STP reports. • You are interested in becoming a Gateway or sending service provider. See Gateway above.
• You are upgrading your payroll software and build your own ebMS3 capability.
• You are upgrading your payroll software and are deciding whether buy, build or outsource ebMS3 capability.
• You are upgrading your payroll software and are looking at purchasing ebMS3 capability.
• You are upgrading your payroll software and are looking at outsourcing ebMS3 capability.
• You are an existing ATO approved cloud service provider and are intending to support STP services.
Pathway
B
B
2
3
B
3
3
1
2
3
B1
2
2
Your path will vary depending on your role in the ecosystem...further examples
B1 Baseline pathway 6 UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
Pathway 1: ATO XML Message (no wrappers) and not a registered product (ie. handing the XML to the next relay point) ATO High Level Logical Artefact Map: Wholesale services through SBR UNCLASSIFIED Version 0.1
Updated: 17.11.2017
Platform Integration Service Development
Functional Design
Build
High Level Design
Test
Support/Reference
Single Touch Payroll, payroll reporting: Business Implementation Guide (STP BIG)
Common Business Implementation Guide (cBIG)
ATO PAYEVNT 2018 Package vn.n Content
ATO PAYEVNT.0003 2018 Message Structure Table
ATO PAYEVNT.0003 2018 Submit Validation Rules
ATO PAYEVNT 2018 C# Rule Implementation
ATO Service Registry
ATO Message Repository (MR)
Authentication Integration
ATO PAYEVNT 2018 Contracts ATO PAYEVNT.0003 2018
Message Repository
ATO PAYEVNTEMP.0003 2018 Submit Validation Rules
ATO PAYEVNTEMP.0003 2018 Update Validation Rules
ATO PAYEVNT.0003 2018 Update Validation Rules
ATO PAYEVNTEMP.0003 2018 Message Structure Table
x 2
5 6
Single Touch Payroll Business Scenarios vn.n
B Single Touch Payroll
reporting structure vn.n
R
1
2
4 4
5 5 5 5
9 15
Technical Design
Business Design
ATO Taxonomy Architecture and Naming Conventions
Artefacts and Location 1
Site and document maps
2 Release Calendar/Notes
5
Pending!
ATO XML Schema Generation
3
Service Support Versioning Strategy
6
11
ATO Message Structure Guide
7
New!
ATO Validation and Rule Expression Guide
8
New!
12
13
ATO Common Service Implementation Guide
4
STP Technical Change Roadmap
8
New!
7 SBR.gov.au (see SBR ATO Site and Document map – refer page 12) SBR share file (see SBR ATO Site and Document map – refer page 13) Softwaredevelopers.ato.gov.au/STPdocumentlibrary
ATO Operational Framework ?
ATO Service Characteristics Risk Chart
12 13
Pending!
Pathway 2: ATO XML Message into a product that may be whitelisted (no ebMS3 Client or Authentication [VANguard] – uses Integrator)
ATO High Level Logical Artefact Map: Wholesale services through SBR UNCLASSIFIED Version 0.1 Updated: 17.11.2017
Platform Integration Service Development
Functional Design
Build
High Level Design
Test
Support/Reference
Single Touch Payroll, payroll reporting: Business Implementation Guide (STP BIG)
Common Business Implementation Guide (cBIG)
ATO Common Message Implementation Guide
ATO PAYEVNT 2018 Package vn.n Content
ATO PAYEVNT.0002 2017 Conformance Suite Package vn.n Contents
ATO PAYEVNT.0003 2018 Conformance Suite
ATO PAYEVNT.0003 2018 Cover Note
ATO PAYEVNT.0003 2018 Message Structure Table
ATO PAYEVNT.0003 2018 Submit Validation Rules
ATO PAYEVNT.0003 2018 Conformance Suite Payloads
ATO PAYEVNT 2018 C# Rule Implementation
ATO Service Registry
Conformance Suite Key Store
AUSAUS
ATO Message Repository (MR)
Authentication Integration
ATO PAYEVNT 2018 Contracts ATO PAYEVNT.0003 2018
Message Repository
ATO PAYEVNTEMP.0003 2018 Submit Validation Rules
ATO PAYEVNTEMP.0003 2018 Update Validation Rules
ATO PAYEVNT.0003 2018 Update Validation Rules
ATO PAYEVNTEMP.0003 2018 Message Structure Table
x 30
x 2
Payroll Event Data Definitions v1.0
Draft Data Definitions Update Event v0.2
Payroll Event Messaging Diagram v1.0
5 6
Single Touch Payroll Business Scenarios vn.n
B Single Touch Payroll
reporting structure vn.n
R
1
2 3
4 4
5 5 5 5
9 15
1
2 4
3
Technical Design
Business Design
ATO Taxonomy Architecture and Naming Conventions
Artefacts and Location 1
Site and document maps
2 Release Calendar/Notes
5
Pending!
ATO XML Schema Generation
3
SBR AU (definitional) Taxonomy
4
Service Support Versioning Strategy
6
ATO Operational Framework ?
ATO Common Record Delimiter Validation Rules
9
ATO Service Characteristics Risk Chart
12 11 13
ATO Message Structure Guide
7
New!
ATO Validation and Rule Expression Guide
8
New!
Pending!
Decommissioned!
2
12
13
Decommissioned! Decommissioned!
Decommissioned!
Decommissioned!
ATO Common Service Implementation Guide
4
STP Technical Change Roadmap
8
New!
8 SBR.gov.au (see SBR ATO Site and Document map – refer page 12) SBR share file (see SBR ATO Site and Document map – refer page 13) Softwaredevelopers.ato.gov.au/STPdocumentlibrary
Platform Integration Service Development
Functional Design
Build
High Level Design
Test
Support/Reference
Single Touch Payroll, payroll reporting: Business Implementation Guide (STP BIG)
Common Business Implementation Guide (cBIG)
SBR ebMS3 WIG
ATO Common Message Implementation Guide
ATO PAYEVNT 2018 Package vn.n Content
SBR ebMS3 SDK Guide
ATO PAYEVNT.0002 2017 Conformance Suite Package vn.n Contents
ATO PAYEVNT.0003 2018 Conformance Suite
ATO PAYEVNT.0003 2018 Cover Note
SBR ebMS3 Software Developer Guide (SDK) (.NET,
Java, C)
ATO PAYEVNT.0003 2018 Message Structure Table
ATO PAYEVNT.0003 2018 Submit Validation Rules
ATO PAYEVNT.0003 2018 Conformance Suite Payloads
SSL Certificates
ATO PAYEVNT 2018 C# Rule Implementation
ATO Service Registry
Conformance Suite Key Store
AUSAUS
ATO Message Repository (MR)
SBR Authentication Developer Kit (ADK)
Authentication Integration
ATO PAYEVNT 2018 Contracts ATO PAYEVNT.0003 2018
Message Repository
ATO PAYEVNTEMP.0003 2018 Submit Validation Rules
ATO PAYEVNTEMP.0003 2018 Update Validation Rules
ATO PAYEVNT.0003 2018 Update Validation Rules
ATO PAYEVNTEMP.0003 2018 Message Structure Table
x 30
x 2
Payroll Event Data Definitions v1.0
Draft Data Definitions Update Event v0.2
Payroll Event Messaging Diagram v1.0
ATO High Level Logical Artefact Map: Wholesale services through SBR UNCLASSIFIED Version 0.1 Updated: 17.11.2017
1
5 6
Single Touch Payroll Business Scenarios vn.n
B Single Touch Payroll
reporting structure vn.n
R
1
2 3
4 4
5 5 5 5
9 15
3
4
6
1
2 4
3
7
SBR Secure Token Service (STS) STS
Cloud Software Authentication and Authorisation SDK
5
Pathway 3: Complete STP Build (ebMS3 client and product that may be Whitelisted)
Technical Design
Business Design
8
ATO Taxonomy Architecture and Naming Conventions
Artefacts and Location 1
Site and document maps
2 Release Calendar/Notes
5
Pending!
ATO XML Schema Generation
3
SBR AU (definitional) Taxonomy
4
Service Support Versioning Strategy
6
ATO Operational Framework ?
ATO Common Record Delimiter Validation Rules
9
ATO Service Characteristics Risk Chart
12 11 13
ATO Message Structure Guide
7
New!
ATO Validation and Rule Expression Guide
8
New!
ATO SBR Physical End Points 10
New!
Pending!
Decommissioned!
2
Added!
New!
Added!
12
13
Decommissioned! Decommissioned!
Decommissioned!
Decommissioned!
ATO ebMS3 Implementation Guide
ATO Common Service Implementation Guide
2
4
STP Technical Change Roadmap
8
New!
9
Pending!
SBR.gov.au (see SBR ATO Site and Document map – refer page 12) SBR share file (see SBR ATO Site and Document map – refer page 13) Softwaredevelopers.ato.gov.au/STPdocumentlibrary
Pathway 4: ebMS3 Client with Authentication [VANguard]
ATO High Level Logical Artefact Map: Wholesale services through SBR UNCLASSIFIED Version 0.1 Updated: 17.11.2017
Platform Integration Service Development
Functional Design
Build
High Level Design
Test
Support/Reference
Single Touch Payroll, payroll reporting: Business Implementation Guide (STP BIG)
Common Business Implementation Guide (cBIG)
SBR ebMS3 WIG
SBR ebMS3 SDK Guide
SBR ebMS3 Software Developer Guide (SDK) (.NET,
Java, C) SSL Certificates
ATO Service Registry
Conformance Suite Key Store
AUSAUS
SBR Authentication Developer Kit (ADK)
Authentication Integration
1
5 6
1
3
4
6
7
SBR Secure Token Service (STS) STS
Cloud Software Authentication and Authorisation SDK
5
Technical Design
Business Design
8
Artefacts and Location 1
Site and document maps
2 Release Calendar/Notes
5
Pending!
ATO Operational Framework ?
ATO Common Record Delimiter Validation Rules
9
13
ATO SBR Physical End Points 10
New!
Pending!
Added!
New!
Added!
ATO ebMS3 Implementation Guide
ATO Common Service Implementation Guide
2
4
10 SBR.gov.au (see SBR ATO Site and Document map – refer page 12) SBR share file (see SBR ATO Site and Document map – refer page 13) Softwaredevelopers.ato.gov.au/STPdocumentlibrary
ATO High Level Logical Artefact Map: Wholesale services through SBR UNCLASSIFIED Version 0.1 Updated: 17.11.2017
The information below describes the artefacts outlined in the previous four slides. Numeric locator descriptions
SR: Contains service and message configuration data needed to interact with the ATO. This is a critical artefact in order to understand the relationships of messages to services, formats and deployment platforms. PCN: Documents the contents of a service/suite package zip, the status of the artefacts, limited change history and key issues (essentially a high level release note).
3
1 3
4
MST(s): Defines the basic technical attributes and construct of a given message (contract schema). Relevant associated business data is also included to facilitate the end user to understand requirements at an elemental level.
cMIG: Describes the way to implement messages. In particular, it describes the ATO specific requirements or deviations from the base platform/s functionality. It is a stand alone document that forms part of the broader suite of artefacts that should be referenced for a service/suite. The cMIG has been deconstructed into smaller reference documents. Deletion is scheduled for 14.12.2017.
VR(s): Defines the validation rules for a given message (contract schema), along with links to error codes. These artefact s are a sub-set of the technical (XML) Message Repository - containing all messages for the ATO. These are linked to their corresponding technical rule implementations (Schematron and/or C#).
2
3
1
4
SBR ebMS3 WIG: Describes common technical components and services that are re-used by all business services, with messaging based on the ebMS3 standard and AS4 Conformance Profile.
TPDec: 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.
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 platforms. This is the business equivalent of the previous cMIG (refer further below).
SBR Core Services WIG: Describes common technical components and services that are re-used by all business services on this platform.
Service BIG: Describes the business context and client usage of particular web services or a suite of services offered by the ATO through the SBR platforms.
2 SBR Core Services WSDL: Describes the service, the information exchanged and the technical protocols used for the exchange.
SBR ebMS3 SDK Guide: Identifies the key components of the SDK solution. Some of these components are re-used from the previously released SBR Core Services SDK. For new components, this document will outline the usage details and the API specification (where applicable).
3
1
4
5
XBRL API: Provides functionality for creating, validating, and consuming XBRL business documents.
Sample contract schemas: Provided where test instances are in a later delivery cycle in order to show how an instance may look.
7
8
6
9
14 SSL Certificates: Contains SSL certificates that can be used for the various SBR environment endpoints.
Contract Schemas: Service/Suite specific schemas/message contracts in the formats of XBRL, XML or JSON.
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.
Rules - Schematron: Provides the technical consumable VRs in Schematron for legacy implementations.
15 Rules – C#: Provides the technical consumable VRs in C# for new implementations.
4
Artefacts and location: Contains links to artefact packages/documents and a short change description.
Site and Document Maps: Contains site and document information. 3
Conformance PCN: Detailing artefacts within the package, their status, history and any known issues.
Conformance CN: Detailing the changes from prior implementations and known defects. The CN has been deprecated as the PCN should be the source of contents, changes and issues. The CN will be removed when new packages are done from 01.02.2018.
Conformance Test Cases: Defines the test cases used to self-certify against for a given service.
Test instances: Instance documents for use in self-certification testing.
2 1
3
4 Conformance Key Store: Containing AUSkeys for a SWD to use when testing their product.
SBR Core Services SDK: Contains reference client showing how to call the Keystore and Vanguard with a UI.
SBR ebMS3 SDK: Contains reference client showing how to call the Keystore and Vanguard (without a UI); the embeddable client which allows ebMS3 base communication.
Release Calendar/Notes: Provides a visual summary of expected services and environment deployment dates for a given period and release information.
Pending!
2
ATO Service Characteristics Risk Chart: Describes the way in which the ATO classifies wholesale service actions and needs to be read in conjunction with the Service Registry.
Service Versioning: Outlines the endorsed strategy for life cycle states of a service, principles for supporting versions and the decommissioning process.
1
2
5
ATO XML Schema Generation: Describes the algorithm that the ATO uses to generate XML schemas from Message Structure metadata.
6
SBR AU (definitional) Taxonomy: Collection of items (data elements) that may be required to be reported by business to government agencies.
7
5
ATO ebMS3 IG: Describes the ATOs implementation of the SBR ebMS3 WIG. This information was previously found in the cMIG and has been updated with a new pattern. Publication is scheduled for 14.12.2017.
6
Deleted!
7
ATO Common Service Implementation Guide (SIG): Describes the various implementation models that different consumers may adopt and the technical artefacts needed for a particular consumer lens. Publication is scheduled for 14.12.2017.
13
11
12
10
Service MR: Contains the Service/Suite ATO response messages.
Cloud Software Authentication and Authorisation SDK: Outlines the steps a DSP needs to perform to become CAA certified.
SBR Authentication Developer Kit (ADK): Contains language specific SDKs to implement the Secure Token Service (STS) to connect to VANguard.
SBR Secure Token Service (STS) SDK: Contains information to implement the Secure Token Service (STS) to connect to VANguard without using the supplied SDK (from the WIGs).
Added!
Added!
New!
Pending!
Pending!
2
ATO Taxonomy Architecture: Defines the ATO generated XBRL taxonomy architecture, naming conventions of ATO schemas (for supported formats) and linkbases where the format is XBRL.
ATO Validation Rule Expression Guide: Describes the ATO validations and structured rule expressions (previously in the cMIG)
ATO Message Structure Guide: Describes the data within the MSTs (previously in the cMIG).
ATO Common Record Delimiter Rules: Describes the validation that is applied to any message received in the eCommerce Bulk format.
8
9
10 ATO SBR Physical End Points: Defines the physical end points for both SBR platforms (along with EVTE and PROD) and STS (VANguard) [previously in the WIGs and cMIG].
ATO Operational Framework: Describes in detail the implementation of the operational framework and what DSPs need to do.
12
11
New!
Pending! New!
New!
Fun
ctio
nal
D
esi
gn
Bu
ild
Hig
h L
eve
l D
esi
gn
Test
Su
pp
ort
8 STP Technical Change Roadmap: scheduled technical changes and the technical changes still being impact assessed and/or under industry consultation to achieve the business design represented in the Service BIG
New!
11 13
The SBR website contains a number of key artefacts required for STP enablement. The below diagram is a snapshot of part of the SBR ATO Site and Document Map which is located via the ATO common artefacts and reference documents page on sbr.gov.au and provides hyperlinks to all the indicated artefacts.
Contains artefacts that are relevant to STP enablement. Items marked with green boxes in the Pathways diagrams are located here
SBR Developer Tools
SBR Core Services
web service artefacts
SBR ebMS3
web service artefacts
• SBR Core Services WIG • SBR ebMS3 WIGAustralian Taxation Office
(ATO)
• SBR WSDL (java)• SBR ebMS3 SDK developer
guide• Artefacts and Location • ATO Physical Endpoints • Artefacts and Location
• SBR WSDL (dotnet)• ATO SBR Logical Artefact
Map • Release notes
• Site and document maps • Common MIG • Service registry
• Message repository [Links to the pages below]
• ATO Common Record
Delimiter Validation Rules
• ATO Service Characteristics
Risk Chart
• Service registry
• ATO Cloud Software Auth
SDK
• ATO Service Support
Versioning Strategy
• ATO Cloud Software Auth
SDK
• ATO Validation and Rule
Expression Guide
• Common BIG• ATO Taxonomy
Architecture
• Taxpayer Declaration Guide• ATO XML Schema
Generation Algorithm
Activity Statements (AS)Administrators of Payment
Systems Obligations (APSO)
Automatic Exchange of
Information (AEOI)Business Registrations (BR) Client Management (CM) Employer Obligations (EO)
Significant Global Entity
Obligations (SGEO)
Superannuation data and
reporting standards
Tax Practitioner Practice
Management (TPPM)
• Activity Statements (AS)• Electronic Payment
System Transactions
• Common Reporting
Standard CRS)• ABN Registration BIG • Account Role (ACCROLE) • Employee Withholding • Country-by-Country (CbC) • Manage Agent Trust (MAT)
• Foreign Account Tax
Compliance (FATCA)• ABN Registration (ABNREG) • Assessment (ASMT) • Payment Summaries (PS)
• ABN Registration Detail
(ABNREGDTL)• Client Communication (CC) • Payroll Event (PAYEVNT)
• ABN Registration
Questionnaire (ABNREGENT)• Client Account (CLNTACC)
• Tax File Number
Declarations (TFND)Superannuation (SPR)
• ABN Registration Help
(ABNREGHLP)• Client Update (CU)
• Taxable Payments Annual
Report (TPAR)• EmployerTICK (ETIC)
• ABN Registration Status
(ABNREGSTS)
• Client Update Demographics
(CUDEMOGR)
• Fund Validation Service
(FVS)
• ABN Registration Tax Add
Role (ABNREGTAXADD
• Client Update Manage
Activity Statements• Super Match (SMAT)
• ABN Registration AUSkey
(AUSKEY)
• Client Update Relationships
(CUREL)• Super Member (SPRMBR)
• Direct Debit (DD) • SuperTICK (STIC)
• Deferral (DFRL)• Unclaimed Super Match
(USMAT)
• Income Tax Lodgment Status
(ITLDGSTS)
• Lodgment List (LDGLST)
• Payment Plan (PMTPLN)
• Payment Reference Number
(PRN)
• Private Ruling (PR)
• Tax Practitioner Client
Management Reports (TPCMR)
• Transaction List (TXLST)
The artefacts shown within this dashed line box are displayed
on all subdomain (suite/service) pages described below.
ATO common artefacts and reference documents
http://www.sbr.gov.au/
The Standard Business Reporting (SBR) website provides access to technical artefacts needed by Software Developers to design and implement government web services for business consumers.
The information located on this site is limited to services offered via the SBR platforms by a particular agency. For the Australian Taxation Office, services may be offered over one or both
platforms (SBR Core Services and/or SBR ebMS3).
• TRT for Attribution of
Managed Investments
(TRTAMI)
• Trust Tax Return (TRT)
• Consolidated Group
Notification (CGNFT)
• Company Tax Return (CTR)
• Dividend and Interest
Schedule (DIS)
• Family Trust
Election/Revocation (FTER)
• Fringe Benefits Tax Return
(FBT)
• Fund Income Tax Return
(FITR)
Note: this is a PDF representation of the Document map
found in the 'Site and document maps' spreadsheet.
ATO Content Restructure
• Interposed Entity Election
(IEE)
• Partnership Return (PTR)
• Self Managed Super Fund
Annual Report (SMSFAR)
Income Tax Returns (ITR)
Individual Income Tax
Returns (IITR)
• Individual Income Tax
Returns (IITR)
Non-individual Income Tax
Returns (NITR)
• Closely Held Trusts
(CHTWTHHLD)
Document
Map
12 UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
SBR website
https://standardbusinessreporting.sharefile.com/Authentication/Login SBR ShareFile is a restricted site that contains Software Developer Kits (SDKs) to help with SBR implementations, Conformance Suits and Taxonomies. Access to sharefile needs to be requested through SBR Service Desk.
ebMS3 SBR SDK SSL Certificates Taxonomy SBR Conformance Suites
ebMS3 SDK .NET SBR Core Services 1. Current Version ATO
.NET ABR SecurityTokenManager_SampleProgram_C#_8.0.0_2015-06-16 EVTE 2016.02.xx .sbr.au Activity Statements (AS)
DotNET AS4 Embeddable Client ABR_AuskeyManager_C#_2.0.1_2015-11-18 test.ato.sbr.gov.au.crt sbr_au Client Management (CM)
DotNET x64 Reference Client Executable ABR_AuskeyManager_Sample_C#_2.0.1_2015-11-18 test.ato.sbr.gov.au-intermediate.crt sbr_au_reports Account List (ACCLST)
DotNET x64 Reference Client Source Code ABR_SecurityTokenManager_C#_8.0.0_2013-04-08 test.ato.sbr.gov.au-root.crt ato Client Update (CU)
DotNET x86 Reference Client Executable SBR SDK November 2015 Release Summary - dotNET PROD as fvsl Direct Debit (DD)
DotNET x86 Reference Client Source Code SBR_CoreServicesRequester_C#_1.2.0_2015-06-09 sbr.gov.au.crt as_0001 fvsu Income Tax Lodgment Status (ITLDGSTS)
dotNET SDK Release Note SBR_CoreServicesRequester-SampleProgram_C#_1.2.0_2015-06-16 sbr.gov.au-intermediate.crt ascrpt grpt Lodgment List (LDGLST)
C SBR_ReferenceClient_C#_2.1.3_2015-06-16 sbr.gov.au-root.crt ascrpt_0001 ids Payment Plan (PMTPLN)
C AS4 Embeddable Client ADK SBR ebMS3 aslrpt iee Private Ruling (PR)
C SDK Release Note Current EVTE3 aslrpt_0001 iitr Tax Practitioner Client Management Reports (TPCMR) *
Java SDK-N outbound signing cas itcrpt Transaction List (TXLST)
Java AS4 Embeddable Client ABR_AuskeyManager_C#_2.1.0_2016-08-01 core.test.sbr.gov.au.crt cas_0001 itldgsts Update Deferral (DFRL)
Java x64 Reference Client Executable ABR_AuskeyManager_Sample_C#_2.1.0_2016-08-01 core.test.sbr.gov.au-intermediate.crt cgls itlrpt* TPCMR Conformance also includes Manage Agent Trust report
(domian of Tax Practitioner Practice Management)
Java x64 Reference Client Source Code ABR_SecurityTokenManager_C#_8.2.2.1_2016-08-01 core.test.sbr.gov.au-root.crt cgls_0001 ls Common
Java x86 Reference Client Executable ABR_SecurityTokenManager_Sample_C#_8.2.2.1_2016-08-01 test2.ato.sbr.gov.au.crt cgls_0002 mat ATO Integrated Product Test
Java x86 Reference Client Source Code Jose_F_Elizondo_2016_2018_2_Keystore test2.ato.sbr.gov.au-intermediate.crt cgls_0003 mrpts ato.keystore
Java SDK Release Note readme test2.ato.sbr.gov.au-root.crt cgls_0004 nipss Employer Obligations (EO)
C PROD1 cgls_0005 odrpt Payment Summaries (PS)
XBRL API ABR_AuskeyManager_2.0.1 outbound signing cgnft pctr Tax File Number Declaration (TFND)
XBRL API v1.x ABR_AuskeyManager-Sample_2.1.0 signing.sbr.gov.au.crt cgts pptr Taxable Payments Annual Report (TPAR)
Typed Dimensions Patch v1.2.2.1 ABR_Base_2.1.0 signing.sbr.gov.au-intermediate.crt chtwthhld pr Income Tax Returns (ITR)
CSharp ABR_Base-Sample_2.1.0 signing.sbr.gov.au-root.crt chtwthhldben ps IITR
Readme_SDK_XBRL_API_CSharp_Release_1.2.2_patch_0001 ABR_SecurityTokenManager_2.0.0 ato.sbr.gov.au.crt ctr psi NITR
SDK_XBRL_API_CSharp_Release_1.2.2_patch_0001 ABR_SecurityTokenManager-Sample_2.0.0 ato.sbr.gov.au-intermediate.crt cu pss Superannuation (SPR)
Java readme ato.sbr.gov.au-root.crt cuaddr ptr EmployerTICK (ETIC)
Readme_SDK_XBRL_API_Java_Release_1.2.2_patch_0001 SBR SDK October 2015 Release Summary VANguard cudtl rds Fund Validation Service (FVS)
SDK_XBRL_API_Java_Release_1.2.2_patch_0001 SBR_CoreServicesRequester_2.0.0 EVTE cuec rdtis Super Match (SMAT)
Java_Solaris SBR_CoreServicesRequester-Sample_2.0.0 thirdparty.authentication.business.gov.au.crt cufi rs SuperTICK (STIC)
Readme_SDK_XBRL_API_Java_Solaris_Release_1.2.2_patch_0001 Windows-Dependencies-2.1.0 PROD cumas rspt
SDK_XBRL_API_Java_Solaris_Release_1.2.2_patch_0001.tar.gz Java authentication.business.gov.au.crt curel s25a
SDK XBRL API Functional Specification V1.0 ABR_AuskeyManager_Java_2.0_2015_04_01 curnn smat2
SDK_XBRL_API_CSHARP_Release_1.2.2 ABR_SecurityTokenManager_Java_8.0.1_2015-5-14 dd smsfar
SDK_XBRL_API_Java_Release_1.2.2 ABR_SecurityTokenManager_SampleProgram_Java_8.0.1_2015-5-14 dids stic
SDK_XBRL_API_Release_Solaris_1.2.2.tar.gz SBR Core Services Requester SampleProgram_Java_1.20_2015-06-17 dis tcs
XBRL API v2.x SBR Core Services Requester_Java_1.20_2015-06-17 ebn tfnd
Web service/platform development tools Service Message Schemas ConformanceSuites
The SBR ShareFile is a restricted site that contains Software Developer Kits (SDKs) to help with SBR implementations, Conformance Suits and Taxonomies. Access to the SBR ShareFile needs to be requested through the SBR Service Desk. The below diagram is a snapshot of the SBR ShareFile, part of the SBR ATO Site and Document Map located via the ATO common artefacts and reference documents page on sbr.gov.au. Hyperlinks to all the indicated share files are included in the SBR ShareFile.
13
Contains artefacts that are relevant to STP enablement. Items marked with red boxes in the Pathways diagrams are located here
UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts
SBR ShareFile
Keeping current…three key documents
14
Release plan: eCommerce Schedule STP Release on a page
This document is published at: https://softwaredevelopers.ato.gov.au/eCommerce_Schedules_and_Scope
Items in this document which have been scheduled are also included in the "Release on a Page"(PDF) in the same location
DOCUMENT CHANGE CONTROL Version Date Item #’s Change Summary/Reason etc.
0.001 N/A Initial draft roadmap to baseline current understanding with the STP Technical Focus Group
0.002
Impact Assessment and Industry
Consultation Items
Inclusion of dates for MST, EVTE and Production for the items under impact assessment and industry
consultation
1.000 9/11/2017 All First version endorsed by the ATO-DSP Technical Working Group 9th November 2017
1.001 21/11/2017 Overview Page Modified for context for publishing to the eCommerce Schedules and Scope page
STP Program
Technical Change RoadmapPurpose: To provide Digital Service Providers (DSPs) and their stakeholders visibility of the ATO’s progressive roadmap of change in regard to the technical
interactions under the Single Touch Payroll (STP) program of work.
The roadmap aims to inform these stakeholders with clarity/certainty regarding both the scheduled technical changes, along with the technical changes
still being impact assessed and/or under industry consultation.
In particular, the roadmap intent is to give certainty to assist DSPs in developing end-state solutions.
The ATO will continue to update this roadmap as required through consultation with industry.
IMPORTANT: This document is subject to change. DSPs are advised to refer to the latest versions
Roadmap that bridges the STP BIG with the technical delivery over time
Australian Government
Australian Taxation Office
ATO SBR Service Registry Intent: This spreadsheet is intended to show technical service and message configuration data for ATO offerings on both SBR platforms. It is designed to facilitate technical consumption and allows parent/child messages to be more easily understood. Limitations: Low level platform, business contextual, message structures and validation information is not included. Such information is contained within the appropriate artefacts (i.e. SBR Core Services Web Services Implementation Guide, Business Implementation Guides, Message Structure Tables and Validation Rules). Audience for this spreadsheet The intended audience for this spreadsheet is primarily Software Developers (SWDs) who have or a looking to implement ATO web services via the SBR platforms.
UNCLASSIFIED – Single Touch Payroll: DSP guide to navigating the SBR technical artefacts