Codat · Example Payload

Codat Get Company Syncsettings Example

Unified_API

Codat Get Company Syncsettings Example is an example object payload from Codat, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "get-company-syncSettings",
  "method": "GET",
  "path": "/companies/{companyId}/syncSettings",
  "summary": "Get company sync settings",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Example",
      "example": {
        "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
          }
        ],
        "overridesDefaults": true
      }
    }
  ]
}