Skip to main content
POST
/
core
/
companies
/
{company_id}
/
syncs
Create Sync
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/{company_id}/syncs \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "fullSync": false,
  "isManualSync": true,
  "dataModelsToSync": [
    {
      "dataModel": "INVOICE",
      "syncFrom": "2026-01-01T00:00:00.000Z"
    }
  ]
}
'
{
  "data": {
    "sync": {
      "id": "a2e6fcea-7fb2-4513-9e6c-5b67fc97b019",
      "dataModelsSyncing": [
        "ACCOUNT",
        "INVOICE"
      ]
    }
  },
  "request_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Documentation Index

Fetch the complete documentation index at: https://integrations.docs.commenda.io/llms.txt

Use this file to discover all available pages before exploring further.

Trigger a sync for a connected company.

Request Body

All fields are optional.
FieldTypeDescription
dataModelsToSyncarrayData models to sync, with optional syncFrom.
fullSyncbooleanFull sync flag.
isManualSyncbooleanManual sync flag.
Each dataModelsToSync[] entry:
FieldTypeRequiredDescription
dataModelenumYesData model to sync.
syncFromstringNoHistorical sync start (ISO 8601).

Response

Returns 201 Created with { data: { sync: { id, dataModelsSyncing } }, request_id }.

Authorizations

api_key
string
header
required

Path Parameters

company_id
integer
required

RootFi company ID for the company connection to read or write.

Body

application/json
dataModelsToSync
V4InitSyncDataModel · object[]
fullSync
boolean
isManualSync
boolean

Response

Sync created.

request_id
string
required
data
V4InitSyncResponse · object
required