Client Management (CLNTMGT)

Client Management is a sub-domain of Obligation Management (OBLMGT). This page contains information and artefacts for Digital Service Providers (DSPs) who have or are interested in developing web services that enable intermediaries to manage their client’s information with the ATO. The services described below are only deployed on the SBR ebMS3 platform.

For ease of use, services have been organised into the following business processes:

  • Relationships – Allows an agent or payroll provider to search for a new client, list clients with an existing relationship and add or remove a relationship at the client level, account level and/or specific role level.
  • Demographic Information – Allows users to list and update addresses, client details, financial institution details, authorised contacts and list associates.
  • Communication preferences (PENDING) – Allows an agent to set and maintain the communication preferences for their practice and their clients.
  • Client communications – Provides agents with a list and view of client communications sent from the ATO.

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.

Relationships

Service Name: Client Update Relationship (CUREL)

Service Version 0004.2018
Service Actions

Submit – Allows registered agents (including Payroll providers) to add Client Agent Relationship links at the client level, account level and/or specific role level.

Validate – Allows a client to agent relationship submit request to be validated.

Remove – Allows registered agents (including Payroll providers) to remove Client Agent Relationship links at the client level, account level and/or specific role level.

Validate remove – Allows a client to agent relationship remove request to be validated.

List – Allows registered agents (including Payroll providers) to retrieve a list of relationships for all clients or a specific client.

Search – Allows registered agents (including Payroll providers) to search for a new client prior to adding a relationship.

Name Version number Status Size Published date
ATO CUREL 2018 Business Implementation Guide.docx 2.0 Final 282KB 16 August 2018
ATO CUREL.0004 2018 Package v1.1 Contents.docx 1.1 Final 242KB 5 July 2018
ATO CUREL.0004 2018 Package v1.1.zip 1.1 Final 1.74MB 5 July 2018

Back to top

Demographic Information

Service Suite: Client Update Demographics (CUDEMOGR) 2016

Service Name: Client Update Address Details (CUADDR)

Service Version 0003.2016
Service Actions

List – Allows a request to retrieve a current/historical list of client addresses (geographic, telephonic, electronic and authorised contacts) at client or account level.

Submit – Allows a request to maintain client addresses at client or account level.

Validate – Allows a client address update request to be validated.

Service Name: Client Update Associates (CUASSOC)

Service Version 0001.2017
Service Actions List – Allows a request to retrieve a list of associated entities for a specific client.

Service Name: Client Update Authorised Contacts (CUAUTHCNTCT)

Service Version 0001.2017
Service Actions Submit – Allows a request to update the authorised contact details at client or account level.

Validate – Allows an authorised contact detail update to be validated.

Service Name: Client Update Details (CUDTL)

Service Version 0003.2017
Service Actions

Submit – Allows a request to update a client profile of individual and non-individual clients.

Validate – Allows a client profile update to be validated.

Get – Allows a request to view a client profile of individual and non-individual clients (name, date of birth, not for profit indicator, superannuation indicators as examples).

Service Version 0003.2016
Service Actions Get – Allows a request to view a client profile of individual and non-individual clients (name, date of birth, not for profit indicator, superannuation indicators as examples).

Service Name: Client Update Financial Institutions (CUFI)

Service Version 0003.2016
Service Actions

Submit – Allows a request to update the client’s financial institution details.

Validate – Allows a financial institution detail update to be validated.

List – Allows a request to view a current/historical list of client financial institution details.

Name Version number Status Size Published date
ATO CUDEMOGR 2016 Business Implementation Guide.docx 1.1 Final 349KB 17 May 2018
ATO CUDEMOGR 2016 Package v1.0.1. Contents.docx 1.0.1 Final 251KB 11 October 2018
ATO CUDEMOGR 2016 Package v1.0.zip 1.0 Final 3.83MB 07 December 2017

Back to top

Communication preferences

Service Suite:Communication Preferences (COMMPREF) 2018 – PENDING

Back to top

Client communications

Service Name: Client Communications (CC)

Service Version 0001.2016
Service Action

List – Allows a registered agent to request and retrieve a historical record of client communications for a single client, multiple clients or all clients.

Get – Allows a registered agent to retrieve a specific client communication item.

Name Version number Staus Size Publication date
ATO CC.0001 2016 Business Implementation Guide.docx 1.0 Final 391KB 20 October 2017
ATO CC.0001 2016 Package v1.0 Contents.docx 1.0 Final 223KB 07 December 2017
ATO CC.0001 2016 Package v1.0.zip 1.0 Final 399KB 07 December 2017

Back to top

 
Last updated: 
11 October 2018
Page ID: 
341