Skip to main content
Preview a matching refresh

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
effective_date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
expiration_date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
supplier_ids
string<uuid>[]

Complete supplier selection. An empty array matches no invoices.

recipient_ids
string<uuid>[]

Complete recipient selection. An empty array removes the recipient restriction.

applicability
object | null
matching_settings
object

Stored smart-matching configuration. Replaces the complete object; omitted values default to false and null. Saving does not run matching.

Response

Refresh impact.

invoices
object
required
alerts
object
required
counts_exact
boolean
required

False when smart matching applies under the proposed configuration: removed is then a minimum and added a maximum.

smart_matching_changed
boolean
required

The proposed smart-matching toggle or criterion differs from the stored one. With smart matching enabled, a refresh then re-judges every existing match.

etag
string
required

The agreement ETag (not a preview validator) the counts were computed against. Send it as If-Match when saving the configuration. Also returned in the ETag header.