Sync

Initiate sync for specific range

Initiate a sync for the specified start date to the specified finish date in the request payload.

post/meta/companies/{companyId}/sync/commerce/historic

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

Example:8a210b68-6988-11ed-a1eb-0242ac120002

Unique identifier for a company.

Request body

Response

Success

companyIdstring guid

Unique identifier for your SMB in Codat.

commerceSyncIdstring guid

Unique identifier for the sync in Codat.

syncStatusCodeinteger

Numerical status code sync of the company data.

syncStatusstring nullable

Status of the sync of the company data. This is linked to status code.

errorMessagestring nullable

Friendly error message for the sync operation.

syncExceptionMessagestring nullable

Exception message for the sync operation.

syncUtcCreated — unresolved $ref

dataPushedboolean

Boolean indicator for data being pushed during a sync operation.

Changes

Changed in 9 of the 52 revisions of this API.4318

Apr 15, 20267d9157f492291See the full diff
- ▲
  the response property dataConnections/items/integrationKey became optional for the status 200
  response-property-became-optional
Sep 26, 2024c5556c94892f1See the full diff
- ▲
  the response property dataConnections/items/dataConnectionErrors became nullable for the status 200
  response-property-became-nullable
Sep 23, 20249b41b4272c072See the full diff
- ▲
  the response property dataConnections/items/connectionInfo became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property dataConnections/items/lastSync became nullable for the status 200
  response-property-became-nullable
Sep 23, 2024005ca959ca7b1See the full diff
- ●
  removed the optional property dataConnections/items/additionalProperties from the response with the 200 status
  response-optional-property-removed
May 24, 2024eea1ac136a3f2See the full diff
- ○
  added the optional property dataConnections/items/dataConnectionErrors/items/resolvedOnUtc to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property dataConnections/items/dataConnectionErrors/items/status to the response with the 200 status
  response-optional-property-added
Feb 13, 20249bd87def99148See the full diff
- ○
  added the optional property validation to the response with the 400 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 401 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 402 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 403 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 429 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 500 status
  response-optional-property-added
- ○
  added the optional property validation to the response with the 503 status
  response-optional-property-added
Dec 21, 202303e681fe82971See the full diff
- ●
  added the new Expense enum value to the dataConnections/items/sourceType response property for the response status 200
  response-property-enum-value-added
Dec 21, 2023a5aefe1f126c1See the full diff
- ●
  added the new BankFeed enum value to the dataConnections/items/sourceType response property for the response status 200
  response-property-enum-value-added
Oct 23, 202383c1801e91f78See the full diff
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 402
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the non-success response with the status 404
  response-non-success-status-added
- ○
  added the non-success response with the status 429
  response-non-success-status-added
- ○
  added the non-success response with the status 500
  response-non-success-status-added
- ○
  added the non-success response with the status 503
  response-non-success-status-added

Full history