Ready to get started?

Learn more or sign up for a free trial:

CData Sync

Replicate Multiple FreshBooks Accounts



Replicate multiple FreshBooks accounts to one or many databases.

CData Sync for FreshBooks is a stand-alone application that provides solutions for a variety of replication scenarios such as replicating sandbox and production instances into your database. Both Sync for Windows and Sync for Java include a command-line interface (CLI) that makes it easy to manage multiple FreshBooks connections. In this article we show how to use the CLI to replicate multiple FreshBooks accounts.

Configure FreshBooks Connections

You can save connection and email notification settings in an XML configuration file. To replicate multiple FreshBooks accounts, use multiple configuration files. Below is an example configuration to replicate FreshBooks to SQLite:

Windows

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>System.Data.SQLite</DatabaseProvider> <ConnectionString>CompanyName=CData;Token=token;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> <TaskSchedulerStartTime>09:51</TaskSchedulerStartTime> <TaskSchedulerInterval>Never</TaskSchedulerInterval> </CDataSync>

Java

<?xml version="1.0" encoding="UTF-8" ?> <CDataSync> <DatabaseType>SQLite</DatabaseType> <DatabaseProvider>org.sqlite.JDBC</DatabaseProvider> <ConnectionString>CompanyName=CData;Token=token;</ConnectionString> <ReplicateAll>False</ReplicateAll> <NotificationUserName></NotificationUserName> <DatabaseConnectionString>Data Source=C:\my.db</DatabaseConnectionString> </CDataSync>

To connect to FreshBooks, you can set the CompanyName and Token connection properties. Alternatively, you can use the OAuth authentication standard.

OAuth can be used to enable other users to access their own company data. To authenticate using OAuth, you will need to obtain the OAuthClientId and OAuthClientSecret by registering an app. See the "Getting Started" chapter of the help documentation for a guide to using OAuth.

Configure Queries for Each FreshBooks Instance

Sync enables you to control replication with standard SQL. The REPLICATE statement is a high-level command that caches and maintains a table in your database. You can define any SELECT query supported by the FreshBooks API. The statement below caches and incrementally updates a table of FreshBooks data:

REPLICATE Clients;

You can specify a file containing the replication queries you want to use to update a particular database. Separate replication statements with semicolons. The following options are useful if you are replicating multiple FreshBooks accounts into the same database:

You can use a different table prefix in the REPLICATE SELECT statement:

REPLICATE PROD_Clients SELECT * FROM Clients

Alternatively, you can use a different schema:

REPLICATE PROD.Clients SELECT * FROM Clients

Run Sync

After you have configured the connection strings and replication queries, you can run Sync with the following command-line options:

Windows

FreshBooksSync.exe -g MyProductionFreshBooksConfig.xml -f MyProductionFreshBooksSync.sql

Java

java -Xbootclasspath/p:c:\sqlitejdbc.jar -jar FreshBooksSync.jar -g MyProductionFreshBooksConfig.xml -f MyProductionFreshBooksSync.sql