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.
A sync pulls or pushes data for a connected company. Each sync creates jobs per data model.
Lifecycle
- Trigger — start a sync (
POST /v4/core/companies/{company_id}/syncs).
- Monitor — list sync history and jobs.
- Cancel — stop a running sync.
- Retry — re-run a completed sync.
Response envelope
Successful JSON responses are wrapped as:
{
"data": { ... },
"request_id": "uuid"
}
Sync object
| Field | Type | Description |
|---|
id | string | Sync ID. |
companyId | integer | null | Company ID. |
integrationType | enum | Integration type (e.g. NETSUITE). |
dataModels | array | Data models included in this sync. |
configMode | enum | READ, CREATE, UPDATE, etc. |
fullSync | boolean | Whether this was a full sync. |
syncType | enum | MANUAL or AUTO_SYNC. |
status | enum | SUCCESS, RUNNING, FAILED, or PARTIAL_SUCCESS. |
jobCounts | object | Job status counts (total, success, failed, etc.). |
dataModelCounts | object | Per-data-model status counts. |
startTime | string | null | Sync start time (ISO 8601). |
endTime | string | null | Sync end time (ISO 8601). |
createdAt | string | Creation timestamp (ISO 8601). |
{ sync: { id, dataModelsSyncing } } only.
Job object
| Field | Type | Description |
|---|
id | string | Job ID. |
dataModel | enum | Data model for this job. |
status | enum | CREATED, RUNNING, SUCCESS, FAILED. |
jobType | enum | PULL, PUSH, or CUSTOM. |
configMode | enum | Config mode for this job. |
recordsSynced | integer | null | Number of records synced. |
retryCount | integer | Retry count. |
parentJobId | string | null | Parent job ID, if any. |
errorCode | string | null | Error code when failed. |
errorMessage | string | null | Error message when failed. |
errorResponse | object | null | Error details when failed. |
startTime | string | null | Job start time (ISO 8601). |
endTime | string | null | Job end time (ISO 8601). |
createdAt | string | Creation timestamp (ISO 8601). |
