Skip to main content
Preview rereading an invoice or letter

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
read_as
enum<string>
required
Available options:
invoice,
reminder

Response

The current safety plan.

invoice_id
string<uuid>
required
category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice,
reminder,
collection_notice
read_as
enum<string>
required
Available options:
invoice,
reminder
expected_updated_at
string<date-time>
required
can_apply
boolean
required
blockers
enum<string>[]
required
Available options:
source_unavailable,
sent_for_approval,
accounting_state,
dependent_records,
active_work
closes_approval
boolean
required
clears_hold
boolean
required