3rd Party Integration with swiftpos Back Office
Subjects ▼
About ▲ ▼
Available In? ▲ ▼
- swiftpos V10.62+
IMPORTANT
For sites upgrading to swiftpos V10.62+, It may be necessary to enlist the assistance/expertise of an accountant to ensure that in XERO, all Chart of Accounts (COA) and Tracking Categories are correct and appropriately configured for the Venue. Also, that all Account and Tracking Category assignments/mappings in the Account Assignment/Mapping tabs are done and correct.
What Is It? ▲ ▼
The swiftpos XERO Pro GL Interface, like the XERO GL Interface, it is essentially used to export swiftpos Sale, Stock Movement, Supplier Invoice and Terminal Cash Off Variance related data to XERO via the XERO API, however does it offer Venues additional features, over and above the XERO GL Interface. Refer to HERE for more information.
What Is Required? ▲ ▼
It is highly recommended that the setup and configuration of swiftpos XERO export interface is done in Test environments initially. That is, test environments for both swiftpos and XERO. Refer to How To Signup For A 30 day Free Trial In XERO for more information.
- In addition to completing the steps outlined in the XERO What Is Required (where applicable), ensure the following steps are also completed.
- In XERO
- For Venues that are contemplating using XERO for the first time and are wanting to make use of XERO Integration in swiftpos:
- XERO Registration - Venues will need to be registered to use the XERO Accounting platform. That is they will need to have a XERO Account. There is the option available to Login/Sign up for a 30 day free trial. This option is very useful when it comes to testing the swiftpos XERO Pro interface using a copy of the Venue's swiftpos database in a test environment. Refer to How To Signup For A 30 day Free Trial In XERO for more information.
- Chart of Accounts (COA) - Venues will need to enlist the services of an Accountant to ensure that their COA in XERO, is setup up and configured appropriately. Refer to XERO Articles on the Chart Of Accounts for more information.
- For Venues that are contemplating using XERO for the first time and are wanting to make use of XERO Integration in swiftpos:
- In swiftpos
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, the following applies:
- swiftpos Registration - Venues will need to be registered for the swiftpos XERO Pro GL interface for access to this feature. Email registrations@swiftpos.com.au to obtain the appropriate registration.
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, the following applies:
-
-
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, ensure the following is configured:
- Ensure that the Post Financial Data option is selected for those Locations for which General Journal, Supplier Invoice and/or Terminal Cash Off related data is to be exported.
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, ensure the following is configured:
-
Notes ...
This does NOT apply to Inventory/Stock transfers between Locations. These will always be exported regardless of the whether this option is selected or not.
- In swiftpos continued ...
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, the following applies:
- For Venues wanting to make use of XERO's Tracking Categories, then ensure Tracking Categories have been configured in XERO*. Refer to XERO Articles on Tracking Categories for more information.
- For Venues using XERO for the first time and for Venues already using XERO, and wanting to now make use of the swiftpos XERO Pro interface, the following applies:
* It may be necessary to enlist the assistance/expertise of an accountant to ensure that in XERO, all Tracking Categories are correct and appropriately configured for the Venue. Also, that all Tracking Category assignments/mappings are done in the Account assignment/mapping tabs are correct.
What Is Supported? ▲ ▼
The swiftpos XERO Pro export feature supports the following:
- The importing of a maximum of two Tracking Categories from Xero.
What To Consider? ▲ ▼
- A Venue having multiple XERO Organisations (equivalent to a swiftpos Location Group) with each having their own Chart of Accounts is now supported. In short that means, swiftpos Location Groups (Venues) can now export to separate XERO Organisations and have their own unique Chart of Accounts. Refer to How To Add And Configure A Location Group To Connect To XERO for more information.
Notes ...
A XERO App (XERO API credentials, namely Client ID, Customer Secret and Redirect URL) configured in XERO, can be used by more than one swiftpos Location Group (Venue) when establishing a connection to XERO.
- Refer HERE for more information.
When Is It Used? ▲ ▼
Any swiftpos Venue that wants to ability to export financial transactional data to Xero and include Tracking Categories in the export.
The swiftpos XERO Pro GL Interface is an advanced version of the XERO GL Interface, and amongst other features, provides the ability to include XERO Tracking Categories as part of the exported data. This may be useful to larger Venues, like Clubs and Pubs and provides Venues with the ability to track transactional data and hence provide a Venue with the ability to view their financial performance based on Xero's Tracking Categories. For example, these may include Departments, Cost Centres or Regions.
Fundamentally, it functions in the same way as XERO Export interface, however, XERO Pro supports the following:
- Single And Multiple XERO Organisations And Chart Of Accounts (COA) - It supports both single and multiple XERO Organisations, as well as multiple COAs. That is, each XERO Organisation in XERO has it’s own unique COA.
- Tracking Categories - These are configured in XERO and then:
- Imported into swiftpos. Refer to How To Import Tracking Categories Into swiftpos for more information.
- Once imported, they can then be assigned/mapped to swiftpos Location/Media, Location/Master Group combinations and Locations via the assigning/mapping Account tabs. This will ensure they are included with the financial data when exported to XERO.
- Additional Account Assignment/Mapping tabs - These have been included to support the following XERO Accounts:
Given the swiftpos PRO XERO Export is primarily the same as the XERO Export interface, with the exception of the above, this document is aimed only to highlight the areas of difference. Hence it is RECOMMENDED that one familiarises oneself with the XERO Export interface first before continuing to read this document any further.
How To? ▲ ▼
- Access The Chart Of Accounts In XERO
- Access The Tracking Categories In XERO
- Add And Configure A Location Group To Connect To XERO
- Assign/Map XERO Accounts
- Assign/Map XERO Tracking Categories
- Create A XERO App For An API Connection
- Export From swiftpos Into XERO
- Export The Chart Of Accounts in XERO
- Get Started
- Import The Chart Of Accounts Into swiftpos
- Import The Chart Of Accounts into XERO
- Import Tracking Categories Into swiftpos
- Signup For A 30 Day Free Trial In XERO
How To Get Started? ▲ ▼
Review the following:
Do as follows:
- In addition to the steps outlined for the XERO GL Interface, do as follows:
- Ensure the steps outlined in HERE have been completed.
-
- In the XERO Test environment create Tracking Categories to mirror what the Venue already has configured in XERO, or is intending to configure. Refer to XERO Articles on Tracking Categories for more information.
- Import the Tracking Categories into swiftpos for each of the Location Groups listed in the Location Group Settings tab. Refer to How To Import Tracking Categories Into swiftpos for more information.
- Ensure all the Tracking Categories have been assigned/mapped in the Account assignment/mapping tabs* where appropriate to swiftpos Location/Media, Location/Master Group combinations and Locations. Refer to How To Assign/Map XERO Tracking Categories for more information.
- Export Sale, Stock Movement, Supplier Invoice and Terminal Cash Off Variance related data to XERO. Ensure both the manual and automatic (via the End of Day process) export of data are tested. Ensure the Tracking Categories, that have been assigned/mapped, are being imported into XERO with the data correctly. Refer to How To Export From swiftpos Into XERO for more information.
- Refer HERE for an example of a Supplier Invoice imported into XERO with Tracking Category information included.
Notes ...
The first time the XERO Export runs successfully as part of the End of Day process, all Transactions that are NOT flagged as Exported, will be exported and uploaded into XERO. This will mean that immediately after the EOD has processed, there should not be any Trading Dates available for export, when viewed in the Export screen, for each of the Location Groups (Venues) that have the XERO Export option selected in the End of Day Options screen.
* It may be necessary to enlist the assistance/expertise of an accountant to ensure that in XERO, all Tracking Categories are correct and appropriately configured for the Venue. Also, that all Tracking Category assignments/mappings are done in the Account assignment/mapping tabs are correct.
- Ensure the steps outlined in HERE have been completed.
- When Testing the Interface in a Test environment, in addition to the steps outlined for the XERO GL Interface, do as follows:
- In the XERO Test environment create Tracking Categories to mirror what the Venue already has configured in XERO, or is intending to configure. Refer to XERO Articles on Tracking Categories for more information.
- Import the Tracking Categories into swiftpos for each of the Location Groups listed in the Location Group Settings tab. Refer to How To Import The Tracking Categories Into swiftpos for more information.
- Assign/Map the imported XERO Tracking Categories to swiftpos Location/Media, Location/Master Group combinations and Locations. Refer to How To Assign/Map XERO Tracking Categories for more information.
- Export Sale, Stock Movement, Supplier Invoice and Terminal Cash Off Variance related data to XERO. Ensure both the manual and automatic (via the End of Day process) export of data are tested. Ensure the Tracking Categories that have been assigned/mapped are being imported into XERO with the data correctly. Refer to How To Export From swiftpos Into XERO for more information.
- Refer HERE for an example of a Supplier Invoice imported into XERO with Tracking Category information included.
Screens ▲ ▼
Settings Screen ▲ ▼
To access select the Settings option in the Xero Pro menu in Data Portal. Provides a Venue with the ability to configure the settings required to establish a connection to XERO, as well as import the Chart of Accounts and Tracking Categories from XERO, and assign/map these to swiftpos Location/Media combinations, Location/Master Group combinations and Locations.
Account Assignment / Mapping Tabs ▲ ▼
- Cost of Sales Accounts
- Discount Accounts
- Inventory Accounts
- Freight Accounts
- Media Clearing Accounts
- Purchase Accounts
- Sales Accounts
- Surcharge Accounts
- Rounding Accounts
- Tax Collected Accounts
- Tax Paid Accounts
Notes...
It is recommended that all rows, in each of the tabs, be assigned/mapped to an Account.
Also, the values of the Tracking Categories listed, in each of the tabs above, are as they were when last imported from XERO. To view the most up to date values, re-import the Tracking Categories. If no Tracking Categories have been configured in XERO then the columns headings, in each of the tabs above, will default to Tracking Category 1 & 2.
Media Clearing Accounts Tab ▲ ▼
Example of Account & Tracking Category (Region & Country columns) assignments/mappings for one Location
Used to assign/map XERO Accounts and/or Tracking Categories to swiftpos Location/Media combinations.
Header Section
- By Location Group - Select from the drop down list of available Location Groups (Venues).
- Clearing Account - Select from the drop down list the XERO Account that will be used to assign/map to the swiftpos Location/Media combination.
Apply To
Use to assign/map the selected XERO Account to the rows in the grid by using one of the following options:
- Selected Rows - Select to assign/map to all rows that are currently selected in the grid.
- Unassigned Rows - Select to assign/map to all rows that are currently DO NOT have an Account assigned/mapped in the grid.
- Selected Location - Select to assign/map to all rows in the grid that are associated with a selected Location.
- Copy Location - Select to copy the assignments/mappings of a selected Location to another.
Grid Section
Displays a list of Location/Media combinations that are required to be assigned/mapped to a XERO Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Media - Displays the swiftpos Media.
- Clearing Account - Displays/Select the XERO Account from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Cost Of Sales Accounts Tab ▲ ▼
Example of Account assignments/mappings for one Location
Used to assign/map XERO Cost of Sales Accounts and/or Tracking Categories to swiftpos Location/Master Group combinations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Location/Master Group combinations that are required to be assigned/mapped to a XERO Cost of Sales Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Master Group - Displays the swiftpos Master Group.
- Cost of Sales Account - Displays/Select the XERO Cost of Sales Account from the drop down list that is to be assigned/mapped to the swiftpos Location/Master Group combination.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Sales Accounts and/or Tracking Categories to swiftpos Location/Master Group combinations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Location/Master Group combinations that are required to be assigned/mapped to a XERO Sales Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Master Group - Displays the swiftpos Master Group.
- Sales Account - Displays/Select the XERO Sales Account from the drop down list that is to be assigned/mapped to the swiftpos Location/Master Group combination.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Purchase Accounts and/or Tracking Categories to swiftpos Location/Master Group combinations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Location/Master Group combinations that are required to be assigned/mapped to a XERO Purchase Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Master Group - Displays the swiftpos Master Group.
- Purchase Account - Displays/Select the XERO Purchase Account from the drop down list that is to be assigned/mapped to the swiftpos Location/Master Group combination.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Inventory Accounts and/or Tracking Categories to swiftpos Location/Master Group combinations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Location/Master Group combinations that are required to be assigned/mapped to a XERO Inventory Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Master Group - Displays the swiftpos Master Group.
- Inventory Account - Displays/Select the XERO Inventory Account from the drop down list that is to be assigned/mapped to the swiftpos Location/Master Group combination.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop-down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Freight Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Freight Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Freight Account - Displays/Select the XERO Freight Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Surcharge Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Surcharge Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Surcharge Account - Displays/Select the XERO Surcharge Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Discount Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Discount Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Discount Account - Displays/Select the XERO Discount Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Rounding Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Rounding Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Rounding Account - Displays/Select the XERO Rounding Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Tax Collected Accounts Tab ▲ ▼
Example of Account assignments/mappings for one Location
Used to assign/map XERO Tax Collected Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Tax Collected Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Tax Collected Account - Displays/Select the XERO Tax Collected Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of Account assignments/mappings for one Location
Used to assign/map XERO Tax Paid Accounts and/or Tracking Categories to swiftpos Locations.
Header Section
Refer HERE for more information.
Apply To
Refer HERE for more information.
Grid Section
Displays a list of Locations that are required to be assigned/mapped to a XERO Tax Paid Account and/or Tracking Categories.
- Location - Displays the swiftpos Location.
- Tax Paid Account - Displays/Select the XERO Tax Paid Account from the drop down list that is to be assigned/mapped to the swiftpos Location.
- Region (Tracking Category 1) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
- Country (Tracking Category 2) - Displays/Select the XERO Tracking Category from the drop down list that is to be assigned/mapped to the swiftpos Location/Media combination.
Example of the Accounts tab after importing the Chart of Accounts from XERO.
Notes ...
For Venues with multiple Locations, they may consider creating Location specific Accounts in XERO.
Header Section
- By Location Group - Select from the drop down list of available Location Groups (Venues).
Grid Section
Displays a list of XERO Accounts and their attributes as imported from XERO, and which can then be selected when assigning/mapping Accounts in the Account Assignment/Mapping tabs to the right. The grid displays the following columns:
- Xero Account
- Description
- Type
- Tax Type
- Status
Notes ...
The values of the Account attributes listed above are as they were when last imported from XERO. To view the most up to date values, re-import the Chart of Accounts.
Footer Section
- Delete Row - Select to delete the currently selected row in the grid.
Example Of Accounts In XERO
The following can be used as a guide when configuring Accounts in XERO:
Category | Type | Account | Purpose | Tax Code |
Asset | Current Asset | Undeposited Funds | An account to which Cash payments/refunds from sales made can be posted. | BAS Excluded |
Clearing Account | An account to be used as a default account for the assigning/mapping of swiftpos Location/Media combinations. | BAS Excluded | ||
Trade Debtors | An Account to which Customer/Member Account Charges/Payments can be posted. | BAS Excluded | ||
Inventory | Inventory – Accounts to which Stock Adjustments/Stocktake/Purchases/Sales related transaction data can be posted. | BAS Excluded | ||
Liability | Current Liability | GST Collect/Paid | An Account to which GST Collected and Paid can be posted. | BAS Excluded |
Revenue | Revenue | Sales | Accounts to which income/revenue from sales made can be credited. | GST on Income |
Expense | Direct Costs | COGS | Accounts to which the Cost of Goods from sales can be posted. | BAS Excluded |
Stock Adjustments | Accounts to which Stocktake and Stock Adjustments (Receipts, Adjustments, Damaged Goods, Returns, Promotions and Wastage) generated transaction data can be posted. | BAS Excluded | ||
Expense | Freight | An Account to which Supplier Invoice related Freight Charges can be posted. | GST Free Expense | |
Discounts | An Account to which Supplier Invoice related Discounts can be posted. | GST Free Expense | ||
Rounding | An Account to which Supplier Invoice related Rounding/Misc Charges can be posted. | GST Free Expense | ||
Surcharges | An Account to which Supplier Invoice related Surcharges can be posted. | GST Free Expense | ||
Unders & Overs | An Account to which variances in POS Terminal Cash Offs can be posted. | GST Free Expense |
Notes ...
For Venues with multiple Locations, they may choose to create Location specific Accounts. Obviously this list will vary from Venue to Venue and will also be dependent on the Venue's specific Chart of Accounts (Account List). It may be necessary to enlist the assistance/expertise of an accountant to ensure that in XERO, all Accounts are correct and appropriately configured for the Venue.
Location Group Settings Tab ▲ ▼
Refer to Add And Configure A Location Group To Connect To XERO for more information.
Grid Section
Displays a list of Location Groups that are currently available to be selected when exporting to XERO. These are listed along with their:
- Organisation - Displays the XERO Organisation the Location Group is associated with.
- Venue ID - Displays Location Group's ID.
- Client ID - Displays the Client ID that is being used to establish a connection to the XERO Organisation.
- Client Secret - Displays the Client Secret that is being used to establish a connection to the XERO Organisation.
- Redirect URL - Displays the Redirect URL that is being used to establish a connection to the XERO Organisation.
- Test - Select to initiate a test of the connection credentials entered above.
- Cash Basis Report - Select to ensure the export of data supports Cash Basis Reporting.
Notes ...
When the Cash Basis Report option is selected, XERO Pro logs will include the text "with the Cash Basis Reporting option selected"
Footer Section
- Add Row - Select to add row in the grid.
- Delete Row - Select to delete the currently selected row in the grid.
- Import Chart of Accounts - Refer to How To Import The Chart Of Accounts for more information.
- Import Tracking Categories - Refer to How To Import The Tracking Categories for more information.
What Else? ▲ ▼
Examples of exported XERO Pro data for:
Supplier Invoices With Tracking Categories ▲ ▼
End of article ▲