Skip to main content
Preview category and pending corrections

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Body

application/json
category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice
supplier_id
string<uuid> | null
recipient_id
string<uuid> | null
invoice_number
string
Required string length: 1 - 255
title
string | null
Maximum string length: 2000
issued_date
string
Pattern: ^\d{4}-\d{2}-\d{2}$
due_date
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
currency_code
string
Pattern: ^[A-Z]{3}$
total_amount_including_vat
string
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
total_amount_excluding_vat
string | null
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
original_currency_code
string | null
Pattern: ^[A-Z]{3}$
currency_conversion_rate
string
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
delivery
object | null
credit_note_invoice_reference
string | null
Maximum string length: 2000
payment_reference
string | null
Maximum string length: 2000
bank_account_number
string | null
Maximum string length: 2000
order_references
string[]
Maximum array length: 50
Required string length: 1 - 2000
buyer_reference
string | null
Maximum string length: 2000
seller_reference
string | null
Maximum string length: 2000
contract_reference
string | null
Maximum string length: 2000
project_reference
string | null
Maximum string length: 2000
accounting_cost
string | null
Maximum string length: 2000
line_items
object[]
Required array length: 1 - 500 elements
supplier_snapshot
object | null
recipient_snapshot
object | null
payment_override
object | null
extraction_confirmed
boolean
line_item_changes
object
matched_invoice_ids
string<uuid>[]
Maximum array length: 50

Response

Advisory category plan.

category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice
changes
object[]
required
line_changes
object[]
required
removed_line_ids
string<uuid>[]
required
parties
object
required
financially_valid
boolean
required
financial_errors
object[]
required
affected_matches
object[]
required
selected_invoice_ids
string<uuid>[]
required
retained_finding_count
integer
required
claim_conflicts
object[]
required
exact_reference_candidates
object[]
required
candidates_truncated
boolean
required
requires_matched_invoice_ids
boolean
required