Maventa JSON (table)
Preview
The MaventaJSON 1.0 Invoice format provides a unified structure for electronic invoices. It brings together common elements from multiple international and national invoice standards and extends them where needed to support a broader range of business and interoperability requirements.
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
formatName |
Name of the document format. |
String |
MaventaJSON |
|
| 1..1 |
formatVersion |
Version of the format. |
String |
1.0.0 |
|
| 1..1 |
documentType |
Type of the document. |
String |
invoice |
BT-3 |
| 0..1 |
language |
Document language code (ISO 639-1). |
String |
en |
|
| 1..1 |
createdBy |
Details about the system that created the document. |
Object |
|
|
| 0..1 |
endpoints |
Seller and buyer electronic addresses. |
Object |
|
BT-34, BT-49 |
| 0..n |
attachments |
List of attachments related to the document. |
Array(Object) |
|
BG-24 |
| 1..1 |
document |
Document content. |
Object |
|
|
createdBy
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
system |
Metadata about the system that generated the document. |
Object |
|
|
createdBy.system
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Name of the system. |
String |
Maventa Converter |
|
| 1..1 |
version |
Version of the system. |
String |
2.28.6 |
|
| 1..1 |
timestamp |
ISO 8601 timestamp when the document was generated (YYYY-MM-DDTHH:MM:SSZ). |
String |
2025-05-19T08:37:31Z |
|
| 0..1 |
metadata |
Additional metadata about the generating system. |
Object |
|
|
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
documentID |
Internal document identifier in the senders system. |
String |
|
|
| 0..n |
notes |
Notes from the originating system. |
Array(String) |
|
|
| 0..n |
libraries |
List of used libraries. |
Array(Object) |
|
|
| 0..n |
patches |
List of applied patches. |
Array(Object) |
|
|
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Name of the library. |
String |
converter-document |
|
| 1..1 |
version |
Version of the library. |
String |
0.11.4 |
|
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Name of the patch applied. |
String |
|
|
| 0..1 |
applied |
When the patch was applied. |
String |
after_import |
|
endpoints
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
sender |
Seller electronic address. |
Object |
|
BT-34 |
| 1..1 |
receiver |
Buyer electronic address. |
Object |
|
BT-49 |
endpoints.sender
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Seller electronic address identifier. |
Object |
|
BT-34 |
| 0..1 |
network |
Seller operator or network identifier. |
String |
MAVENTA |
|
| 0..n |
email |
Seller email address. |
Array(String) |
email@seller.com |
|
endpoints.sender.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Seller electronic address identifier type (EAS). |
String |
FI:OVTCODE |
BT-34 |
| 1..1 |
value |
Seller electronic address identifier value. |
String |
003721291126 |
BT-34 |
endpoints.receiver
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Buyer electronic address identifier. |
Object |
|
BT-49 |
| 0..1 |
network |
Buyer operator or network identifier. |
String |
|
|
| 0..n |
email |
Buyer email address. |
Array(String) |
email@buyer.com |
|
endpoints.receiver.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Buyer electronic address identifier type (EAS). |
String |
NO:ORGNR |
BT-49 |
| 1..1 |
value |
Buyer electronic address identifier value. |
String |
111111111 |
BT-49 |
attachments
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
primaryImage |
Indicates the primary image. |
Boolean |
|
|
| 1..1 |
id |
Identifier for the attachment. |
String |
123 |
BT-122 |
| 1..1 |
description |
Description of the attachment. |
Array(Object) |
|
BT-123 |
| 0..1 |
filename |
Name of the attached file. |
String |
milage.csv |
BT-125 |
| 0..1 |
mimeType |
MIME type of the content (IANA subset). |
String |
text/csv |
BT-125 |
| 0..1 |
content |
Base64-encoded content of the attachment. |
String |
YTtiO2M7ZDtlO2Y7Zw== |
BT-125 |
| 0..1 |
externalReference |
External reference URL for the attachment. |
String |
http://www.techspec.no |
BT-124 |
attachments.description
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Description of the attachment. |
String |
Technical specification |
BT-123 |
document
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Unique identifier for the document. |
String |
12345678 |
BT-1 |
| 1..1 |
issueDate |
Date when the document was issued (YYYY-MM-DD). |
String |
2025-01-01 |
BT-2 |
| 0..1 |
taxPointDate |
Tax point date (YYYY-MM-DD). |
String |
2025-01-01 |
BT-7 |
| 0..1 |
taxPointDateCode |
Tax point date code (UNCL2005 subset). |
String |
3 |
BT-8 |
| 1..1 |
dueDate |
The date when the payment is due (YYYY-MM-DD). |
String |
2025-02-01 |
BT-9 |
| 1..1 |
currency |
Currency details. |
Object |
|
BT-5, BT-6 |
| 0..1 |
invoicePeriod |
Period covered by the invoice. |
Object |
|
BG-14 |
| 0..n |
buyerReference |
Buyer reference information. |
Array(Object) |
abs1234 |
BT-10 |
| 0..1 |
buyerAccountingReference |
Buyer accounting reference information. |
Array(Object) |
4217:2323:2323 |
BT-19 |
| 0..n |
precedingDocumentReference |
References to preceding documents. |
Array(Object) |
12345677 |
BG-3 |
| 0..1 |
salesOrderReference |
Sales order references. |
Array(Object) |
112233 |
BT-14 |
| 0..1 |
purchaseOrderReference |
Purchase order references. |
Array(Object) |
98776 |
BT-13 |
| 0..1 |
projectReference |
Associated project references. |
Array(Object) |
PID33 |
BT-11 |
| 0..1 |
despatchDocumentReference |
Despatch document references. |
Array(Object) |
desp98 |
BT-16 |
| 0..1 |
originatorDocumentReference |
Originator document references. |
Array(Object) |
PPID-123 |
BT-17 |
| 0..1 |
receiptDocumentReference |
Receipt document references. |
Array(Object) |
rec98 |
BT-15 |
| 0..1 |
contractDocumentReference |
Contract document references. |
Array(Object) |
123Contractref |
BT-12 |
| 0..1 |
invoicedObject |
Information about the invoiced object. |
Array(Object) |
|
BT-18 |
| 0..n |
additionalProperties |
Additional properties related to the document. |
Array(Object) |
|
|
| 0..n |
note |
Document level notes. |
Array(Object) |
|
BG-1 |
| 1..1 |
seller |
Seller details. |
Object |
|
BG-4 |
| 0..1 |
sellerTaxRepresentative |
Sellers tax representative party details. |
Object |
|
BG-11 |
| 1..1 |
buyer |
Buyer details. |
Object |
|
BG-7 |
| 0..1 |
delivery |
Delivery information. |
Object |
|
BG-13 |
| 0..1 |
payee |
Payee details. |
Object |
|
BG-10 |
| 1..1 |
payment |
Payment terms and instructions. |
Object |
|
BG-16 |
| 0..n |
allowanceCharge |
Document level allowances and charges. |
Array(Object) |
|
BG-20, BG-21 |
| 1..1 |
tax |
Tax details. |
Object |
|
BG-22, BG-23 |
| 1..1 |
monetaryTotal |
Monetary totals related to the document. |
Object |
|
BG-22 |
| 1..n |
lines |
Document lines. |
Array(Object) |
|
BG-25, BG-31 |
document.currency
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
code |
Document currency code (ISO 4217). |
String |
EUR |
BT-5 |
| 0..1 |
taxCurrency |
Tax (VAT) accounting currency code (ISO 4217). |
Object |
NOK |
BT-6 |
document.currency.taxCurrency
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
code |
Tax (VAT) accounting currency code (ISO 4217). |
String |
NOK |
BT-6 |
document.invoicePeriod
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
startDate |
Start date of the invoice period (YYYY-MM-DD). |
String |
2025-01-01 |
BT-73 |
| 1..1 |
endDate |
End date of the invoice period (YYYY-MM-DD). |
String |
2025-01-20 |
BT-74 |
document.buyerReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Buyer reference information. |
String |
abs1234 |
BT-10 |
document.buyerAccountingReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Buyer accounting reference information. |
String |
4217:2323:2323 |
BT-19 |
document.precedingDocumentReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Preceding document identifier. |
String |
12345677 |
BT-25 |
| 1..1 |
issueDate |
Preceding document issue date (YYYY-MM-DD). |
String |
2024-12-01 |
BT-26 |
document.salesOrderReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Sales order references. |
String |
112233 |
BT-14 |
document.purchaseOrderReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Purchase order references. |
String |
98776 |
BT-13 |
document.projectReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Associated project references. |
String |
PID33 |
BT-11 |
document.despatchDocumentReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Despatch document references. |
String |
desp98 |
BT-16 |
document.originatorDocumentReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Originator document references. |
String |
PPID-123 |
BT-17 |
document.receiptDocumentReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Receipt document references. |
String |
rec98 |
BT-15 |
document.contractDocumentReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Contract document references. |
String |
123Contractref |
BT-12 |
document.invoicedObject
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
schemeID |
Invoiced object identifier scheme identifier (UNCL1153). |
String |
AUN |
BT-18 |
| 1..1 |
value |
Invoiced object identifier. |
String |
AB23456 |
BT-18 |
document.additionalProperties
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Additional property name. |
String |
Time list |
|
| 1..1 |
value |
Additional property value. |
String |
AB23456 |
|
document.note
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Document level note. A textual note that gives unstructured information that is relevant to the document as a whole. |
String |
Please note our new phone number |
BT-22 |
| 0..1 |
subjectCode |
Document level note subject code. |
String |
ZZZ |
BT-21 |
document.seller
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
partyIdentifiers |
Seller party identifiers. |
Array(Object) |
|
|
| 1..1 |
name |
Seller trading/business name. |
Array(Object) |
Seller Business Name |
BT-28 |
| 0..1 |
address |
Seller postal address details. |
Object |
|
BG-5 |
| 0..1 |
legalEntity |
Party legal entity details. |
Object |
|
|
| 0..1 |
tax |
Seller tax identifier. |
Object |
|
|
| 0..1 |
contact |
Seller contact details. |
Object |
|
BG-6 |
document.seller.partyIdentifiers
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Seller party identifier type. |
String |
FI:ORGNR |
BT-29 |
| 1..1 |
value |
Seller party identifier value. May be used to identify the seller. |
String |
2129112-6 |
BT-29 |
document.seller.address
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
street1 |
Seller address line 1. The main address line in an address. |
String |
Pasilan asema-aukio 1 |
BT-35 |
| 0..1 |
street2 |
Seller address line 2. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
|
BT-36 |
| 0..1 |
street3 |
Seller address line 3. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
|
BT-162 |
| 0..1 |
postOffice |
Seller city, town, village or post office. |
String |
Helsinki |
BT-37 |
| 0..1 |
postCode |
Seller post code. |
String |
00520 |
BT-38 |
| 1..1 |
country |
Seller country details. |
Object |
|
|
document.seller.address.country
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
subDivision |
Seller country subdivision. |
String |
Uusimaa |
BT-39 |
| 0..1 |
code |
Seller country code (ISO 3166-1). |
String |
FI |
BT-40 |
document.seller.legalEntity
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
name |
The full name of the seller. |
Array(Object) |
Full formal name |
BT-27 |
| 1..1 |
id |
Seller legal entity identifier. |
Object |
2129112-6 |
BT-30 |
| 0..1 |
additionalLegalInfo |
Seller additional legal information. |
String |
Share capital |
BT-33 |
document.seller.legalEntity.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Seller legal entity identifier type. |
String |
FI:ORGNR |
BT-30 |
| 1..1 |
value |
Seller legal entity identifier value. |
String |
2129112-6 |
BT-30 |
document.seller.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Seller tax identifier scheme. Default value: “VAT”. |
String |
VAT |
|
| 0..1 |
id |
Seller tax identifier. |
Object |
FI21291126 |
BT-31 |
| 0..1 |
registrationID |
Seller tax registration identifier. |
String |
|
BT-32 |
document.seller.tax.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Seller tax identifier type. |
String |
FI:VAT |
|
| 1..1 |
value |
Seller tax identifier value. |
String |
FI21291126 |
BT-31 |
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
name |
Seller contact point for a legal entity or person. |
String |
xyz123 |
BT-41 |
| 0..1 |
telephone |
Seller phone number for the contact point. |
String |
887 654 321 |
BT-42 |
| 0..1 |
email |
Seller email address for the contact point. |
String |
contact@seller.com |
BT-43 |
document.sellerTaxRepresentative
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Seller tax representative name. |
Array(Object) |
Tax Representative Name |
BT-62 |
| 0..1 |
address |
Seller tax representative postal address details. |
Object |
|
BG-12 |
| 0..1 |
tax |
Seller tax representative tax identifier. |
Object |
|
|
document.sellerTaxRepresentative.address
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
street1 |
Tax representative address line 1. The main address line in an address. |
String |
Address line 1 |
BT-64 |
| 0..1 |
street2 |
Tax representative address line 2. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
Address line 2 |
BT-65 |
| 0..1 |
street3 |
Tax representative address line 3. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
Address line 3 |
BT-164 |
| 0..1 |
postOffice |
Tax representative city, town, village or post office. |
String |
Göteborg |
BT-67 |
| 0..1 |
postCode |
Tax representative post code. |
String |
12345 |
BT-66 |
| 1..1 |
country |
Tax representative country details. |
Object |
|
|
document.sellerTaxRepresentative.address.country
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
subDivision |
Tax representative country subdivision. |
String |
Region Vest |
BT-68 |
| 0..1 |
code |
Tax representative country code (ISO 3166-1). |
String |
SE |
BT-69 |
document.sellerTaxRepresentative.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Seller tax representative tax identifier scheme. Default value: “VAT”. |
String |
VAT |
|
| 0..1 |
id |
Seller tax representative tax identifier. |
Object |
FI00800008 |
BT-63 |
document.sellerTaxRepresentative.tax.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Seller tax representative tax identifier type. |
String |
FI:VAT |
|
| 1..1 |
value |
Seller tax representative tax identifier. |
String |
FI00800008 |
BT-63 |
document.buyer
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
partyIdentifiers |
Buyer party identifiers. |
Array(Object) |
111111111 |
BT-46 |
| 1..1 |
name |
Buyer trading/business name. |
Array(Object) |
Buyer Trading Name |
BT-45 |
| 0..1 |
address |
Buyer postal address details. |
Object |
|
BG-8 |
| 0..1 |
legalEntity |
Party legal entity details. |
Object |
|
|
| 0..1 |
tax |
Buyer tax identifier. |
Object |
|
|
| 0..1 |
contact |
Buyer contact details. |
Object |
|
BG-9 |
document.buyer.partyIdentifiers
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Buyer party identifier type. |
String |
NO:ORGNR |
BT-46 |
| 1..1 |
value |
Buyer party identifier value. May be used to identify the buyer. |
String |
111111111 |
BT-46 |
document.buyer.address
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
street1 |
Buyer address line 1. The main address line in an address. |
String |
Karenslyst allé 56 |
BT-50 |
| 0..1 |
street2 |
Buyer address line 2. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
|
BT-51 |
| 0..1 |
street3 |
Buyer address line 3. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
|
BT-163 |
| 0..1 |
postOffice |
Buyer city, town, village or post office. |
String |
Oslo |
BT-52 |
| 0..1 |
postCode |
Buyer post code. |
String |
0277 |
BT-53 |
| 1..1 |
country |
Buyer country details. |
Object |
|
|
document.buyer.address.country
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
subDivision |
Buyer country subdivision. |
String |
Oslo |
BT-54 |
| 0..1 |
code |
Buyer country code (ISO 3166-1). |
String |
NO |
BT-55 |
document.buyer.legalEntity
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
name |
The full name of the buyer. |
Array(Object) |
Full formal name |
BT-44 |
| 1..1 |
id |
Buyer legal registration identifier. |
Object |
111111111 |
BT-47 |
document.buyer.legalEntity.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Buyer legal entity identifier type. |
String |
NO:ORGNR |
BT-47 |
| 1..1 |
value |
Buyer legal entity identifier value. |
String |
111111111 |
BT-47 |
document.buyer.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Buyer tax identifier scheme. Default value: “VAT”. |
String |
VAT |
|
| 0..1 |
id |
Buyer tax identifier. |
Object |
NO111111111 |
BT-48 |
document.buyer.tax.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Buyer tax identifier type. |
String |
NO:VAT |
|
| 1..1 |
value |
Buyer tax identifier value. |
String |
NO111111111 |
BT-48 |
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
name |
Buyer contact point for a legal entity or person. |
String |
Jens Jensen |
BT-56 |
| 0..1 |
telephone |
Buyer phone number for the contact point. |
String |
876 654 321 |
BT-57 |
| 0..1 |
email |
Buyer email address for the contact point. |
String |
contact@buyer.com |
BT-58 |
document.delivery
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
date |
Actual delivery date (YYYY-MM-DD). |
String |
2025-02-01 |
BT-72 |
| 0..1 |
locationID |
Delivery location identifier. |
Object |
1111111111116 |
BT-71 |
| 0..1 |
name |
The name of the party to which the goods and services are delivered. |
Array(Object) |
DeliveryPartyName |
BT-70 |
| 0..1 |
address |
Delivery postal address details. |
Object |
|
BG-15 |
document.delivery.locationID
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Delivery location identifier type. |
String |
GLN |
BT-71 |
| 1..1 |
value |
Delivery location identifier value. |
String |
1111111111116 |
BT-71 |
document.delivery.address
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
street1 |
Deliver address line 1. The main address line in an address. |
String |
Delivery Street 1 |
BT-75 |
| 0..1 |
street2 |
Deliver address line 2. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
Delivery Street 2 |
BT-76 |
| 0..1 |
street3 |
Deliver address line 3. An additional address line in an address that can be used to give further details supplementing the main line. |
String |
C54 |
BT-165 |
| 0..1 |
postOffice |
City, town, village or post office. |
String |
Oslo |
BT-77 |
| 0..1 |
postCode |
Post code. |
String |
0277 |
BT-78 |
| 1..1 |
country |
Delivery country details. |
Object |
|
|
document.delivery.address.country
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
subDivision |
Delivery country subdivision. |
String |
South Region |
BT-79 |
| 0..1 |
code |
Delivery country code (ISO 3166-1). |
String |
NO |
BT-80 |
document.payee
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
partyIdentifiers |
Payee party identifiers. |
Array(Object) |
|
BT-60 |
| 1..1 |
name |
Payee name. |
Array(Object) |
Payee name |
BT-59 |
| 1..1 |
legalEntity |
Payee legal entity details. |
Object |
|
|
document.payee.partyIdentifiers
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Payee party identifier type. |
String |
FI:ORGNR |
|
| 1..1 |
value |
Payee party identifier value. |
String |
2129112-6 |
BT-60 |
document.payee.legalEntity
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
name |
The full name of the payee. |
Array(Object) |
Full formal name |
|
| 1..1 |
id |
Payee legal entity identifier. |
Object |
2129112-6 |
BT-61 |
document.payee.legalEntity.id
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Payee legal entity identifier type. |
String |
FI:ORGNR |
BT-61 |
| 1..1 |
value |
Payee legal entity identifier value. |
String |
2129112-6 |
BT-61 |
document.payment
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..n |
terms |
Payment terms. |
Array(Object) |
|
|
| 1..n |
instructions |
Payment instructions. |
Array(Object) |
|
BG-16 |
document.payment.terms
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
id |
Payment terms identifier. |
String |
|
|
| 0..1 |
paymentMeansID |
Payment instruction identifier related to given payment terms. |
String |
|
|
| 1..1 |
note |
A textual description of the payment terms. |
Array(Object) |
|
BT-20 |
| 0..1 |
amount |
The payment amount that these terms apply to. |
Decimal |
|
|
| 0..1 |
installment |
Payment terms installment. |
Object |
|
|
document.payment.terms.note
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
A textual description of the payment terms. |
String |
|
BT-20 |
document.payment.terms.installment
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
dueDate |
Payment terms installment due date. The date before end of which the terms amount shall be settled (YYYY-MM-DD). |
String |
|
|
document.payment.instructions
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Payment means type (PaymentMeansCode). |
String |
|
BT-81 |
| 0..1 |
typeName |
Payment means expressed as text. |
String |
|
BT-82 |
| 0..1 |
paymentID |
Remittance information. |
Object |
|
BT-83 |
| 0..1 |
mandateID |
Payee-assigned identifier for referencing the SEPA mandate and pre-notifying the Buyer. |
String |
|
BT-89 |
| 0..1 |
creditorID |
Bank assigned creditor identifier used for direct debiting. |
String |
|
BT-90 |
| 0..1 |
cardAccount |
Payment card information. |
Object |
|
BG-18 |
| 0..1 |
account |
Account details. |
Object |
|
BG-17, BG-19 |
document.payment.instructions.paymentID
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
type |
Payment instruction identifier type. |
String |
|
|
| 1..1 |
value |
Remittance information. A textual value used to establish a link between the payment and the invoice. |
String |
432948234234234 |
BT-83 |
document.payment.instructions.cardAccount
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
primaryAccountNumber |
Payment card primary account number (PAN). |
String |
|
BT-87 |
| 0..1 |
networkID |
Payment card network identifier. |
String |
|
|
| 1..1 |
holderName |
Payment card holder name. |
String |
|
BT-88 |
document.payment.instructions.account
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
name |
Account name. |
String |
Payment Account |
BT-85 |
| 1..1 |
type |
Account type. |
String |
IBAN |
|
| 1..1 |
id |
Account identifier. |
String |
FI5810203000100011 |
BT-84, BT-91 |
| 0..1 |
institution |
Account financial institution. |
Object |
|
|
document.payment.instructions.account.institution
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Payment service provider identifier, BIC/SWIFT etc. |
String |
BICXFIHH |
BT-86 |
document.allowanceCharge
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Type of ‘charge’ or ‘allowance’. |
String |
charge |
|
| 0..1 |
reasonCode |
The reason for the document level allowance or charge, expressed as a code (UNCL7161, UNCL5189 subset). |
String |
FC |
BT-98, BT-105 |
| 0..n |
reason |
The reason for the document level allowance or charge, expressed as text. |
Array(Object) |
Freight |
BT-97, BT-104 |
| 0..1 |
percentage |
Percentage used to calculate the amount. |
Decimal |
5.0 |
BT-94, BT-101 |
| 0..1 |
baseAmount |
Base amount for calculating the charge or allowance. |
Decimal |
200.0 |
BT-93, BT-100 |
| 1..1 |
amount |
Amount of the charge or allowance. |
Decimal |
10.0 |
BT-92, BT-99 |
| 1..1 |
tax |
Tax information related to charge or allowance. |
Object |
|
|
document.allowanceCharge.reason
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
The reason for the document level allowance or charge, expressed as text. |
String |
Freight |
BT-97, BT-104 |
document.allowanceCharge.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Tax scheme. Default value: “VAT”. |
String |
VAT |
|
| 1..1 |
category |
Document level allowance or charge tax category code. |
String |
standard_rate |
BT-95, BT-102 |
| 1..1 |
percentage |
The tax category rate, represented as percentage that applies for the relevant tax category. |
Decimal |
25.5 |
BT-96, BT-103 |
document.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
amount |
Total tax amount. |
Decimal |
51.0 |
BT-110 |
| 0..1 |
taxCurrency |
Tax details for tax accounting currency. |
Object |
|
|
| 1..n |
subTotals |
Tax breakdown. |
Array(Object) |
|
BG-23 |
document.tax.taxCurrency
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
taxableAmount |
Taxable base amount in tax accounting currency. |
Decimal |
|
|
| 1..1 |
amount |
Tax amount in tax accounting currency. |
Decimal |
|
BT-111 |
document.tax.subTotals
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
taxableAmount |
Taxable base amount. |
Decimal |
200.0 |
BT-116 |
| 1..1 |
amount |
Tax amount. |
Decimal |
51.0 |
BT-117 |
| 1..1 |
tax |
Tax details. |
Object |
|
|
document.tax.subTotals.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Tax scheme. Default value: “VAT”. |
String |
VAT |
|
| 1..1 |
category |
Tax category code. |
String |
standard_rate |
BT-118 |
| 1..1 |
percentage |
Tax percentage rate. |
Decimal |
25.5 |
BT-119 |
| 0..1 |
exemption |
Tax exemption details. |
Object |
|
|
document.tax.subTotals.tax.exemption
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
reasonCode |
Tax exemption reason code (VATEX). |
String |
|
BT-121 |
| 0..n |
reason |
Tax exemption reason text. |
Array(Object) |
Exempt |
BT-120 |
document.tax.subTotals.tax.exemption.reason
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Tax exemption reason text. |
String |
Exempt |
BT-120 |
document.monetaryTotal
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
linesTotalAmount |
Sum of document line net amount. |
Decimal |
100.0 |
BT-106 |
| 1..1 |
taxExclusiveAmount |
Document total amount excluding tax. |
Decimal |
100.0 |
BT-109 |
| 1..1 |
taxInclusiveAmount |
Document total amount including tax. |
Decimal |
125.5 |
BT-112 |
| 0..1 |
allowanceTotalAmount |
Sum of allowances on document level. |
Decimal |
0.0 |
BT-107 |
| 0..1 |
chargeTotalAmount |
Sum of charges on document level. |
Decimal |
0.0 |
BT-108 |
| 0..1 |
prepaidAmount |
The sum of amounts which have been paid in advance. |
Decimal |
0.0 |
BT-113 |
| 0..1 |
roundingAmount |
Rounding amount. |
Decimal |
0.0 |
BT-114 |
| 1..1 |
payableAmount |
Amount due for payment. |
Decimal |
125.5 |
BT-115 |
document.lines
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
id |
Invoice line identifier. |
String |
1 |
BT-126 |
| 1..1 |
name |
Item name. |
String |
Item name |
BT-153 |
| 0..n |
note |
Invoice line note. |
Array(Object) |
|
BT-127 |
| 0..n |
description |
Item description. |
Array(Object) |
Long description of the item on the invoice line |
BT-154 |
| 0..n |
invoicedObject |
Invoice line object identifier. |
Array(Object) |
|
BT-128 |
| 0..n |
buyerAccountingReference |
Invoice line buyer accounting reference. |
Array(Object) |
|
BT-133 |
| 0..n |
purchaseOrderReference |
Purchase order reference. |
Array(Object) |
3 |
BT-132 |
| 0..1 |
sellersIdentifier |
Item sellers identifier. |
Object |
9873242 |
BT-155 |
| 0..1 |
buyersIdentifier |
Item buyers identifier. |
Object |
123455 |
BT-156 |
| 0..1 |
standardIdentifier |
Item standard identifier. |
Object |
10986700 |
BT-157 |
| 0..n |
additionalProperties |
Additional item properties. |
Array(Object) |
|
BG-32 |
| 0..1 |
invoicePeriod |
Invoice line invoice period. |
Object |
|
BG-26 |
| 0..1 |
originCountry |
Item country of origin. |
Object |
DE |
BT-159 |
| 0..n |
classificationIdentifier |
Item classification identifier. |
Array(Object) |
|
BT-158 |
| 1..1 |
quantity |
Quantity. |
Object |
5.0 |
BT-129 |
| 1..1 |
unitPrice |
Item net price. |
Object |
10.0 |
BG-29 |
| 0..n |
allowanceCharge |
Invoice line allowances and/or charges. |
Array(Object) |
|
BG-27, BG-28 |
| 1..1 |
lineTotalNetAmount |
Invoice line net amount. |
Decimal |
150.0 |
BT-131 |
| 1..1 |
tax |
|
Object |
|
BG-30 |
document.lines.note
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Invoice line note. |
String |
New article number 12345 |
BT-127 |
document.lines.description
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Item description. |
String |
Long description of the item on the invoice line |
BT-154 |
document.lines.invoicedObject
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
schemeID |
Invoice line object identifier scheme identifier (UNCL1153). |
String |
ABZ |
BT-128 |
| 1..1 |
value |
Invoice line object identifier. |
String |
AB12345 |
BT-128 |
document.lines.buyerAccountingReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
Invoice line buyer accounting reference. |
String |
1287:65464 |
BT-133 |
document.lines.purchaseOrderReference
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
lineID |
Purchase order line reference. |
String |
3 |
BT-132 |
document.lines.sellersIdentifier
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
value |
Item sellers identifier. |
String |
9873242 |
BT-155 |
document.lines.buyersIdentifier
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
value |
Item buyers identifier. |
String |
123455 |
BT-156 |
document.lines.standardIdentifier
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Item standard identifier type. |
String |
GTIN |
BT-157 |
| 1..1 |
value |
Item standard identifier. |
String |
10986700 |
BT-157 |
document.lines.additionalProperties
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
name |
Line item attribute name. |
String |
Color |
BT-160 |
| 1..1 |
value |
Line item attribute value. |
String |
Black |
BT-161 |
document.lines.invoicePeriod
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
startDate |
Invoice line period start date (YYYY-MM-DD). |
String |
2025-01-01 |
BT-134 |
| 1..1 |
endDate |
Invoice line period end date (YYYY-MM-DD). |
String |
2025-01-20 |
BT-135 |
document.lines.originCountry
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
code |
Country code (ISO 3166-1). |
String |
DE |
BT-159 |
document.lines.classificationIdentifier
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
schemeVersionID |
Item classification identifier identification scheme version identifier. |
String |
19.05.01 |
BT-158 |
| 1..1 |
schemeID |
Item classification identifier identification scheme identifier (UNCL7143). |
String |
STI |
BT-158 |
| 1..1 |
value |
Item classification identifier. |
String |
9873242 |
BT-158 |
document.lines.quantity
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
charged |
Charged quantity. |
Object |
|
|
document.lines.quantity.charged
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
unitCode |
Charged quantity unit of measure code (UNECERec20, UNECERec21 prefixed with X). |
String |
C62 |
BT-130 |
| 1..1 |
value |
Charged quantity. |
Decimal |
5.0 |
BT-129 |
document.lines.unitPrice
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
baseQuantity |
Item price base quantity. |
Object |
|
BT-149, BT-150 |
| 1..1 |
grossAmount |
Item gross price. |
Decimal |
15.0 |
BT-148 |
| 0..1 |
discountAmount |
Item price discount amount. |
Decimal |
5.0 |
BT-147 |
| 1..1 |
netAmount |
Item net price. |
Decimal |
10.0 |
BT-146 |
document.lines.unitPrice.baseQuantity
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
unitCode |
Item price base quantity unit of measure code (UNECERec20, UNECERec21 prefixed with X). |
String |
C62 |
BT-150 |
| 1..1 |
value |
Item price base quantity. |
Decimal |
1.0 |
BT-149 |
document.lines.allowanceCharge
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
type |
Type of ‘charge’ or ‘allowance’. |
String |
charge |
|
| 0..1 |
reasonCode |
The reason for the line level allowance or charge, expressed as a code (UNCL7161, UNCL5189 subset). |
String |
FC |
BT-140, BT-145 |
| 0..n |
reason |
The reason for the line level allowance or charge, expressed as text. |
Array(Object) |
Freight |
BT-139, BT-144 |
| 0..1 |
percentage |
Percentage used to calculate the amount. When percentage is provided, base amount must also be specified. |
Decimal |
200.0 |
BT-138, BT-143 |
| 0..1 |
baseAmount |
Base amount for calculating the charge or allowance. |
Decimal |
50.0 |
BT-137, BT-142 |
| 1..1 |
amount |
Amount of the charge or allowance. |
Decimal |
100.0 |
BT-136, BT-141 |
document.lines.allowanceCharge.reason
| Card |
Name |
Description |
Type |
Example |
ID |
| 0..1 |
language |
Text language code (ISO 639-1). |
String |
en |
|
| 1..1 |
text |
The reason for the line level allowance or charge, expressed as text. |
String |
Freight |
BT-139, BT-144 |
document.lines.tax
| Card |
Name |
Description |
Type |
Example |
ID |
| 1..1 |
scheme |
Tax scheme. Default value: “VAT”. |
String |
VAT |
|
| 1..1 |
category |
Invoiced item tax category code. |
String |
standard_rate |
BT-151 |
| 1..1 |
percentage |
Invoiced item tax category rate. |
Decimal |
25.5 |
BT-152 |
Page not available
Sorry! The page you are looking for may have been moved, deleted, or is not publicly available.
If you came here using a link, please let us know about the broken link at support@maventa.com - thanks!
Go back to the front page