Skip to main content
Check an agreement's unchecked invoices

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
invoice_ids
string<uuid>[]

A sample: check only these of the unchecked invoices. Omit to check all of them.

Required array length: 1 - 20 elements

Response

Check admitted. One item evaluates each invoice with this agreement.

workflow_run_id
string<uuid>
required
invoice_count
integer
required

Invoices this check evaluates.

has_more
boolean
required

More unchecked invoices remain than one request admits. Repeat after these finish.