Skip to main content
Check a purchase order against its agreement

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

Query Parameters

fields
string[]

Return only these fields; use dots for nested fields, such as agreement.id. Fields: agreement, applicable, coverage, findings, lines, suggestions, dismissed.

Response

The check.

agreement
object | null
required

The agreement compared with; null when the order has none. One the caller cannot see is restricted, with no findings.

applicable
boolean
required

Whether unit_price findings can be applied with updatePurchaseOrder agreement_findings: a saved Watchdog order that is a draft or open.

coverage
object
required
findings
object[]
required

Differences from the agreement. Only unit_price findings can be applied; the others are for review. A fingerprint changes whenever what the finding rests on changes: the line, the order's date or currency, or the agreement price.

lines
object[]
required
suggestions
object[]
required

Agreements the order may belong to, when it has none. None is linked automatically.

dismissed
object[]
required

Suggestions dismissed for this order; leaving one out of rejected_agreement_ids restores it.