Software services: Services available in production
The following services are available in production as part of the Software services project. These services are available in EVTE to test.
See also:
Account role
The ACCROLE product suite has superseded the ROLELST web service.
Service
|
Technical specifications - Interactions
|
You can build this service to allow users to:
- view information relating to current role balance, due and payable amounts and forecast penalty and interest dates for some superannuation roles
- retrieve details for selected activity statement role types. This includes retrieving the reporting method to support Simpler BAS
- request a list of ATO role summary information for an activity statement or superannuation account for a particular client or role type
- add activity statement roles, including roles for goods and services tax (GST), fuel tax credits, wine equalisation tax, luxury car tax, pay as you go (PAYG) withholding and PAYG instalments
- validate before updating activity statement roles
- update activity statement roles
- validate before cancelling activity statement roles
- cancel activity statement roles.
|
ACCROLE including account role summary
Interactions are:
- ACCROLE.0001 2017.LIST
- ACCROLE.0001 2017.GET
- ACCROLESUM.0001.2017.LIST
- ACCROLE.0001 2017.SUBMIT
- ACCROLE.0001.2017VALIDATEUPDATE
- ACCROLE.0001.2017.UPDATE
- ACCROLE.0001.2017.VALIDATECANCEL
- ACCROLE.0001.2017.CANCEL
|
Client account
The CLNTACC product suite has superseded the ACCLST web service and versions.
Service
|
Technical specifications
|
You can build this service to allow users to:
- request a list of ATO tax and superannuation account information for a particular client, including the due and payable amount
- forecast the interest amount for an account to a future date
- obtain an Australian and New Zealand Standard Industrial Classification (ANZSIC) code which can be used in relation to GST eligibility in the Account role service when adding a GST role (does not provide functionality to maintain the ANZSIC code)
- obtain a payment plan identifier where an active payment plan exists on the account.
Additional account types will be incorporated over time.
|
CLNTACC
- CLNTACC.0001 2017.LIST
- CLNTACCSUM.0001.2017.LI0ST
|
Outcome of individual income tax returns assessment details (2018)
Service |
Te--chnical specifications |
You can build this service to allow a tax agent to:
- list details of assessments for the selected years
- view details of how we calculate their individual client’s tax return assessment for 2018
- view details of any adjustments that have been made, including the reason for adjustment when one is available.
This information is not available in the portal and is not dependent on lodgment channel.
This service provides agents with a view of the tax return assessment process and an understanding of where adjustments were made during the calculation of the assessment. This allows agents to better compare and validate the outcome of assessment with the expected estimate at lodgment.
|
ASMT
- ASMT.003.2018.LIST
- ASMT.003.2018.GET
|
Outcome of individual income tax returns assessment details (2016 and 2017)
Service
|
Technical specifications
|
You can build this service to allow a tax agent to:
- list details of assessments for the selected years
- view details of how we calculate their individual client’s tax return assessment for 2016 and 2017
- view details of any adjustments that have been made, including the reason for adjustment when one is available.
This information is not available in the portal and is not dependent on lodgment channel.
This service provides agents with a view of the tax return assessment process and an understanding of where adjustments were made during the calculation of the assessment. This allows agents to better compare and validate the outcome of assessment with the expected estimate at lodgment.
The ASMT product suite has additional interactions which have not yet been whitelisted. See Services available in EVTE.
|
ASMT
- ASMT.0002.2017.LIST
- ASMT.0002.2017.GET
|
Transaction list
Service
|
Technical specifications
|
You can build a service that will allow users to:
- request a complete or aggregated list of financial transactions based on the statement of account view
- request a transaction based on:
- account identifier
- processed date
- effective date
- sort order.
|
TXLST
|
Lodgment list
Service
|
Technical specifications
|
You can build a service that will allow users to view a list of the clients expected and received lodgements, including the following accounts:
- Income tax.
- Fringe benefits tax.
- Activity statement.
|
LDGLST
|
Client Update Relationships 2018
Service
|
Technical specifications
|
You can build a service that will allow a registered tax professional (including payroll providers) to:
- search for a new client before adding a relationship
- validate before adding an agent/client relationship
- add a client relationship at the following levels:
- validate before removing an agent/client relationship
- remove a client relationship
- view a list of relationships for all clients or a specific client.
This is an enhancement to the 2016 service.
|
CUREL
- CUREL.0004.2018.SEARCH
- CUREL.0004.2018. VALIDATE
- CUREL.0004.2018.SUBMIT
- CUREL.0004.2018.VALIDATEREMOVE
- CUREL.0004.2018.REMOVE
- CUREL.0004.2018.LIST
|
Payment plans
Service |
Technical specifications |
You can build a service that will allow a user, for activity statement and income tax, fringe benefit tax, Super Guarantee Director Penalty, Super Guarantee Charge debt to:
- view a payment plan for a specified payment plan ID For example:
- instalment amounts, including general interest charge (GIC)
- due dates
- payment plan IDtotal estimated GIC for the payment plan.
- request for a specified account or for each account belonging to a client:
- eligibility to create a new payment plan, including available payment plan options
- payment plan identifier for existing active payment plans.
- calculate a payment plan schedule, including the GIC payable under the payment plan for a specified account
- create a payment plan for a specified eligible account to obtain the payment reference number.
|
PMTPLN
- PMTPLN.0002.2017.GET
- PMTPLNELG.0002.2017.LIST
- PMTPLN.0002.2017.CALCULATE
- PMTPLN.0002.2017.SUBMIT
|
View payment reference number
Service |
Technical specifications |
You can build a service that will allow users to view a payment reference number within their software for a specified account or role to facilitate a payment through their preferred channel. |
PRN
|
Client demographics
Service |
Technical specifications |
You can build this service to allow users to:
- view current and historical client addresses, including geographic, telephonic, electronic and authorised contacts at a client or account level
- validate client address update for an account
- update addresses for a client account
- view a client profile of individual and non-individual clients for example, name, date of birth, not for profit indicator and super indicators
- maintain client details
- view client financial institution details for an account
- validate a request to update a client’s financial institution details
- update FIA details for a client account
- maintain authorised contacts
- view associates.
The CUDEMOGR product suite has additional interactions which have not yet been whitelisted. See Services available in EVTE. |
CUDEMOGR
- CUADDR.0003 2016.LIST
- CUADDR.0003 2016.VALIDATE
- CUADDR.0003 2016.SUBMIT
- CUDTL.0003 2017. GET
- CUDTL.0003 2017. VALIDATE
- CUDTL.0003 2017. SUBMIT
- CUFI.0003 2016.LIST
- CUFI.0003 2016.SUBMIT
- CUAUTHDCNTCT.0001.2017.VALIDATE
- CUAUTHDCNTCT.0001.2017.SUBMIT
|
Direct Debit
Service |
Technical specifications |
You can build this service to allow users to:
- schedule and cancel a one off direct debit for:
- Income tax – individuals, sole traders, company and superannuation fund
- Fringe benefits tax
- Integrated Client account – including PAYGW.
This is an enhancement to the currently available Direct Debit service. |
ATO DD
- DD.0003.2018.ADD
- DD.0003.2018.CANCEL
|
Lodgment program
Service |
Technical specifications |
You can build this service to allow a registered tax agent to track both current progress and two-years prior towards meeting their lodgment program benchmarks for IT and FBT. The tax agent will be able to retrieve:
- lodged on time count
- lodged on time deferred count
- lodged late count
- lodged late deferred count
- lodgment overdue count
- lodgment overdue deferred count
- not lodged not due count
- not lodged not due deferred count
- return not necessary count
- further return not necessary
- lodgment program performance statistic.
This service provides statistics calculated weekly, some of which are the same as the Income Tax Lodgment Performance Report where statistics are available periodically.
|
LDGPRGM
|
Lodgment progress
Service |
Technical specifications |
You can build this service to allow users, for income tax returns, to view:
- the overall status of lodgment, for example, In progress, issued or processed
- the current outcome of lodgment, for example, information pending, under review or dollar value if issued/processed
- the reason for current lodgment processing status when it is In Progress.
|
LDGPROG
|
Client demographics
Service |
Technical specifications |
You can build this service to allow users to:
- view current and historical client addresses, including geographic, telephonic, electronic and authorised contacts at a client or account level
- validate client address update for an account
- update addresses for a client account
- view a client profile of individual and non-individual clients for example, name, date of birth, not for profit indicator and super indicators
- maintain client details
- view client financial institution details for an account
- validate a request to update a client’s financial institution details
- update FIA details for a client account maintain authorised contacts
- view associates.
|
CUDEMOGR
- CUFI.0003.2016.VALIDATE
- CUASSOC.0001.2017.SUBMIT
|
Copy of return
Service |
Technical specifications |
You can build this service to allow users to:
- view a copy of individual tax return for 2017 financial year.
The data provided is the data available on ATO systems, including numerical values which have been adjusted due to calculation errors. |
LDG
|
Deferrals
Service |
Technical specifications |
You can build this service to allow Tax and BAS agents to:
- apply for and receive an immediate response regarding a deferral for new and re-engaged clients
- receive an automatic payment deferral when lodgment deferral is requested – excluding a deferral for new and re-engaged client.
This is an enhancement to the current service and the immediate response will depend on whether the request meets eligibility requirements. |
DFRL
|
Lodge IT non-lodgment advice
Service |
Technical specifications |
You can build this service to allow tax agents to:
- lodge a non-lodgment advice for income tax for individuals
- receive a confirmation number when lodgment is successful.
This is an enhancement to the current service. |
LDGNN
|