Skip to main content
Accept a suggested instruction edit

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
suggestion_id
string<uuid>
required

A pending suggestion of this agreement.

Response

The resource.

id
string<uuid>
required
title
string | null
required
status
enum<string>
required

draft (being set up), active (Watchdog checks invoices against it) or archived (no longer checked). It does not say whether the contract term is in force: use expiration_date, renewal_action or the valid_on filter for that.

Available options:
draft,
active,
archived
effective_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
expiration_date
string | null
required
Pattern: ^\d{4}-\d{2}-\d{2}$
suppliers
object[]
required

Suppliers the agreement covers. An empty array matches no invoices.

Example:
recipients
object[]
required

Recipients the agreement covers. An empty array means any recipient.

Example:
tags
object[]
required

Assigned tags.

Example:
projects
object[]
required
owner_user_id
string | null
required
Required string length: 1 - 200
Pattern: ^[A-Za-z0-9_-]+$
owner
object | null
required
readiness
object
required

Whether the agreement can be checked. reasons lists what is missing when ready is false.

renewal_action
object
required

The next renewal action from the renewal terms. A null deadline means no dated action is known.

version
integer
required
Required range: x >= 0
created_at
string<date-time>
required
updated_at
string<date-time>
required
alert_summary
object
required

All alerts of this agreement, as GET /v1/alerts/metrics?agreement_ids={id} reports them.

relationships
object
required
applicability
object | null
required

Extra invoice-matching conditions on reference and delivery fields. Null means none.

renewal
object | null
required
instructions
string | null
required

Extra context for compliance checks of this agreement.

alert_settings
object
required

Which extra alerts to raise for this agreement. Replaces the whole object; omitted flags are false.

matching_settings
object
required

Smart matching settings. Replaces the whole object; omitted values are false or null.

created_by_name
string | null
required
created_by_deleted
boolean
required

The account that created the agreement was deleted. created_by_name keeps their name, or is null once the account is anonymised.

suggested_entities
object
required