Skip to main content
Check the sign-in sending goes through

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

Response

The resource.

id
string<uuid>
required
provider
string
required
name
string
required
status
enum<string>
required

Result of the latest test or sync. not_tested until the first test.

Available options:
connected,
invalid_credentials,
permission_denied,
server_error,
not_tested
syncable
boolean
required

Enabled and in a status that allows a sync to start.

enabled
boolean
required
auto_sync
boolean
required

Automatic invoice import: after capture for SFTP, otherwise on the schedule sync_interval sets and through supported webhooks.

sync_interval
enum<string>
required

How often automatic sync reads new invoices: nightly, hourly or every_15_minutes. Every night it also rereads recent invoices for changes. Other than nightly only where the provider supports it (capabilities.sync_interval); applies while auto_sync is on.

Available options:
nightly,
hourly,
every_15_minutes
auto_create_companies
boolean
required

Whether a company the login reaches becomes a workspace company of its own when its first invoice arrives, if nobody has linked it (listCompanyLinks): the one company with its registration number, or else a new company from the name, country and registration number the provider states. A company whose identity is incomplete, or that a workspace company could already be (one with its number, or one without a number yet), waits without a company as before. Only for a login that reaches several companies (discovers_companies).

capture
object | null
required
scope
object
required
credentials
object
required

Secret values are never returned.

realtime
object
required
rate_limited_until
string<date-time> | null
required

The provider asked Watchdog to pause requests until this time.

last_successful_sync
object | null
required

Latest sync that completed with full coverage.

vocabulary_synced_at
string<date-time> | null
required

When the accounts, VAT codes and dimensions, and the supplier register where the provider has one, last synced completely.

capabilities
object
required

What the integration does, each switched on or off with PATCH, and whether it works. Null when its provider cannot, or the organization does not have the module (purchase orders, or accounts payable for accounting_data_read, invoices_write and coding_history).

active_sync_id
string<uuid> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required