---
title: "Initiate new sync"
method: POST
path: "/companies/{companyId}/sync/commerce/latest"
tags: ["Sync"]
---

# Initiate new sync

`POST /companies/{companyId}/sync/commerce/latest`

Run a Commerce sync from the last successful sync up to the date provided (optional), otherwise UtcNow is used.\r\nIf there was no previously successful sync, the start date in the config is used.

## Path parameters

- `companyId` string, uuid, required — Unique identifier for your SMB in Codat.

## Request body

- SyncToLatestArgs
  - `syncTo` Created — unresolved $ref

## Response `200`

Success

- SyncSummary
  - `syncDateRangeUtc` object
    - `start` Created — unresolved $ref
    - `finish` Created — unresolved $ref
  - `companyId` string, guid — Unique identifier for your SMB in Codat.
  - `commerceSyncId` string, guid — Unique identifier for the sync in Codat.
  - `syncStatusCode` integer — Numerical status code sync of the company data.
  - `syncStatus` string, nullable — Status of the sync of the company data. This is linked to status code.
  - `errorMessage` string, nullable — Friendly error message for the sync operation.
  - `syncExceptionMessage` string, nullable — Exception message for the sync operation.
  - `syncUtc` Created — unresolved $ref
  - `dataConnections` Connection[], nullable — Array of containing objects data connection information for the company.
    - `id` Schema, required — unresolved $ref
    - `integrationId` string, uuid, required — A Codat ID representing the integration.
    - `integrationKey` string — A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future.
    - `sourceId` SourceId, required — unresolved $ref
    - `sourceType` SourceType, required — unresolved $ref
    - `platformName` string, required — Name of integration connected to company.
    - `linkUrl` string, uri, required — The link URL your customers can use to authorize access to their business application.
    - `status` DataConnectionStatus, required — unresolved $ref
    - `lastSync` Created — unresolved $ref
    - `created` string, required — In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example: ``` 2020-10-08T22:40:50Z 2021-01-01T00:00:00 ``` When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information: - Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z` - Unqualified local time: `2021-11-15T01:00:00` - UTC time offsets: `2021-11-15T01:00:00-05:00` > Time zones > > Not all dates from Codat will contain information about time zones. > Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced.
    - `dataConnectionErrors` DataConnectionError[], nullable — unresolved $ref
    - `connectionInfo` object, nullable
  - `dataPushed` boolean — Boolean indicator for data being pushed during a sync operation.

## Other responses

- `400` — The request made is not valid.
- `401` — Your API request was not properly authorized.
- `402` — An account limit has been exceeded. The type of limit is described in the error property: - You have exceeded the 50-company limit that applies to a Free plan. Delete any companies you no longer need and retry the request. - The requested sync schedule is not allowed. You requested an hourly sync schedule but this functionality is not included in the Free plan. - Your Free account is older than 365 days and has expired. Contact support@codat.io.
- `403` — You are using an outdated API key or a key not associated with that resource.
- `404` — One or more of the resources you referenced could not be found. This might be because your company or data connection id is wrong, or was already deleted.
- `429` — Too many requests were made in a given amount of time. Wait a short period and then try again.
- `500` — There is a problem with our server. Please try again later.
- `503` — The Codat API is temporarily offline for maintenance. Please try again later.

---

[API](https://skmtc.net/codatio/apis/codat-sync-commerce.md) · [All operations](https://skmtc.net/codatio/apis/codat-sync-commerce/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/codatio/codat-sync-commerce/revisions/f669e8c3c34f/schema)