Skip to main content
Record a claim recovery

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
amount
string

Net amount paid back, excluding VAT. Omit it, with currency_code, to take what is left of the credit note, in its currency.

Maximum string length: 100
Pattern: ^\d+(?:\.\d+)?$
currency_code
string
Pattern: ^[A-Z]{3}$
comment
string | null
Maximum string length: 2000
credit_note_id
string<uuid> | null

The credit note invoice behind the recovery, from one of the claim's suppliers. A credit note backs at most one recovery per claim, and the recoveries on one note never add up to more than its net amount.

Response

The recorded recovery. Retrying records another one.

id
string<uuid>
required
claim_id
string<uuid>
required
amount
string
required
currency_code
string
required
comment
string | null
required
credit_note_id
string<uuid> | null
required

The credit note invoice behind the recovery, from one of the claim's suppliers. Null without one, or when your access limits hide it.

credit_note_number
string | null
required

Invoice number of the credit note, or null without one or when it is hidden.

source
enum<string>
required

automatic: Watchdog recorded it, as the credit note settles the amount (see basis). An edit makes it manual.

Available options:
manual,
automatic
basis
enum<string> | null
required

exact_note: the note names an alerted invoice and equals its alerts. full_reversal: it reverses the whole invoice. Null when manual.

Available options:
exact_note,
full_reversal,
null
created_by_user_id
string | null
required

Who recorded it; null for an automatic recovery or a deleted user.

created_at
string<date-time>
required
updated_at
string<date-time>
required