Skip to main content
Retrieve a sync

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Path Parameters

id
string<uuid>
required
sync_id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as period.from. id is always returned. Fields: id, integration_id, trigger, mode, period, scope, max_files, status, coverage, discovery, items, invoices, retryable, retry_blocked_by, failure, created_by, created_at, finished_at.

Response

The sync.

id
string<uuid>
required

Also the workflow run id: progress, items and cancel use it.

integration_id
string<uuid>
required
trigger
enum<string>
required
Available options:
manual,
scheduled
mode
enum<string>
required

period reads a requested date range; incremental continues from the last sync.

Available options:
period,
incremental
period
object | null
required

Invoice dates read: from is inclusive, to is exclusive.

scope
object
required

The scope this run used, frozen when it started.

max_files
integer | null
required
status
enum<string>
required
Available options:
queued,
running,
completed,
failed,
cancelled
coverage
enum<string>
required

partial: the run ended without reading everything it was asked to (discovery stopped early, invoices were deferred, or it was cancelled). retryable says whether a retry can complete it.

Available options:
in_progress,
full,
partial
discovery
object
required

Finding the invoices to import; items then import them one by one.

items
object
required
invoices
object
required
retryable
boolean
required

POST …/retry would resume discovery or re-queue failed invoices.

retry_blocked_by
enum<string> | null
required
Available options:
superseded,
configuration_changed,
integration_disabled,
active_sync,
null
failure
object | null
required
created_by
object | null
required
created_at
string<date-time>
required
finished_at
string<date-time> | null
required