Get Sync Status

GET https://api.codat.io/companies/:companyId/sync/expenses/syncs/:syncId/status

Once you have pushed data to Codat, you can use the sync status endpoints to check whether the sync was completed successfully and see the details of any errors that may have occurred.

Codat also provides three webhooks which you can subscribe to:

Sync Started: this will be triggered when a sync process for a company starts.
Sync Failed: This will be triggered if there are any failures during the sync process.
Sync Completed: This will be triggered when a sync completes without any failures.

RESPONSES

status: OK

{&quot;companyId&quot;:&quot;bf1e0242-5b7a-418b-a307-9e09dbf9f39a&quot;,&quot;syncId&quot;:&quot;d94311cb-7da5-41a1-981d-a8ac6cc85154&quot;,&quot;syncStatusCode&quot;:2000,&quot;syncStatus&quot;:&quot;Complete&quot;,&quot;errorMessage&quot;:&quot;&quot;,&quot;syncExceptionMessage&quot;:&quot;&quot;,&quot;syncUtc&quot;:&quot;2023-02-02T10:24:32.7701637Z&quot;,&quot;dataPushed&quot;:true}