POST /invoicing/documents
and what ends up in the EN 16931 record, the CII XML and the PDF. Use it to map
your data model before you integrate. The first part lists the request fields;
the second walks the whole standard, business term by business term, and says
what meetergo does with each.
Terminology: BT-n is a business term and BG-n a business group of the
EN 16931 semantic model. Where the standard has no term for something meetergo
prints on the PDF, the table says PDF only.
Request fields
Document (POST /invoicing/documents body)
buyer
lines[]
Derived per line: BT-126 line identifier (the position), BT-131 line net
amount (rounded to the cent after the allowance, satisfying BR-CO-10).
Seller side, from PUT /invoicing/settings
At least one of
vatId and taxNumber is mandatory to finalize. Peppol
also needs vatId or legalRegistrationId (BR-CO-26).
Peppol endpoints
A Peppol BIS document needs an endpoint for both parties (BT-34, BT-49). When none is set explicitly, meetergo derives it:
ZUGFeRD and XRechnung keep the email (scheme
EM) unless electronicAddress
is set.
Finalize and send
POST /invoicing/documents/{id}/finalize accepts an optional number:
409 with code: "NUMBER_TAKEN", including
concurrent requests. meetergo skips its number range when you supply a number;
a gapless sequence is your responsibility. Omitting it retains range allocation.
Credit-note and cancellation endpoints allocate their own numbers.
POST /invoicing/documents/{id}/send accepts to, cc, bcc and
includePaymentLink. Each copy list accepts up to 5 email addresses, trimmed
and deduplicated ignoring case, with the final to recipient removed.
documentMail.bcc in PUT /invoicing/settings adds up to 5 default accounting
copies to every document email and dunning reminder. These are merged with
per-send BCC; BCC takes priority when an address also occurs in CC.
Set documentMail.bcc to [] to remove the default copies.
The sent event records the resulting to, cc and bcc recipients.
Reference fields example
Create or patch a draft with these fields (other required fields omitted):snapshot fields are:
Coverage of the EN 16931 model
Status legend:- Supported: you can send it. The field table identifies its XML and PDF outputs.
- Settings: comes from the seller’s invoicing settings.
- Derived: meetergo computes it; you cannot and need not send it.
- On request: not offered today. Tell us which of these you need and we schedule them.
Document level
Supported: custom fields. For internal references that have no business term
(department, project, internal order number), send
customFields: [{ "label": "Project", "value": "4711" }] on the
document. They are printed on the PDF info block and emitted in the XML as
BT-22 notes in the form Project: 4711, which every EN 16931 reader
keeps. The customer number (Debitornummer) uses its own field, BT-46. Values
are frozen at finalize. Send null or [] to clear
custom fields on a draft; send null to clear its cost center.Seller (BG-4, BG-5, BG-6)
Buyer (BG-7, BG-8, BG-9)
Payee and tax representative (BG-10, BG-11, BG-12)
Delivery (BG-13, BG-14, BG-15)
Payment instructions (BG-16 to BG-19)
Credit notes, cancellations and offers carry no payment instructions, since
they never ask for money.
Document-level allowances and charges (BG-20, BG-21)
Totals (BG-22)
VAT breakdown (BG-23)
Additional supporting documents (BG-24)
Attachments are added with
POST /invoicing/documents/{id}/attachments. See
Supporting documents.
Invoice line (BG-25 to BG-32)
What the validators check
If you validate our XML yourself with the KoSIT validator, use the XRechnung
profile. The ZUGFeRD EN 16931 XML carries the guideline
urn:cen.eu:en16931:2017 and matches no XRechnung scenario, so KoSIT reports
it as “not a known document type” rather than validating it.
Related
- Invoicing: the create, finalize, fetch flow
- API Reference → Invoicing: every schema with types and limits