XPM - Client & Tax Report Setup

ATOmate connects to your Xero Practice Manager or Workflow Max via Xero’s API (Application Programming Interface) to populate the client list in ATOmate. However this API does not currently provide a complete set of client data. In order to retrieve a full set of client data, it is required to set up two reports in Xero.

Guide for API connection: https://baw.atlassian.net/wiki/spaces/AG/pages/531202049

The image below shows how ATOmate needs to retrieve client information from both the API and the two Xero reports. Report 1 exports client data including Tax File Numbers and Report 2 includes Tax Return Estimates and Tax Year information for the client.

This guide explains how to set up the reports in Xero and how to request API details. These activities are all once-off tasks that will be completed during your Onboarding.

Report 1: ATOmate - Client & Contact

These instructions explain how to build the report structure required to retrieve client information including Tax File Numbers.

Step	Action

Step	Action
1	From Xero, expand the menu on the left-hand side and select WorkflowMax.
2	Click on the Reports menu and select Report Builder.
3	The Report Builder screen displays. Select the Report Builder tab. From the Report Type options, select Client & Contact. Select Table for the Report Layout Click Create.
4	The Tax Return – Report Designer screen displays with 4 panels to make selections from. Report Panel Click in the Title field and type ATOmate - Client & Contact
5	Fields Panel Click in the drop-down menu to select all of the following fields. Tips: To change the order of the fields, drag each field to reorder the list.
6	Criteria Panel From the drop down menu, select the [Client] Status filter. Select Excludes > Archived.
7	Publish Panel From the drop down menu, select one or more staff members who will run the report. Leave default selections for other fields.
8	The report can be viewed by clicking Preview Report, or simply click Save.
9	The report now displays both under the Report Builder tab and also under the My Reports tab.

Are Custom Fields Used In XPM? Click Here To Include These In The Report

Report 2: ATOmate - Tax Return

These instructions explain how to build the report structure required to retrieve Tax Return estimates and tax year information for clients.

Step	Action

Step	Action
1	From Xero, expand the menu on the left-hand side and select WorkflowMax.
2	Click on the Reports menu and select Report Builder.
	The Report Builder screen displays. Select the Report Builder tab. From the Report Type options, select Tax Return Select Table for the Report Layout Click Create.
4	The Tax Return – Report Designer screen displays with 4 panels to make selections from. Report Panel Click in the Title field and type ATOmate - Tax Return.
5	Fields Panel Click in the drop down menu to select all of the following fields. If using the ATOmate Fee For Service custom field, add this field here.
6	Criteria Panel From the drop down menu, select the [Client] Status filter. Select Excludes > Archived.
7	Publish Panel From the drop down menu, select one or more staff members who will run the report. Leave default selections for other fields.
8	The report can be viewed by clicking Preview Report, or simply click Save.
9	The report now displays both under the Report Builder tab and also under the My Reports tab.

Once both reports have been created, your list of reports should include the two shown below.

Contact Us

BAW Support