Skip to main content
GET
cURL

Authorizations

X-Api-Key
string
header
required

Your fat_… integration key. Create one in Settings → Integrations → API Keys.

Path Parameters

id
string
required

Response

OK

id
string
required
invoiceNumber
string
required
documentType
enum<string>
required

Document identity. Invoice and CreditNote are standard tax documents; the SelfBilling* variants are issued by the buyer on the supplier's behalf. On /v1/credit-notes endpoints, CreditNote is applied regardless of the value sent.

Available options:
Invoice,
CreditNote,
SelfBillingInvoice,
SelfBillingCreditNote
Example:

"Invoice"

status
enum<string>
required

Document status: Draft (created, not submitted), Pending (queued or being delivered over Peppol), Sent (delivered), DeliveryFailed (submission failed — see submissionError), Received (inbound purchase document).

Available options:
Draft,
Pending,
Sent,
DeliveryFailed,
Received
Example:

"Draft"

issueDate
string
required
dueDate
string | null
required
currency
string
required
seller
object
required
buyerName
string
required
totalNetAmount
number<double>
required
totalVatAmount
number<double>
required
totalPayableAmount
number<double>
required
note
string | null
required
lines
object[]
required