Welke BT-velden ondersteunt de faktoora-API?
Overzicht van de EN 16931-business terms (BT-velden) die de factuur-API van faktoora ondersteunt, met API-veld en verplichte status.
De faktoora-API maakt elektronische facturen (XRechnung, ZUGFeRD, Peppol) aan volgens de Europese norm EN 16931. Deze norm beschrijft elk mogelijk factuurgegeven als een zogeheten "business term", kortweg BT, met een vast nummer, bijvoorbeeld BT-1 voor het factuurnummer. In de API-referentie van faktoora staat bij elk veld dat met zo'n business term overeenkomt, het bijbehorende BT-nummer in de veldbeschrijving.
Waar de BT-velden in de API staan
Bij het aanmaken van een factuur via POST /invoices verstuurt u een Invoice-object. Daarin zijn de BT-velden over meerdere onderdelen verdeeld:
- Factuurkop: direct op het
Invoice-object (factuurnummer, datum, factuurtype, valuta, referenties) seller: gegevens van de verkoper (naam, adres, btw-identificatienummer)buyer: gegevens van de koper (naam, adres, btw-identificatienummer, referenties)invoiceItems: factuurregels, elk met eenproduct-object (omschrijving, hoeveelheid, eenheidsprijs, belastingtarief)
Vaak gebruikte BT-velden
Deze selectie omvat de velden die doorgaans nodig zijn voor een volledige factuur. "Verplicht" heeft betrekking op het betreffende API-object, voor zover u het meestuurt; voor het Invoice-object zelf zijn volgens het schema alleen format, issueDate, invoiceNumber, invoiceTypeCode, invoiceItems en buyer in principe verplicht.
| BT-nummer | Betekenis | API-veld | Verplicht |
|---|---|---|---|
| BT-1 | Factuurnummer | invoiceNumber | Ja |
| BT-2 | Factuurdatum | issueDate | Ja |
| BT-3 | Factuurtype (bijv. 380 = handelsfactuur) | invoiceTypeCode | Ja |
| BT-5 | Valuta | currency | Nee |
| BT-9 | Vervaldatum | dueDateTime (in specifiedTradePaymentTerms) | Nee |
| BT-10 | Referentie van de koper / Leitweg-ID | buyerReference.buyerReferenceId | Nee |
| BT-13 | Orderreferentie van de koper | buyerReference.IssuerAssignedID | Nee |
| BT-14 | Verwijzing naar de bestelling | orderNumber | Nee |
| BT-27 | Naam van de verkoper | seller.name | Ja, binnen seller |
| BT-31 | Btw-identificatienummer van de verkoper | seller.vatId | Nee |
| BT-35 / BT-37 / BT-38 / BT-40 | Straat, plaats, postcode, land van de verkoper | seller.street / seller.city / seller.postcode / seller.country | Ja, binnen seller |
| BT-46 | Klantnummer bij de verkoper | buyer.id | Nee |
| BT-47 | Naam van de koper | buyer.name | Ja, binnen buyer |
| BT-48 | Btw-identificatienummer van de koper | buyer.vatId | Nee |
| BT-50 / BT-52 / BT-53 / BT-55 | Straat, plaats, postcode, land van de koper | buyer.street / buyer.city / buyer.postcode / buyer.country | Ja, binnen buyer |
| BT-72 | Leveringsdatum | deliveryDate | Nee |
| BT-126 | Regelnummer | invoiceItems[].id | Ja, binnen de regel |
| BT-129 | Hoeveelheid | invoiceItems[].product.quantity | Ja, binnen product |
| BT-130 | Eenheid (bijv. HUR, C62, KGM) | invoiceItems[].product.unitCode | Ja, binnen product |
| BT-146 | Eenheidsprijs | invoiceItems[].product.price | Ja, binnen product |
| BT-153 | Omschrijving van de regel | invoiceItems[].product.name | Ja, binnen product |
| BT-155 | Artikelnummer (toegekend door de verkoper) | invoiceItems[].product.productId | Nee |
Elke factuurregel heeft bovendien een belastinggegeven (taxes) nodig met belastingsoort, belastingcategorie (bijv. S voor het standaardtarief of Z voor het nultarief) en belastingtarief; deze drie gegevens zijn bij elke regel verplicht.
Volledige referentie
De tabel hierboven toont een selectie van de meest gebruikte velden. In totaal vermeldt de API-documentatie aanzienlijk meer BT-velden, onder meer voor betalingsvoorwaarden, kortingen/toeslagen, afleveradressen, contract- en projectreferenties en wereldwijd unieke identificaties (GLN/GTIN). De volledige, bindende lijst met alle veldbeschrijvingen en voorbeelden vindt u in de API-referentie van uw faktoora-account.
Was dit nuttig?