1. Overview

The ezyCollect Sync interface package is used to integrate customer ERP data with the ezyCollect cloud services. The CSV option in ezyCollect Sync allows data to be prepared on the client-server into a .csv format which gets picked up from a designated folder and uploaded to the ezyCollect service.

Client side requirements - Defining your CSV Integration:

  • Before you go through the process below, please ensure that you (or someone from your IT team or third party partner/provider) can generate the CSV file from your ERP/Accounting software. This may incur additional costs and you will need to discuss this with your relevant team/partner.

  • The process of generating these CSV files will and should be automated to ensure that your data is up-to-date with ezyCollect.

  • You will need to provide us support contact from your side should there be any issues validating or syncing your data to ezyCollect. Please note that ezyCollect will provide support based on the plan you have signed up for.

See CSV Definition and Validation v2 (XLSX) for data required.

2. System Requirements

To get started with the installation, enter your email address and follow the prompts in the following link:


The following are the minimum system requirements:

  • Windows Server 2008 R2 or later

  • 500MB installed file drive space

  • Microsoft .Net 4.0 framework or later

  • Internet access (port 80)

3. Installation

To install the package, run the installer and follow the prompts:

Select “Typical”.

Select “Launch ezyCollect Sync”, then “Finish” to open the user interface.

There will be a start-up shortcut to launch the application as well.

4. Setting up CSV Configuration

Start off by opening the user interface “EzyCollect.Sync.UI.exe”.

To create a new configuration:

  • Enter a valid API key. The connection details cannot be edited until a valid API key has been entered. (You will be provided with the API key login credentials part of the installation process, contact sales@ezycollect.com.au if you haven’t received one)

  • Configure the CSV settings by clicking on “Configure Connection”.

  • Specify a folder where the .csv files will exist.

  • There is also an option to select a batch file that is used to generate the .csv files. This batch file can be left out if files are generated through a separate process however if you have a batch file that builds the .csv files then it will be triggered through the sync process.


When generating .csv files, it is important to maintain the naming conventions and header fields as per template samples. If the file names or headings are not correct the sync process will generate an error.

If you need assistance in extracting and creating the CSV files, please contact customersuccess@ezycollect.com.au.

The following files need to be generated:

Customer.csv – containing customer master records. Example here:

Contact.csv – containing contact details . Note: all contacts MUST have an associated customer. Example here:

Transaction.csv – this has all open transactions including unpaid invoices and unapplied payments. Example here:

Item.csv – these are the transaction details. Example here:

5. Interface Service

A service will be created and started by the installer. This is called “ezyCollect Sync Client”

This service will look for any projects and initiate a health check with the ezyCollect service API.


There needs to be a project created in step 4 to initiate any communication with the API.

To check the process logs, please go to the System Logs (step 7).

6. Viewing System Logs

System logs can be found in the following folder:

“C:\ProgramData\ezyCollect\ezyCollect Sync\logs”.

A separate log file will be generated per day for the service and each separate component e.g. “synchandler-odbc...”.

The main service log “sync-runner[date].txt” will provide an overview of all top level commands executed with the start and finish times.

The individual component logs will contain details on the specific actions that they are designed to carry out e.g. sync query.


CSV Definition and Validation v2 (XLSX)

Important Note: Please follow the CSV data format as this is case sensitive.

Did this answer your question?