iotoms Docs

Start an accounting sync

POST
/api/v1/integrations/accounting/connectors/{provider}/sync

Queues an on-demand sync with the connected accounting system and returns immediately with the new sync-log entry. The connector must be CONNECTED. Currently an on-demand sync checks that the stored access still works; track the result in the sync history.

How to use it

  1. Check the connector is CONNECTED with Get accounting connector details.
  2. Start the sync. It runs in the background; the response gives the syncLogId.
  3. Follow the result in List accounting sync history; the connector's lastSyncAt and lastSyncStatus are updated when it finishes.

Authorization

BearerAuth
headerAuthorizationBearer <JWT>

Path Parameters

provider*string

Accounting connector slug, for example zoho-books (from List accounting connectors).

Header Parameters

Response Body

OK

*/*
  1. response
status*string

Outcome of the request: SUCCESS when it worked; errors return an error status with the reason in message.

message*string

Short human-readable message describing the outcome.

data?

The sync-log entry created for the queued sync.

Example Request
curl -X POST 'https://beta.iotoms.com/api/v1/integrations/accounting/connectors/string/sync'
Example Response
{  "status": "string",  "message": "string",  "data": {    "syncLogId": "8a831ce0-fd84-4c14-9c7b-7f1ccc68faec",    "provider": "string",    "syncType": "CONNECTIVITY_CHECK",    "status": "PENDING",    "startedAt": "2019-08-24T14:15:22Z"  }}