Codat · Schema

Sync status

Represents the status of a managed bank feed sync.

Unified-API

Properties

Name Type Description
syncId string The unique identifier for the sync.
clientId string The ID of the client associated with the company that owns the source bank account.
companyId string The ID of the company that owns the source bank account.
companyName string The name of the company that owns the source bank account.
dataConnectionId string The ID of the target accounting data connection.
sourceAccountId string The ID of the source bank account from which transactions are fetched.
periodStartUtc string The start of the sync period.
periodEndUtc string The end of the sync period.
executionStartUtc string The UTC timestamp when the sync started executing.
status string The current status of the sync. Known values are `Started`, `Failed`, `SuccessDataPushed`, `SuccessNoDataPushed`, `PartialSuccessDataPushed`.
executionEndUtc string The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`).
errorMessage string Error message if the sync failed.
errorCode string Error code if the sync failed.
pushOperationKeys array List of write operation keys associated with the sync, if the sync resulted in write attempts.
View JSON Schema on GitHub

JSON Schema

codat-syncstatusresult-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/SyncStatusResult",
  "title": "Sync status",
  "type": "object",
  "description": "Represents the status of a managed bank feed sync.",
  "properties": {
    "syncId": {
      "type": "string",
      "format": "uuid",
      "description": "The unique identifier for the sync."
    },
    "clientId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the client associated with the company that owns the source bank account."
    },
    "companyId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the company that owns the source bank account."
    },
    "companyName": {
      "type": "string",
      "description": "The name of the company that owns the source bank account."
    },
    "dataConnectionId": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the target accounting data connection."
    },
    "sourceAccountId": {
      "type": "string",
      "description": "The ID of the source bank account from which transactions are fetched."
    },
    "periodStartUtc": {
      "type": "string",
      "format": "date-time",
      "description": "The start of the sync period."
    },
    "periodEndUtc": {
      "type": "string",
      "format": "date-time",
      "description": "The end of the sync period."
    },
    "executionStartUtc": {
      "type": "string",
      "format": "date-time",
      "description": "The UTC timestamp when the sync started executing."
    },
    "status": {
      "type": "string",
      "description": "The current status of the sync. Known values are `Started`, `Failed`, `SuccessDataPushed`, `SuccessNoDataPushed`, `PartialSuccessDataPushed`.",
      "example": "SuccessDataPushed"
    },
    "executionEndUtc": {
      "type": "string",
      "format": "date-time",
      "nullable": true,
      "description": "The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`)."
    },
    "errorMessage": {
      "type": "string",
      "nullable": true,
      "description": "Error message if the sync failed."
    },
    "errorCode": {
      "type": "string",
      "nullable": true,
      "description": "Error code if the sync failed."
    },
    "pushOperationKeys": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      },
      "nullable": true,
      "description": "List of write operation keys associated with the sync, if the sync resulted in write attempts."
    }
  },
  "required": [
    "syncId",
    "clientId",
    "companyId",
    "companyName",
    "dataConnectionId",
    "sourceAccountId",
    "periodStartUtc",
    "periodEndUtc",
    "executionStartUtc",
    "status"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/codat-syncstatusresult"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.