DocumentUpsert

One invoice or credit note with all its lines. A newer source_updated_at replaces the document and every line: a line left out of the newer version is removed.

A credit note is a document of its own, with its own document_id. It never voids or replaces the invoice it credits: the invoice stays as it was, and the credit note reduces the return in its own period.

Amounts are signed as printed. Lines may carry either sign, so a discount line on an invoice is negative. The totals decide: the sum of line net, and the sum of line vat, must not be negative on an invoice or positive on a credit note. Otherwise the document is refused with total_sign_invalid.

action
const:
upsert
required
client_ref
Type: string
max length:
255
required

Your id for the client legal entity. Unique within your partner account.
counterparty_country
Type:
required

Where the customer or supplier is established. Drives the VAT number checks and the counterparty columns on listings.
counterparty_name
Type: string
max length:
255
required

The other party to the document. The customer on a sale, the supplier on a purchase.
currency
Type:
required

ISO 4217.
document_id
Type: string
max length:
255
required

Your permanent id for the document. Never reused. A credit note has its own.
document_type
Type: "invoice" or "credit_note"enum
required
invoice_date
Type: stringFormat: date
required

On a credit note, the credit note's own date.
invoice_number
Type: string
max length:
255
required

As printed. On a credit note, the credit note's own number.
lines
Type: 1…
required
Properties: 9
source_updated_at
Type: stringFormat: date-time
required

When the document last changed in your ERP. Orders versions of the document.
tax_jurisdiction
Type:
required

The country of the client's VAT registration the document falls under: the registration whose VAT number the client issued or received the invoice under. For OSS and IOSS sales it is the registration country, not the consumer's: VAT IT takes the consumer's country from the ship countries or counterparty_country. An ISO 3166-1 alpha-2 country, or an ISO 3166-2 subdivision where VAT IT files below country level (CA-QC).
counterparty_vat_number
Type: string
max length:
32

The customer's or supplier's VAT number with its country prefix, as printed. Required when a line's tax code needs it: B2B cross-border and reverse charge in every EU country.
e_invoice_reference
Type: string
max length:
255

The e-invoice clearance id, for example the KSeF number (PL) or SDI id (IT).
original_invoice_date
Type: stringFormat: date

full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
original_invoice_number
Type: string
max length:
255

On a credit note, the invoice it credits, whenever it credits one invoice. Links the two.
ship_from_country
Type:

Where the goods left from. Required for goods that cross a border.
ship_to_country
Type:

Where the goods arrived. Required for goods that cross a border. The consumer's country for OSS goods.
tax_point_date
Type: stringFormat: date

The date of supply or payment, when it differs from the invoice date. PL and CZ use it to set the period.

SubmittedDocument

Line