Standard Business Reporting Australian Taxation Office Client Update Relationships (CUREL) 2016 Package v0.3 Contents Date: 18th May 2017 This document and its attachments are Unclassified For further information or questions, contact the SBR Service Desk at [email protected] or call 1300 488 231. International callers may use +61-2-6216 5577 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS VERSION CONTROL Version Release date Description of changes 0.3 18/05/2017 This document has been updated for the May 2017 EVTE Release. Section 1 Introduction Non- functional changes: Additions: New sub-section ‘1.4.2 Services’ which lists services that form the product suite and their relationship to previous service versions. Movements/updates: Sub-section ‘1.4.3 New Services’ renamed to ‘1.4.3 Interactions’. o The table has been updated to reflect the Interactions as described in the Service Registry (SR). o The Product acronym has been changed from ‘cu’ to ‘curel’ to align with the SR. o Two new columns have been added: - Change - Comments Sub-section ‘1.4.2 Circumstances where artefacts are not present in a package’ moved and renamed ‘1.4.4 Package artefact status description’. Deletions: Previous sub-section ‘1.4.4 New messages associated with services (child relationship)’ as this information is in the SR. Section 2 Package contents Updated with functional changes: ATO CURELADDDELETE.0003 2016 Submit Request Message Structure Table.xlsx o File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. o Added new data elements (CUREL201 and CUREL202) for sender declarations (intermediary only). ATO CURELADDDELETE.0003 2016 Submit Validation Rules.xlsx o File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. o UNCLASSIFIED New Validation Rules and Messages: 1. VR.ATO.CUREL.000013/CMN.ATO.CUREL.000013: Declaration signature indicator must be true. 2. VR.ATO.CUREL.000014/CMN.ATO.CUREL.000014: The sender's Declaration is not provided. PAGE 2 OF 14 STANDARD BUSINESS REPORTING Version Release date ATO CUREL 2016 PACKAGE V0.3 CONTENTS Description of changes ATO CURELADDDELETE.0003 2016 Submit XML Contracts.zip o File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. o Reflects updated information in the Request Message Structure Table. ATO CUREL 2016 Message Repository.zip Renamed from ‘ATO Client Update Relationships 2016 Message Repository.zip’ and updated with new messages as outlined in section 4 below. Section 4 Schematron changes Updated: Column ‘Service Name’ changed to ‘Interaction Name’. Data amended to reflect the interaction names in the service registry (year added). New: Added two new event messages for curel.0003.2016.submit Section 5 Known issues and future scope Updated: Column ‘Impacted Service’ changed to ‘Impacted Interaction’. Data amended to reflect the interaction names in the service registry (year added). UNCLASSIFIED PAGE 3 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS COPYRIGHT © Commonwealth of Australia 2017 (see exceptions below). This work is copyright. Use of this Information and Material is subject to the terms and conditions in the "SBR Disclaimer and Conditions of Use" which is available at http://www.sbr.gov.au. You must ensure that you comply with those terms and conditions. In particular, those terms and conditions include disclaimers and limitations on the liability of the Commonwealth and an indemnity from you to the Commonwealth and its personnel, the SBR Agencies and their personnel. You must include this copyright notice in all copies of this Information and Material which you create. If you modify, adapt or prepare derivative works of the Information and Material, the notice must still be included but you must add your own copyright statement to your modification, adaptation or derivative work which makes clear the nature of your modification, adaptation or derivative work and you must include an acknowledgement that the adaptation, modification or derivative work is based on Commonwealth or SBR Agency owned Information and Material. Copyright in SBR Agency specific aspects of the SBR Reporting Taxonomy is owned by the relevant SBR Agency. Table of contents 1 Introduction ........................................................................................................................ 5 1.1 Document purpose .................................................................................................... 5 1.2 Audience.................................................................................................................... 5 1.3 Purpose of this package ............................................................................................ 5 1.4 Summary of artefacts the ATO packages................................................................... 5 1.4.1 In general ............................................................................................................... 5 1.4.2 Services ................................................................................................................. 6 1.4.3 Interactions ............................................................................................................ 6 1.4.4 Package artefact status description........................................................................ 6 2 Package contents............................................................................................................... 8 3 C# changes .......................................................................................................................10 3.1 Technical changes ....................................................................................................10 3.2 Event message changes...........................................................................................10 4 Schematron changes ........................................................................................................11 4.1 Technical changes ....................................................................................................11 4.2 Event message changes...........................................................................................11 5 Known issues and future scope.........................................................................................12 Appendix A – Prior Version History ..........................................................................................13 UNCLASSIFIED PAGE 4 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 1 INTRODUCTION 1.1 DOCUMENT PURPOSE The purpose of this package content note (PCN) is to advise software developers of the package contents for Standard Business Reporting (SBR) Client Update Relationships (CUREL) 2016 provided by the Australian Taxation Office (ATO). 1.2 AUDIENCE The audience for this Package Content Note is software developers who have or are interested in developing client relationship services on the SBR ebMS3 platform in the XML format. 1.3 PURPOSE OF THIS PACKAGE The purpose of this package is to streamline the way message artefacts are presented to software developers. All relevant message artefacts that comprise the CUREL 2016 suite are contained within one zip file. The package will be versioned up each time artefacts are added or updated. 1.4 SUMMARY OF ARTEFACTS THE ATO PACKAGES 1.4.1 In general For each service, the following artefacts may be released under this package title: Message Repository Message Structure Tables (MSTs), Contract schemas and samples, and Validation Rules (VRs). Note: From September 2016 the Message Implementation Guide/s (MIGs) will not be produced and will be replaced by the ATO Service Registry which is published under the ATO Common information artefacts section on all ATO pages on sbr.gov.au. The first PCN released outlines the expected artefacts to be within the package at an end state – as known at that point in time. As a general rule, each service will have at minimum an MST and VR. Where a ‘suite’ of like services is packaged, there will be service specific MSTs and VRs packaged to form a bundle of related information. The basic exception to the above is Income tax Returns. Due to complexity of relationships between parent returns and child schedules each has its own set of documents (MSTs and VRs) yet is packaged together as a ‘suite’. UNCLASSIFIED PAGE 5 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 1.4.2 Services The following table shows the services that form the CUREL product suite and their relationship to previous service versions: Description Client Update Relationships 2016 Client Update Relationships Add 2016 Client Update Relationships Delete 2016 Client Update Relationships Search 2016 Service curel.0003.2016 cureladd.0003.2016 cureldelete.0003.2016 cusrch.0001.2016 Change Versioned Versioned Versioned New Product curel curel curel curel Comments Replaces curel.0002.2016 Replaces cureladd.0002.2016 Replaces cureldelete.0002.2016 1.4.3 Interactions The following table lists the interactions for a given service. Description Client Update Relationships 2016 - List Client Update Relationships Add 2016 - Submit Interaction curel.0003.2016.list cureladd.0003.2016.submit Change Versioned Versioned Product curel curel Comments Client Update Relationships Add 2016 - Validate cureladd.0003.2016.validate New curel Submit artefacts are used for the Validate action. Client Update Relationships Delete 2016 - Submit Client Update Relationships Delete 2016 - Validate cureldelete.0003.2016.submit cureldelete.0003.2016.validate Versioned New curel curel Client Update Relationships Search 2016 - Get cusrch.0001.2016.get New curel Previous version was cureladd.0002.lodge Submit artefacts are used for the Validate action. Detailed information on each service can be found in the Service Registry, along with associated messages. 1.4.4 Package artefact status description The table in Section 2 Package Contents reflects the status of artefacts in the Package Status column and needs to be read in conjunction with the Comments column in order to understand the scale of change that may be applicable. UNCLASSIFIED PAGE 6 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS The table below describes the terminology used in the Package Status column and the business description of the package status: Package Status Pending New Updated Present Removed UNCLASSIFIED Business Description The artefact is currently under development and is expected to be released in a future package. The artefact is new for the package and has not been published previously. This would usually occur when an artefact has previously been marked as Pending (under development) or a new Government/ATO initiative sees the development of new services/messages to be deployed. The artefact has changed since the last public release for this package. It could occur as a result of refining service/messages due to feedback or defects. The artefact is within the package and has had no change from the prior package for this year or a previous/forward year where artefacts cross multiple years. The artefact was within the package in a prior release but has been removed as it is not relevant for the service/suite in question. This could occur due to Government legislation waiting on Royal Assent not being passed or other factors. PAGE 7 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 2 PACKAGE CONTENTS The table below outlines the package contents. Name ATO CUREL.0003 2016 List Request Message Structure Table.xlsx ATO CUREL.0003 2016 List Response Message Structure Table.xlsx ATO CUREL.0003 2016 List Validation Rules.xlsx ATO CUREL.0003 2016 List XML Contracts.zip ATO CUREL.0003 2016 Submit Request Message Structure Table.xlsx ATO CURELADDDELETE.0003 2016 Submit Validation Rules.xlsx Document Date 15/12/2016 Document Status Draft Version Comments 0.2 No change from prior publication. Package Status Present 15/12/2016 Draft 0.2 No change from prior publication. Present 01/12/2016 Draft 0.1 No change from prior publication. Present 15/12/2016 18/05/2017 Draft Draft 0.2 0.3 No change from prior publication. File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. Present Updated 18/05/2017 Draft 0.3 Message Structure Table: Added new data elements (CUREL201 and CUREL202) for sender declarations (intermediary only). File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. Updated New Validation Rules and Messages: 1. VR.ATO.CUREL.000013/CMN.ATO.CUREL.0000 13: Declaration signature indicator must be true. 2. VR.ATO.CUREL.000014/CMN.ATO.CUREL.0000 14: The sender's Declaration is not provided. UNCLASSIFIED PAGE 8 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS Name ATO CURELADDDELETE.0003 2016 Submit XML Contracts.zip Document Date 18/05/2017 Document Status Draft Version Comments 0.3 File name changed from ‘CUREL.0003 2016 Submit….’ to ‘CURELADDDELETE.0003 2016 Submit….’ as this artefact covers both the Add and Delete inteactions. Package Status Updated ATO CUSRCH.0001 2016 Get Request Message Structure Table.xlsx ATO CUSRCH.0001 2016 Get Response Message Structure Table.xlsx ATO CUSRCH.0001 2016 Get Validation Rules.xlsx ATO CUSRCH.0001 2016 Get XML Contracts.zip 15/12/2016 Draft 0.2 Reflects updated information in the Request Message Structure Table. No change from prior publication. 15/12/2016 Draft 0.2 No change from prior publication. Present 15/12/2016 Draft 0.2 No change from prior publication. Present 15/12/2016 Draft 0.2 No change from prior publication. Present ATO CUREL 2016 Message Repository.zip 18/05/2017 Draft 0.3 Updates to reflect: New validation rule messages Updated Total artefacts in this Package: UNCLASSIFIED Present 12 Present artefacts 8 New artefacts 0 Updated artefacts 4 Pending artefacts 0 Removed artefacts 0 PAGE 9 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 3 C# CHANGES 3.1 TECHNICAL CHANGES C# changes are not applicable to Client Update Relationships 2016 services. 3.2 EVENT MESSAGE CHANGES C# changes are not applicable to Client Update Relationships 2016 services. UNCLASSIFIED PAGE 10 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 4 SCHEMATRON CHANGES 4.1 TECHNICAL CHANGES Schematron is not applicable to Client Update Relationships 2016. 4.2 EVENT MESSAGE CHANGES Interaction Name Rule ID Change Previous Event Message Previous Message ID New Event Message New Message ID cureladd.0003.20 16.submit cureladd.0003.20 16.validate cureldelete.0003. 2016.submit cureldelete.0003. 2016.delete cureladd.0003.20 16.submit cureladd.0003.20 16.validate cureldelete.0003. 2016.submit cureldelete.0003. 2016.delete VR.ATO.CUREL.0000 13 New n/a n/a Short description: Declaration signature indicator must be true. CMN.ATO.CUREL.000013 VR.ATO.CUREL.0000 14 New n/a n/a Short description: The sender's Declaration is not provided. Detailed description: The Declaration must be provided by the Intermediary. CMN.ATO.CUREL.000014 UNCLASSIFIED PAGE 11 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS 5 KNOWN ISSUES AND FUTURE SCOPE The following is a list of issues and/or future work to be implemented for Client Update Relationships 2016. There may be impacts to successful development until the issues are resolved or the future scope has been implemented (as an example where a service is deployed over multiple iterations and won’t be complete for some time). Issue Impacted Interaction Excise Identification Number (EIN) is shown as a context in the Message Structure Tables, but a fact in the XML contracts. curel.0003.2016.list cureladd.0003.2016.sub mit cureladd.0003.2016.vali date cureldelete.0003.2016.s ubmit cureldelete.0003.2016. delete cusrch.0001.2016.get curel.0003.2016.list cureladd.0003.2016.sub mit cureladd.0003.2016.vali date cureldelete.0003.2016.s ubmit cureldelete.0003.2016. delete cusrch.0001.2016.get Withholding Payer Number (WPN) and EIN cannot currently be used as identifiers. UNCLASSIFIED Incident Number Internal Reference Resolution Proposed EVTE deployment Proposed PROD Deployment The schema generation tool will be updated to handle EIN’s as a context identifier. TBA TBA WPN and EINs will be able to be used as identifiers in a future release. TBA TBA PAGE 12 OF 14 STANDARD BUSINESS REPORTING ATO CUREL 2016 PACKAGE V0.3 CONTENTS APPENDIX A – PRIOR VERSION HISTORY Version Release date Description of changes 0.2.1 15/12/2016 This document and the associated artefact zip has been renamed to conform to the ATO SBR Service Registry as a product suite. Note: 0.2 15/12/2016 no functional changes to the artefacts have been made – this is an alignment exercise to avoid future issues. Previous name : ATO Client Relationships 2016 New Name: ATO CUREL 2016 This document has been updated for the December 2016 EVTE Release. Section 2 Package contents New: None Present: ATO CUREL.0003 2016 List Validation Rules.xlsx Updated: ATO CUREL.0003 2016 List Request Message Structure Table.xlsx ATO CUREL.0003 2016 List Response Message Structure Table.xlsx ATO CUREL.0003 2016 List XML Contracts.zip ATO CUREL.0003 2016 Submit Request Message Structure Table.xlsx ATO CUREL.0003 2016 Submit Validation Rules.xlsx ATO CUREL.0003 2016 Submit XML Contracts.zip ATO CUSRCH.0001 2016 Get Request Message Structure Table.xlsx ATO CUSRCH.0001 2016 Get Response Message Structure Table.xlsx ATO CUSRCH.0001 2016 Get Validation Rules.xlsx ATO CUSRCH.0001 2016 Get XML Contracts.zip ATO Client Update Relationships 2016 Message Repository.zip Pending: None Section 3 Schematron changes Updated to describe: Technical rule changes for curel.0003 submit Event message changes for curel.0003 submit and cusrch.0001 get Section 4 Known issues and future scope Updated to remove resolved known issues from the November 2016 EVTE Release. 0.1 UNCLASSIFIED 01/12/2016 Initial release. PAGE 13 OF 14 STANDARD BUSINESS REPORTING UNCLASSIFIED ATO CUREL 2016 PACKAGE V0.3 CONTENTS PAGE 14 OF 14
© Copyright 2026 Paperzz