Accounting platform selection

🚧

Sync for Commerce: beta testing

Note that Sync for Commerce is in beta testing.

📘

Use our Swagger to follow this guide

All the endpoints mentioned in this guide are available in our Sync for Commerce Swagger. You can use it to try the API requests from this guide directly in your browser. Before you use Swagger, make sure to authenticate.

Within your UI, present the merchant with a list of supported accounting platforms they can connect to. On select, they should be redirected to their accounting platform and prompted to log in in order to authorize access to their accounting data.

Record the Codat platform key for the selected platform, you will need it for the next build stage, Merchant configuration. Here is a list of all the accounting integrations currently supported by Sync for Commerce and the associated platform keys:

Accounting platform name

Codat platform key

Xero (UK only)

gbol

QuickBooks Online (UK only)

qhyg

FreeAgent

fbrh

We recommend that you populate your UI with branded logos of the selected accounting platform. To retrieve them, perform the following request using the relevant platform key:

GET /config/integrations/{platformKey}/branding

🚧

Incorrect platform selection

If your merchant accidentally selects the wrong accounting package, you can resolve this by deleting the dataConnection for the incorrectly selected accounting software and returning them to the accounting software selection within your application.


Did this page help you?