Skip to main content
Check an invoice against agreements

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.

idempotency-key
string

Optional protection for safely retrying a request after a timeout or lost response. Choose a unique value (for example, a UUID) for each action and reuse it with the same input when retrying. Omit it for a normal request.

Required string length: 1 - 200
Pattern: ^[\x21-\x7e]+$

Path Parameters

id
string<uuid>
required

Body

application/json
agreement_ids
string<uuid>[]

Omit to check every currently eligible matched agreement.

Required array length: 1 - 20 elements

Response

Replay of an Idempotency-Key. The original workflow run is returned.

workflow_run_id
string<uuid>
required