action codat_post_sync_info {
  label: "Refresh company info"
  description: "Initiates the process of synchronising basic info for a company"
  provider: codat
  method: POST
  path: "/companies/{companyId}/data/info"
  encoding: json
  output: {
    type: "object"
    required: ["companyId", "connectionId", "id", "isCompleted", "isErrored", "progress", "requested", "status"]
    properties: {
      companyId: {
        type: "string"
        format: "uuid"
      }
      completed: {
        type: "string"
        description: "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
      }
      connectionId: {
        type: "string"
        format: "uuid"
      }
      dataType: {
        type: ["string", "null"]
      }
      datasetLogsUrl: {
        type: ["string", "null"]
      }
      errorMessage: {
        type: ["string", "null"]
      }
      id: {
        type: "string"
        format: "uuid"
      }
      isCompleted: {
        type: "boolean"
      }
      isErrored: {
        type: "boolean"
      }
      progress: {
        type: "integer"
        format: "int32"
      }
      requested: {
        type: "string"
        description: "In Codat's data model, dates and times are represented using the <a class=\"external\" href=\"https://en.wikipedia.org/wiki/ISO_8601\" target=\"_blank\">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:\n\n```\n2020-10-08T22:40:50Z\n2021-01-01T00:00:00\n```\n\n\n\nWhen syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:\n\n- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`\n- Unqualified local time: `2021-11-15T01:00:00`\n- UTC time offsets: `2021-11-15T01:00:00-05:00`\n\n> Time zones\n> \n> Not all dates from Codat will contain information about time zones.  \n> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced."
      }
      status: {
        type: "string"
        enum: ["Initial", "Queued", "Fetching", "MapQueued", "Mapping", "Complete", "FetchError", "MapError", "InternalError", "ProcessingQueued", "Processing", "ProcessingError", "ValidationQueued", "Validating", "ValidationError", "AuthError", "Cancelled", "NotSupported", "RateLimitError", "PermissionsError", "PrerequisiteNotMet"]
      }
      validationInformationUrl: {
        type: ["string", "null"]
      }
    }
  }
}