Skip to main content
GET
Get Document

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

document_id
string
required

Response

Successful Response

id
string
required
created_at
string<date-time>
required
document_type
enum<string>
default:INVOICE

The type of document: INVOICE, CREDIT_NOTE, or DEBIT_NOTE

Available options:
INVOICE,
CREDIT_NOTE,
DEBIT_NOTE,
SELFBILLING_INVOICE,
SELFBILLING_CREDIT_NOTE
state
enum<string>
default:DRAFT

The current state of the document: DRAFT, TRANSIT, FAILED, SENT, or RECEIVED

Available options:
DRAFT,
TRANSIT,
FAILED,
SENT,
RECEIVED
direction
enum<string>
default:OUTBOUND

The direction of the document: INBOUND (purchases) or OUTBOUND (sales)

Available options:
INBOUND,
OUTBOUND
customer_name
string | null

The company name of the customer/buyer

customer_id
string | null

The unique identifier for the customer in your system

customer_email
string | null

The email address of the customer

purchase_order
string | null

The purchase order reference number

invoice_id
string | null

The unique invoice identifier/number

invoice_date
string<date> | null

The date when the invoice was issued

due_date
string<date> | null

The date when payment is due

note
string | null

Additional notes or comments for the invoice

vendor_name
string | null

The name of the vendor/seller/supplier

vendor_email
string | null

The email address of the vendor

vendor_address
string | null

The address of the vendor/seller

vendor_address_recipient
string | null

The recipient name at the vendor address

customer_address
string | null

The address of the customer/buyer

customer_address_recipient
string | null

The recipient name at the customer address

billing_address
string | null

The billing address (if different from customer address)

billing_address_recipient
string | null

The recipient name at the billing address

shipping_address
string | null

The shipping/delivery address

shipping_address_recipient
string | null

The recipient name at the shipping address

currency
enum<string>
default:EUR

Currency of the invoice (ISO 4217 currency code)

Available options:
EUR,
USD,
GBP,
JPY,
CHF,
CAD,
AUD,
NZD,
CNY,
INR,
SEK,
NOK,
DKK,
SGD,
HKD
tax_code
enum<string>
default:S

Tax category code of the invoice (e.g., S for standard rate, Z for zero rate, E for exempt)

Available options:
AE,
E,
S,
Z,
G,
O,
K,
L,
M,
B
vatex
enum<string> | null

VAT exemption reason code (required when tax_code is E or other exempt categories)

Available options:
VATEX-EU-79-C,
VATEX-EU-132,
VATEX-EU-132-1A,
VATEX-EU-132-1B,
VATEX-EU-132-1C,
VATEX-EU-132-1D,
VATEX-EU-132-1E,
VATEX-EU-132-1F,
VATEX-EU-132-1G,
VATEX-EU-132-1H,
VATEX-EU-132-1I,
VATEX-EU-132-1J,
VATEX-EU-132-1K,
VATEX-EU-132-1L,
VATEX-EU-132-1M,
VATEX-EU-132-1N,
VATEX-EU-132-1O,
VATEX-EU-132-1P,
VATEX-EU-132-1Q,
VATEX-EU-143,
VATEX-EU-143-1A,
VATEX-EU-143-1B,
VATEX-EU-143-1C,
VATEX-EU-143-1D,
VATEX-EU-143-1E,
VATEX-EU-143-1F,
VATEX-EU-143-1FA,
VATEX-EU-143-1G,
VATEX-EU-143-1H,
VATEX-EU-143-1I,
VATEX-EU-143-1J,
VATEX-EU-143-1K,
VATEX-EU-143-1L,
VATEX-EU-144,
VATEX-EU-146-1E,
VATEX-EU-148,
VATEX-EU-148-A,
VATEX-EU-148-B,
VATEX-EU-148-C,
VATEX-EU-148-D,
VATEX-EU-148-E,
VATEX-EU-148-F,
VATEX-EU-148-G,
VATEX-EU-151,
VATEX-EU-151-1A,
VATEX-EU-151-1AA,
VATEX-EU-151-1B,
VATEX-EU-151-1C,
VATEX-EU-151-1D,
VATEX-EU-151-1E,
VATEX-EU-159,
VATEX-EU-309,
VATEX-EU-AE,
VATEX-EU-D,
VATEX-EU-F,
VATEX-EU-G,
VATEX-EU-I,
VATEX-EU-IC,
VATEX-EU-O,
VATEX-EU-J,
VATEX-FR-FRANCHISE,
VATEX-FR-CNWVAT
vatex_note
string | null

Textual explanation for VAT exemption

subtotal
string | null

The taxable base of the invoice. Should be the sum of all line items - allowances (for example commercial discounts) + charges with impact on VAT. Must be positive and rounded to maximum 2 decimals

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_discount
string | null

The net financial discount/charge of the invoice (non-VAT charges minus non-VAT allowances). Can be positive (net charge), negative (net discount), or zero. Must be rounded to maximum 2 decimals

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
total_tax
string | null

The total tax amount of the invoice. Must be positive and rounded to maximum 2 decimals

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
invoice_total
string | null

The total amount of the invoice including tax (invoice_total = subtotal + total_tax + total_discount). Must be positive and rounded to maximum 2 decimals

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
amount_due
string | null

The amount due for payment. Must be positive and rounded to maximum 2 decimals

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
remittance_address
string | null

The address where payment should be sent or remitted to

remittance_address_recipient
string | null

The recipient name at the remittance address

service_address
string | null

The address where services were performed or goods were delivered

service_address_recipient
string | null

The recipient name at the service address

service_start_date
string<date> | null

The start date of the service period or delivery period

service_end_date
string<date> | null

The end date of the service period or delivery period

vendor_tax_id
string | null

Vendor tax ID. For Belgium this is the VAT number. Must include the country prefix

Example:

"BE1018265814"

vendor_company_id
string | null

Vendor company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

Example:

"1018265814"

customer_tax_id
string | null

Customer tax ID. For Belgium this is the VAT number. Must include the country prefix

Example:

"BE1018265814"

customer_company_id
string | null

Customer company ID. For Belgium this is the CBE number or their EUID (European Unique Identifier) number. In the Netherlands this is the KVK number.

Example:

"1018265814"

customer_peppol_id
string | null

Customer Peppol ID

Example:

"0208:0123456789"

payment_term
string | null

The payment terms (e.g., 'Net 30', 'Due on receipt', '2/10 Net 30')

payment_details
PaymentDetail · object[] | null
tax_details
TaxDetail · object[] | null
items
LineItem · object[] | null
attachments
DocumentAttachment · object[] | null
allowances
AllowanceBase · object[] | null
charges
ChargeBase · object[] | null