v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-045244247.9 KB
Companies

Set company sync settings

Set the sync settings for a specific company.

post/companies/{companyId}/syncSettings

Request body

companyIdstring uuid required

Unique identifier for your SMB in Codat.

overridesDefaultsboolean required

Set to True if you want to override default sync settings.

Example request

{
  "companyId": "8a210b68-6988-11ed-a1eb-0242ac120002",
  "settings": [
    {
      "dataType": "invoices",
      "fetchOnFirstLink": true,
      "syncSchedule": 24,
      "syncOrder": 0,
      "syncFromUtc": "2020-01-01T12:00:00.000Z",
      "syncFromWindow": 24,
      "monthsToSync": 24,
      "isLocked": true
    }
  ]
}

Response

No Content