Sign in
Sync

Latest sync status

Gets the latest sync status

get/companies/{companyId}/sync/commerce/syncs/latest/status

Path parameters

companyIdstring uuid required

Unique identifier for your SMB in Codat.

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

Unique identifier for a company.

Response

Success

companyIdstring nullable

Unique identifier for your SMB in Codat.

syncIdstring nullable

Unique identifier of the sync.

syncStatusCodeinteger

Status code of the sync.

syncStatusstring nullable

Text status of the sync.

errorMessagestring nullable

Error message of the sync.

syncExceptionMessagestring nullable

Exception message of the sync.

syncUtcCreated — unresolved $ref
dataPushedboolean

Boolean of whether the sync resulted in data being pushed.

Changes

Changed in 2 of the 52 revisions of this API.11

  • 9bd87def99147See the full diff
    • ○

      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

  • 83c1801e91f74See the full diff
    • ○

      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 500

      response-non-success-status-added

    • ○

      added the non-success response with the status 503

      response-non-success-status-added