Skip to main content
Check an agreement's unchecked invoices

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

Body

application/json
topic_id
string<uuid>
include_checked
boolean
default:false
invoice_ids
string<uuid>[]

Up to 20 of the unchecked invoices to check. Omit to check all of them.

Required array length: 1 - 20 elements

Response

No eligible invoices; nothing started.

workflow_run_id
string<uuid> | null
required
invoice_count
integer
required

Invoices this check evaluates.

Required range: x >= 0
skipped_count
integer
required
Required range: x >= 0