Maventa JSON (json schema)
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.
Optional
Title: MaventaJSON 1.0
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root |
Description: 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.
Required
| Type | string |
Description: Name of the document format
Example: "MaventaJSON"
Required
| Type | string |
Description: Version of the format
Example: "1.0.0"
Required
| Type | string |
Description: Type of the document
Example: "invoice"
Optional
| Type | string |
Description: Document language code
Example: "en"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_createdBy |
Description: Details about the system that created the document
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_createdBy_system |
Description: Metadata about the system that generated the document
Required
| Type | string |
Description: Name of the system
Example: "Maventa Converter"
Required
| Type | string |
Description: Version of the system
Example: "2.28.6"
Required
| Type | string |
| Format | date-time |
Description: ISO 8601 timestamp when the document was generated
Example: "2025-05-19T08:37:31Z"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_createdBy_system_metadata |
Description: Additional metadata about the generating system
documentID
| Type | string |
Description: Internal document identifier in the senders system
notes
| Type | array of string |
Description: Notes from the originating system
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| notes items | - |
notes items
| Type | string |
libraries
| Type | array |
Description: List of used libraries
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_createdBy_system_metadata_libraries | - |
root_createdBy_system_metadata_libraries
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_createdBy_system_metadata_libraries |
name
| Type | string |
Description: Name of the library
Example: "converter-document"
version
| Type | string |
Description: Version of the library
Example: "0.11.4"
patches
| Type | array |
Description: List of applied patches
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_createdBy_system_metadata_patches | - |
root_createdBy_system_metadata_patches
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_createdBy_system_metadata_patches |
name
| Type | string |
Description: Name of the patch applied
applied
| Type | string |
Description: When the patch was applied
Example: "after_import"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_endpoints |
Description: Seller and buyer electronic addresses
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_endpoints_sender |
Description: Seller electronic address
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_endpoints_sender_id |
Description: Seller electronic address identifier
type
| Type | string |
Description: Seller electronic address identifier type
Example: "FI:OVTCODE"
value
| Type | string |
Description: Seller electronic address identifier value
Example: "003721291126"
Optional
| Type | string |
Description: Seller operator or network identifier
Example: "MAVENTA"
Optional
| Type | array of string |
| Format | email |
Description: Seller email address
Example: "email@seller.com"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| email items | - |
email items
| Type | string |
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_endpoints_receiver |
Description: Buyer electronic address
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_endpoints_receiver_id |
Description: Buyer electronic address identifier
type
| Type | string |
Description: Buyer electronic address identifier type
Example: "NO:ORGNR"
value
| Type | string |
Description: Buyer electronic address identifier value
Example: "111111111"
Optional
| Type | string |
Description: Buyer operator or network identifier
Optional
| Type | array of string |
| Format | email |
Description: Buyer email address
Example: [ "email@buyer.com" ]
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| email items | - |
email items
| Type | string |
Optional
| Type | array |
Description: List of attachments related to the document
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_attachments | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_attachments |
Optional
| Type | boolean |
| Default | false |
Description: Indicates the primary image
Example: false
Required
| Type | string |
Description: Identifier for the attachment
Example: "123"
Required
| Type | array |
Description: Description of the attachment
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | 1 |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_attachments_description | - |
root_attachments_description
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_attachments_description |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Description of the attachment
Example: "Technical specification"
Optional
| Type | string |
Description: Name of the attached file
Example: "milage.csv"
Optional
| Type | string |
Description: MIME type of the content
Example: "text/csv"
Optional
| Type | string |
Description: Base64-encoded content of the attachment
Example: "YTtiO2M7ZDtlO2Y7Zw=="
Optional
| Type | string |
| Format | uri |
Description: External reference URL for the attachment
Example: "http://www.techspec.no"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document |
Description: Document content
Required
| Type | string |
Description: Unique identifier for the document
Example: "12345678"
Required
| Type | string |
| Format | date |
Description: Date when the document was issued
Example: "2025-01-01"
Optional
| Type | string |
| Format | date |
Description: Tax point date
Example: "2025-01-01"
Optional
| Type | string |
Description: Tax point date code
Example: "3"
Required
| Type | string |
| Format | date |
Description: The date when the payment is due
Example: "2025-02-01"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_currency |
Description: Currency details
Required
| Type | string |
Description: Document currency code
Example: "EUR"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_currency_taxCurrency |
Description: Tax (VAT) accounting currency code
Example: "NOK"
code
| Type | string |
Description: Tax (VAT) accounting currency code
Example: "NOK"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_invoicePeriod |
Description: Period covered by the invoice
Required
| Type | string |
| Format | date |
Description: Start date of the invoice period
Example: "2025-01-01"
Required
| Type | string |
| Format | date |
Description: End date of the invoice period
Example: "2025-01-20"
Optional
| Type | array |
Description: Buyer reference information
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_buyerReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyerReference |
id
| Type | string |
Description: Buyer reference information
Example: "abs1234"
Optional
| Type | array |
Description: Buyer accounting reference information
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_buyerAccountingReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyerAccountingReference |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Buyer accounting reference information
Example: "4217:2323:2323"
Optional
| Type | array |
Description: References to preceding documents
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_precedingDocumentReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_precedingDocumentReference |
id
| Type | string |
Description: Preceding document identifier
Example: "12345677"
issueDate
| Type | string |
| Format | date |
Description: Preceding document issue date
Example: "2024-12-01"
Optional
| Type | array |
Description: Sales order references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_salesOrderReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_salesOrderReference |
id
| Type | string |
Description: Sales order references
Example: "112233"
Optional
| Type | array |
Description: Purchase order references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_purchaseOrderReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_purchaseOrderReference |
id
| Type | string |
Description: Purchase order references
Example: "98776"
Optional
| Type | array |
Description: Associated project references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_projectReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_projectReference |
id
| Type | string |
Description: Associated project references
Example: "PID33"
Optional
| Type | array |
Description: Despatch document references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_despatchDocumentReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_despatchDocumentReference |
id
| Type | string |
Description: Despatch document references
Example: "desp98"
Optional
| Type | array |
Description: Originator document references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_originatorDocumentReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_originatorDocumentReference |
id
| Type | string |
Description: Originator document references
Example: "PPID-123"
Optional
| Type | array |
Description: Receipt document references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_receiptDocumentReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_receiptDocumentReference |
id
| Type | string |
Description: Receipt document references
Example: "rec98"
Optional
| Type | array |
Description: Contract document references
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_contractDocumentReference | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_contractDocumentReference |
id
| Type | string |
Description: Contract document references
Example: "123Contractref"
Optional
| Type | array |
Description: Information about the invoiced object
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_invoicedObject | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_invoicedObject |
schemeID
| Type | string |
Description: Invoiced object identifier scheme identifier
Example: "AUN"
value
| Type | string |
Description: Invoiced object identifier
Example: "AB23456"
Optional
| Type | array |
Description: Additional properties related to the document
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_additionalProperties | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_additionalProperties |
name
| Type | string |
Description: Additional property name
Example: "Time list"
value
| Type | string |
Description: Additional property value
Example: "AB23456"
Optional
| Type | array |
Description: Document level notes
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_note | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_note |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Document level note. A textual note that gives unstructured information that is relevant to the document as a whole.
Example: "Please note our new phone number"
subjectCode
| Type | string |
Description: Document level note subject code
Example: "ZZZ"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller |
Description: Seller details
Optional
| Type | array |
Description: Seller party identifiers
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_seller_partyIdentifiers | - |
root_document_seller_partyIdentifiers
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_partyIdentifiers |
type
| Type | string |
Description: Seller party identifier type
Example: "FI:ORGNR"
value
| Type | string |
Description: Seller party identifier value. May be used to identify the seller.
Example: "2129112-6"
Optional
| Type | array of string |
Description: Seller trading/business name
Example: "Seller Business Name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_address |
Description: Seller postal address details
street1
| Type | string |
Description: Seller address line 1. The main address line in an address
Example: "Pasilan asema-aukio 1"
street2
| Type | string |
Description: Seller address line 2. An additional address line in an address that can be used to give further details supplementing the main line
street3
| Type | string |
Description: Seller address line 3. An additional address line in an address that can be used to give further details supplementing the main line
postOffice
| Type | string |
Description: Seller city, town, village or post office
Example: "Helsinki"
postCode
| Type | string |
Description: Seller post code
Example: "00520"
country
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_address_country |
Description: Seller country details
subDivision
| Type | string |
Description: Seller country subdivision
Example: "Uusimaa"
code
| Type | string |
Description: Seller country code
Example: "FI"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_legalEntity |
Description: Party legal entity details
name
| Type | array of string |
Description: The full name of the seller
Example: "Full formal name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_legalEntity_id |
Description: Seller legal entity identifier
Example: "2129112-6"
type
| Type | string |
Description: Seller legal entity identifier type
Example: "FI:ORGNR"
value
| Type | string |
Description: Seller legal entity identifier value
Example: "2129112-6"
additionalLegalInfo
| Type | string |
Description: Seller additional legal information
Example: "Share capital"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_tax |
Description: Seller tax identifier
scheme
| Type | string |
| Default | "VAT" |
Description: Seller tax identifier scheme
Example: "VAT"
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_tax_id |
Description: Seller tax identifier
Example: "FI21291126"
type
| Type | string |
Description: Seller tax identifier type
Example: "FI:VAT"
value
| Type | string |
Description: Seller tax identifier value
Example: "FI21291126"
registrationID
| Type | string |
Description: Seller tax registration identifier
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_seller_contact |
Description: Seller contact details
name
| Type | string |
Description: Seller contact point for a legal entity or person
Example: "xyz123"
telephone
| Type | string |
Description: Seller phone number for the contact point
Example: "887 654 321"
email
| Type | string |
| Format | email |
Description: Seller email address for the contact point
Example: "contact@seller.com"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_sellerTaxRepresentative |
Description: Sellers tax representative party details
Required
| Type | array of string |
Description: Seller tax representative name
Example: "Tax Representative Name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_sellerTaxRepresentative_address |
Description: Seller tax representative postal address details
street1
| Type | string |
Description: Tax representative address line 1. The main address line in an address
Example: "Address line 1"
street2
| Type | string |
Description: Tax representative address line 2. An additional address line in an address that can be used to give further details supplementing the main line
Example: "Address line 2"
street3
| Type | string |
Description: Tax representative address line 3. An additional address line in an address that can be used to give further details supplementing the main line
Example: "Address line 3"
postOffice
| Type | string |
Description: Tax representative city, town, village or post office
Example: "Göteborg"
postCode
| Type | string |
Description: Tax representative post code
Example: "12345"
country
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_sellerTaxRepresentative_address_country |
Description: Tax representative country details
subDivision
| Type | string |
Description: Tax representative country subdivision
Example: "Region Vest"
code
| Type | string |
Description: Tax representative country code
Example: "SE"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_sellerTaxRepresentative_tax |
Description: Seller tax representative tax identifier
scheme
| Type | string |
| Default | "VAT" |
Description: Seller tax representative tax identifier scheme
Example: "VAT"
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_sellerTaxRepresentative_tax_id |
Description: Seller tax representative tax identifier
Example: "FI00800008"
type
| Type | string |
Description: Seller tax representative tax identifier type
Example: "FI:VAT"
value
| Type | string |
Description: Seller tax representative tax identifier
Example: "FI00800008"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer |
Description: Buyer details
Optional
| Type | array |
Description: Buyer party identifiers
Example: "111111111"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_buyer_partyIdentifiers | - |
root_document_buyer_partyIdentifiers
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_partyIdentifiers |
type
| Type | string |
Description: Buyer party identifier type
Example: "NO:ORGNR"
value
| Type | string |
Description: Buyer party identifier value. May be used to identify the buyer.
Example: "111111111"
Optional
| Type | array of string |
Description: Buyer trading/business name
Example: "Buyer Trading Name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_address |
Description: Buyer postal address details
street1
| Type | string |
Description: Buyer address line 1. The main address line in an address
Example: "Karenslyst allé 56"
street2
| Type | string |
Description: Buyer address line 2. An additional address line in an address that can be used to give further details supplementing the main line
street3
| Type | string |
Description: Buyer address line 3. An additional address line in an address that can be used to give further details supplementing the main line
postOffice
| Type | string |
Description: Buyer city, town, village or post office
Example: "Oslo"
postCode
| Type | string |
Description: Buyer post code
Example: "0277"
country
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_address_country |
Description: Buyer country details
subDivision
| Type | string |
Description: Buyer country subdivision
Example: "Oslo"
code
| Type | string |
Description: Buyer country code
Example: "NO"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_legalEntity |
Description: Party legal entity details
name
| Type | array of string |
Description: The full name of the buyer
Example: "Full formal name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_legalEntity_id |
Description: Buyer legal registration identifier
Example: "111111111"
type
| Type | string |
Description: Buyer legal entity identifier type
Example: "NO:ORGNR"
value
| Type | string |
Description: Buyer legal entity identifier value
Example: "111111111"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_tax |
Description: Buyer tax identifier
scheme
| Type | string |
| Default | "VAT" |
Description: Buyer tax identifier scheme
Example: "VAT"
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_tax_id |
Description: Buyer tax identifier
Example: "NO111111111"
type
| Type | string |
Description: Buyer tax identifier type
Example: "NO:VAT"
value
| Type | string |
Description: Buyer tax identifier value
Example: "NO111111111"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_buyer_contact |
Description: Buyer contact details
name
| Type | string |
Description: Buyer contact point for a legal entity or person
Example: "Jens Jensen"
telephone
| Type | string |
Description: Buyer phone number for the contact point
Example: "876 654 321"
email
| Type | string |
| Format | email |
Description: Buyer email address for the contact point
Example: "contact@buyer.com"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_delivery |
Description: Delivery information
Optional
| Type | string |
| Format | date |
Description: Actual delivery date
Example: "2025-02-01"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_delivery_locationID |
Description: Delivery location identifier
Example: "1111111111116"
type
| Type | string |
Description: Delivery location identifier type
Example: "GLN"
value
| Type | string |
Description: Delivery location identifier value
Example: "1111111111116"
Optional
| Type | array of string |
Description: The name of the party to which the goods and services are delivered
Example: "DeliveryPartyName"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_delivery_address |
Description: Delivery postal address details
street1
| Type | string |
Description: Deliver address line 1. The main address line in an address
Example: "Delivery Street 1"
street2
| Type | string |
Description: Deliver address line 2. An additional address line in an address that can be used to give further details supplementing the main line
Example: "Delivery Street 2"
street3
| Type | string |
Description: Deliver address line 3. An additional address line in an address that can be used to give further details supplementing the main line
Example: "C54"
postOffice
| Type | string |
Description: City, town, village or post office
Example: "Oslo"
postCode
| Type | string |
Description: Post code
Example: "0277"
country
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_delivery_address_country |
Description: Delivery country details
subDivision
| Type | string |
Description: Delivery country subdivision
Example: "South Region"
code
| Type | string |
Description: Delivery country code
Example: "NO"
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payee |
Description: Payee details
Optional
| Type | array |
Description: Payee party identifiers
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_payee_partyIdentifiers | - |
root_document_payee_partyIdentifiers
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payee_partyIdentifiers |
type
| Type | string |
Description: Payee party identifier type
Example: "FI:ORGNR"
value
| Type | string |
Description: Payee party identifier value
Example: "2129112-6"
Required
| Type | array of string |
Description: Payee name
Example: "Payee name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payee_legalEntity |
Description: Payee legal entity details
name
| Type | array of string |
Description: The full name of the payee
Example: "Full formal name"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| name items | - |
name items
| Type | string |
id
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payee_legalEntity_id |
Description: Payee legal entity identifier
Example: "2129112-6"
type
| Type | string |
Description: Payee legal entity identifier type
Example: "FI:ORGNR"
value
| Type | string |
Description: Payee legal entity identifier value
Example: "2129112-6"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment |
Description: Payment terms and instructions
Optional
| Type | array |
Description: Payment terms
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_payment_terms | - |
root_document_payment_terms
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_terms |
id
| Type | string |
Description: Payment terms identifier
paymentMeansID
| Type | string |
Description: Payment instruction identifier related to given payment terms
note
| Type | array |
Description: A textual description of the payment terms
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | 1 |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_payment_terms_note | - |
root_document_payment_terms_note
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_terms_note |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: A textual description of the payment terms
amount
| Type | number |
Description: The payment amount that these terms apply to
installment
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_terms_installment |
Description: Payment terms installment
dueDate
| Type | string |
| Format | date |
Description: Payment terms installment due date. The date before end of which the terms amount shall be settled
Required
| Type | array |
Description: Payment instructions
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_payment_instructions | - |
root_document_payment_instructions
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_instructions |
type
| Type | string |
Description: Payment means type
typeName
| Type | string |
Description: Payment means expressed as text
paymentID
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_instructions_paymentID |
Description: Remittance information
type
| Type | string |
Description: Payment instruction identifier type
value
| Type | string |
Description: Remittance information. A textual value used to establish a link between the payment and the invoice
Example: "432948234234234"
mandateID
| Type | string |
Description: Payee-assigned identifier for referencing the SEPA mandate and pre-notifying the Buyer
creditorID
| Type | string |
Description: Bank assigned creditor identifier used for direct debiting
cardAccount
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_instructions_cardAccount |
Description: Payment card information
primaryAccountNumber
| Type | string |
Description: Payment card primary account number (PAN)
networkID
| Type | string |
Description: Payment card network identifier
holderName
| Type | string |
Description: Payment card holder name
account
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_instructions_account |
Description: Account details
name
| Type | string |
Description: Account name
Example: "Payment Account"
type
| Type | string |
Description: Account type
Example: "IBAN"
id
| Type | string |
Description: Account identifier
Example: "FI5810203000100011"
institution
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_payment_instructions_account_institution |
Description: Account financial institution
id
| Type | string |
Description: Payment service provider identifier, BIC/SWIFT etc
Example: "BICXFIHH"
Optional
| Type | array |
Description: Document level allowances and charges
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_allowanceCharge | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_allowanceCharge |
type
| Type | string |
Description: Type of ‘charge’ or ‘allowance’
Example: "charge"
reasonCode
| Type | string |
Description: The reason for the document level allowance or charge, expressed as a code
Example: "FC"
reason
| Type | array |
Description: The reason for the document level allowance or charge, expressed as text
Example: "Freight"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_allowanceCharge_reason | - |
root_document_allowanceCharge_reason
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_allowanceCharge_reason |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: The reason for the document level allowance or charge, expressed as text
Example: "Freight"
percentage
| Type | number |
Description: Percentage used to calculate the amount
Example: 5.0
baseAmount
| Type | number |
Description: Base amount for calculating the charge or allowance
Example: 200.0
amount
| Type | number |
Description: Amount of the charge or allowance
Example: 10.0
tax
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_allowanceCharge_tax |
Description: Tax information related to charge or allowance
scheme
| Type | string |
| Default | "VAT" |
Description: Tax scheme
Example: "VAT"
category
| Type | string |
Description: Document level allowance or charge tax category code
Example: "standard_rate"
percentage
| Type | number |
Description: The tax category rate, represented as percentage that applies for the relevant tax category
Example: 25.5
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax |
Description: Tax details
Required
| Type | number |
Description: Total tax amount
Example: 51.0
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax_taxCurrency |
Description: Tax details for tax accounting currency
taxableAmount
| Type | number |
Description: Taxable base amount in tax accounting currency
amount
| Type | number |
Description: Tax amount in tax accounting currency
Required
| Type | array |
Description: Tax breakdown
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_tax_subTotals | - |
root_document_tax_subTotals
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax_subTotals |
taxableAmount
| Type | number |
Description: Taxable base amount
Example: 200.0
amount
| Type | number |
Description: Tax amount
Example: 51.0
tax
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax_subTotals_tax |
Description: Tax details
scheme
| Type | string |
| Default | "VAT" |
Description: Tax scheme
Example: "VAT"
category
| Type | string |
Description: Tax category code
Example: "standard_rate"
percentage
| Type | number |
Description: Tax percentage rate
Example: 25.5
exemption
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax_subTotals_tax_exemption |
Description: Tax exemption details
reasonCode
| Type | string |
Description: Tax exemption reason code
reason
| Type | array |
Description: Tax exemption reason text
Example: "Exempt"
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_tax_subTotals_tax_exemption_reason | - |
root_document_tax_subTotals_tax_exemption_reason
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_tax_subTotals_tax_exemption_reason |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Tax exemption reason text
Example: "Exempt"
Required
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_monetaryTotal |
Description: Monetary totals related to the document
Required
| Type | number |
Description: Sum of document line net amount
Example: 100.0
Required
| Type | number |
Description: Document total amount excluding tax
Example: 100.0
Required
| Type | number |
Description: Document total amount including tax
Example: 125.5
Optional
| Type | number |
Description: Sum of allowances on document level
Example: 0.0
Optional
| Type | number |
Description: Sum of charges on document level
Example: 0.0
Optional
| Type | number |
Description: The sum of amounts which have been paid in advance
Example: 0.0
Optional
| Type | number |
Description: Rounding amount
Example: 0.0
Required
| Type | number |
Description: Amount due for payment
Example: 125.5
Required
| Type | array |
Description: Document lines
| Array restrictions | |
|---|---|
| Min items | 1 |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines | - |
Optional
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines |
id
| Type | string |
Description: Invoice line identifier
Example: "1"
name
| Type | string |
Description: Item name
Example: "Item name"
note
| Type | array |
Description: Invoice line note
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_note | - |
root_document_lines_note
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_note |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Invoice line note
Example: "New article number 12345"
description
| Type | array |
Description: Item description
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_description | - |
root_document_lines_description
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_description |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Item description
Example: "Long description of the item on the invoice line"
invoicedObject
| Type | array |
Description: Invoice line object identifier
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_invoicedObject | - |
root_document_lines_invoicedObject
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_invoicedObject |
schemeID
| Type | string |
Description: Invoice line object identifier scheme identifier
Example: "ABZ"
value
| Type | string |
Description: Invoice line object identifier
Example: "AB12345"
buyerAccountingReference
| Type | array |
Description: Invoice line buyer accounting reference
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_buyerAccountingReference | - |
root_document_lines_buyerAccountingReference
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_buyerAccountingReference |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: Invoice line buyer accounting reference
Example: "1287:65464"
purchaseOrderReference
| Type | array |
Description: Purchase order reference
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_purchaseOrderReference | - |
root_document_lines_purchaseOrderReference
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_purchaseOrderReference |
lineID
| Type | string |
Description: Purchase order line reference
Example: "3"
sellersIdentifier
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_sellersIdentifier |
Description: Item sellers identifier
value
| Type | string |
Description: Item sellers identifier
Example: "9873242"
buyersIdentifier
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_buyersIdentifier |
Description: Item buyers identifier
value
| Type | string |
Description: Item buyers identifier
Example: "123455"
standardIdentifier
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_standardIdentifier |
Description: Item standard identifier
type
| Type | string |
Description: Item standard identifier type
Example: "GTIN"
value
| Type | string |
Description: Item standard identifier
Example: "10986700"
additionalProperties
| Type | array |
Description: Additional item properties
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_additionalProperties | - |
root_document_lines_additionalProperties
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_additionalProperties |
name
| Type | string |
Description: Line item attribute name
Example: "Color"
value
| Type | string |
Description: Line item attribute value
Example: "Black"
invoicePeriod
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_invoicePeriod |
Description: Invoice line invoice period
startDate
| Type | string |
| Format | date |
Description: Invoice line period start date
Example: "2025-01-01"
endDate
| Type | string |
| Format | date |
Description: Invoice line period end date
Example: "2025-01-20"
originCountry
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_originCountry |
Description: Item country of origin
code
| Type | string |
Description: Country code
Example: "DE"
classificationIdentifier
| Type | array |
Description: Item classification identifier
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_classificationIdentifier | - |
root_document_lines_classificationIdentifier
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_classificationIdentifier |
schemeVersionID
| Type | string |
Description: Item classification identifier identification scheme version identifier
Example: "19.05.01"
schemeID
| Type | string |
Description: Item classification identifier identification scheme identifier
Example: "STI"
value
| Type | string |
Description: Item classification identifier
Example: "9873242"
quantity
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_quantity |
Description: Quantity
charged
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_quantity_charged |
Description: Charged quantity
unitCode
| Type | string |
Description: Charged quantity unit of measure code
Example: "C62"
value
| Type | number |
Description: Charged quantity
Example: 5.0
unitPrice
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_unitPrice |
Description: Item net price
baseQuantity
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_unitPrice_baseQuantity |
Description: Item price base quantity
unitCode
| Type | string |
Description: Item price base quantity unit of measure code
Example: "C62"
value
| Type | number |
Description: Item price base quantity
Example: 1.0
grossAmount
| Type | number |
Description: Item gross price
Example: 15.0
discountAmount
| Type | number |
Description: Item price discount amount
Example: 5.0
netAmount
| Type | number |
Description: Item net price
Example: 10.0
allowanceCharge
| Type | array |
Description: Invoice line allowances and/or charges
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_allowanceCharge | - |
root_document_lines_allowanceCharge
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_allowanceCharge |
type
| Type | string |
Description: Type of ‘charge’ or ‘allowance’
Example: "charge"
reasonCode
| Type | string |
Description: The reason for the line level allowance or charge, expressed as a code
Example: "FC"
reason
| Type | array |
Description: The reason for the line level allowance or charge, expressed as text
| Array restrictions | |
|---|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
| Each item of this array must be | Description |
|---|---|
| root_document_lines_allowanceCharge_reason | - |
root_document_lines_allowanceCharge_reason
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_allowanceCharge_reason |
language
| Type | string |
Description: Text language code
Example: "en"
text
| Type | string |
Description: The reason for the line level allowance or charge, expressed as text
Example: "Freight"
percentage
| Type | number |
Description: Percentage used to calculate the amount. When percentage is provided, base amount must also be specified
Example: 200.0
baseAmount
| Type | number |
Description: Base amount for calculating the charge or allowance
Example: 50.0
amount
| Type | number |
Description: Amount of the charge or allowance
Example: 100.0
lineTotalNetAmount
| Type | number |
Description: Invoice line net amount
Example: 150.0
tax
| Type | object |
| Additional properties | Not allowed |
| Defined in | #/$defs/root_document_lines_tax |
scheme
| Type | string |
| Default | "VAT" |
Description: Tax scheme
Example: "VAT"
category
| Type | string |
Description: Invoiced item tax category code
Example: "standard_rate"
percentage
| Type | number |
Description: Invoiced item tax category rate
Example: 25.5
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!