Skip to main content
Add one invoice line

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
line_number
integer
required
Required range: x <= 2147483647
quantity
string
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
unit_price
string
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
total_excluding_vat
string
required
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
description
string | null
Maximum string length: 2000
product_code
string | null
Maximum string length: 2000
unit
string | null
Maximum string length: 2000
discount_rate
string
default:0
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
surcharge_rate
string
default:0
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
vat_rate
string
default:0
Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
period_start
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
period_end
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$
notes
string | null
Maximum string length: 2000

Response

Invoice after the addition.

id
string<uuid>
required
extraction_confirmed
boolean
required
read-only

Explicit human review acknowledgment; independent of extraction confidence and financial validity.

extraction_confirmed_at
string<date-time> | null
required
read-only
extraction_confirmed_by_user_id
string | null
required
read-only
invoice_number
string | null
required
title
string | null
required
category
enum<string>
required
Available options:
invoice,
credit_note,
self_billed_invoice
issued_date
string<date> | null
required
due_date
string<date> | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
deleted_at
string<date-time> | null
required
currency_code
string | null
required
total_amount_excluding_vat
string | null
required

Exact decimal string; retain as decimal text rather than a floating-point number.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
Example:

"1250.00"

total_amount_including_vat
string | null
required

Exact decimal string; retain as decimal text rather than a floating-point number.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
Example:

"1250.00"

financially_valid
boolean
required
read-only

Deterministic arithmetic within a tolerance of 1 currency unit. Does not imply extraction accuracy, compliance, or human approval.

financial_errors
object[]
required
read-only
alert_summary
object
required
supplier_name
string | null
required

Current canonical supplier name. Used by supplier ordering.

recipient_name
string | null
required

Current canonical recipient name. Used by recipient ordering.

Review is recommended for low or medium unconfirmed extraction confidence, an unmatched credit note, or financial invalidity. Uses the same predicate as the review_recommended filter.

extraction_confidence
enum<string>
required

Lowest original header/line confidence from the creating import, when both stages have reliable evidence. Structured, XML and unavailable historical evidence are unknown; manual confirmation does not change this value.

Available options:
high,
mid,
low,
unknown
relationships
object
required

Recorded org-owned links including soft-deleted counterparts. A match does not establish financial resolution.

supplier_id
string<uuid> | null
required

Current canonical supplier ID.

recipient_id
string<uuid> | null
required

Current canonical recipient ID.

supplier_snapshot
object
required

Supplier details captured on the invoice.

recipient_snapshot
object
required

Recipient details captured on the invoice.

payment_terms
string | null
required

Stored printed payment terms, including conditions. Null means unavailable; never inferred from the due date.

invoice_note
string | null
required

Stored invoice-wide note in its original wording, separate from line notes. Null means unavailable; empty text stays empty.

additional_properties
object[] | null
required

Stored named business details with optional source paths. Null means unavailable; [] means inspected with none found. These do not replace financial values.

original_currency_code
string | null
required
currency_conversion_rate
string | null
required

Exact decimal string; retain as decimal text rather than a floating-point number.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
Example:

"1250.00"

original_total_amount_including_vat
string | null
required

Exact decimal string; retain as decimal text rather than a floating-point number.

Maximum string length: 100
Pattern: ^-?\d+(?:\.\d+)?$
Example:

"1250.00"

payment
object
required
delivery
object
required
references
object
required
origin
object
required