MaventaJSON 1.0

Type: object

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.

 No Additional Properties

root formatName
Type: string

Name of the document format
Example:

"MaventaJSON"

root formatVersion
Type: string

Version of the format
Example:

"1.0.0"

root documentType
Type: string

Type of the document
Example:

"invoice"

root language
Type: string

Document language code
Example:

"en"

root createdBy
Type: object

Details about the system that created the document

 No Additional Properties

root createdBy system
Type: object

Metadata about the system that generated the document

 No Additional Properties

root createdBy system name
Type: string

Name of the system
Example:

"Maventa Converter"

root createdBy system version
Type: string

Version of the system
Example:

"2.28.6"

root createdBy system timestamp
Type: stringFormat: date-time

ISO 8601 timestamp when the document was generated
Example:

"2025-05-19T08:37:31Z"

root createdBy system metadata
Type: object

Additional metadata about the generating system

 No Additional Properties

root createdBy system metadata documentID
Type: string

Internal document identifier in the senders system

root createdBy system metadata notes
Type: array of string

Notes from the originating system

 No Additional Items

Each item of this array must be:

root createdBy system metadata notes notes items
Type: string

root createdBy system metadata libraries
Type: array

List of used libraries

 No Additional Items

Each item of this array must be:

root createdBy system metadata libraries root_createdBy_system_metadata_libraries
Type: object
No Additional Properties

root createdBy system metadata libraries libraries items name
Type: string

Name of the library
Example:

"converter-document"

root createdBy system metadata libraries libraries items version
Type: string

Version of the library
Example:

"0.11.4"

root createdBy system metadata patches
Type: array

List of applied patches

 No Additional Items

Each item of this array must be:

root createdBy system metadata patches root_createdBy_system_metadata_patches
Type: object
No Additional Properties

root createdBy system metadata patches patches items name
Type: string

Name of the patch applied

root createdBy system metadata patches patches items applied
Type: string

When the patch was applied
Example:

"after_import"

root endpoints
Type: object

Seller and buyer electronic addresses

 No Additional Properties

root endpoints sender
Type: object

Seller electronic address

 No Additional Properties

root endpoints sender id
Type: object

Seller electronic address identifier

 No Additional Properties

root endpoints sender id type
Type: string

Seller electronic address identifier type
Example:

"FI:OVTCODE"

root endpoints sender id value
Type: string

Seller electronic address identifier value
Example:

"003721291126"

root endpoints sender network
Type: string

Seller operator or network identifier
Example:

"MAVENTA"

root endpoints sender email
Type: array of stringFormat: email

Seller email address

 No Additional Items

Each item of this array must be:

root endpoints sender email email items
Type: string

Example:

"email@seller.com"

root endpoints receiver
Type: object

Buyer electronic address

 No Additional Properties

root endpoints receiver id
Type: object

Buyer electronic address identifier

 No Additional Properties

root endpoints receiver id type
Type: string

Buyer electronic address identifier type
Example:

"NO:ORGNR"

root endpoints receiver id value
Type: string

Buyer electronic address identifier value
Example:

"111111111"

root endpoints receiver network
Type: string

Buyer operator or network identifier

root endpoints receiver email
Type: array of stringFormat: email

Buyer email address

 No Additional Items

Each item of this array must be:

root endpoints receiver email email items
Type: string

Example:

[
    "email@buyer.com"
]

root attachments
Type: array

List of attachments related to the document

 No Additional Items

Each item of this array must be:

root attachments root_attachments
Type: object
No Additional Properties

root attachments attachments items primaryImage
Type: boolean Default: false

Indicates the primary image
Example:

false

root attachments attachments items id
Type: string

Identifier for the attachment
Example:

"123"

root attachments attachments items description
Type: array

Description of the attachment

Must contain a minimum of 1 items

Must contain a maximum of 1 items

No Additional Items

Each item of this array must be:

root attachments attachments items description root_attachments_description
Type: object
No Additional Properties

root attachments attachments items description description items language
Type: string

Text language code
Example:

"en"

root attachments attachments items description description items text
Type: string

Description of the attachment
Example:

"Technical specification"

root attachments attachments items filename
Type: string

Name of the attached file
Example:

"milage.csv"

root attachments attachments items mimeType
Type: string

MIME type of the content
Example:

"text/csv"

root attachments attachments items content
Type: string

Base64-encoded content of the attachment
Example:

"YTtiO2M7ZDtlO2Y7Zw=="

root attachments attachments items externalReference
Type: stringFormat: uri

External reference URL for the attachment
Example:

"http://www.techspec.no"

root document
Type: object

Document content

 No Additional Properties

root document id
Type: string

Unique identifier for the document
Example:

"12345678"

root document issueDate
Type: stringFormat: date

Date when the document was issued
Example:

"2025-01-01"

root document taxPointDate
Type: stringFormat: date

Tax point date
Example:

"2025-01-01"

root document taxPointDateCode
Type: string

Tax point date code
Example:

"3"

root document dueDate
Type: stringFormat: date

The date when the payment is due
Example:

"2025-02-01"

root document currency
Type: object

Currency details

 No Additional Properties

root document currency code
Type: string

Document currency code
Example:

"EUR"

root document currency taxCurrency
Type: object

Tax (VAT) accounting currency code

 No Additional Properties
Example:

"NOK"

root document currency taxCurrency code
Type: string

Tax (VAT) accounting currency code
Example:

"NOK"

root document invoicePeriod
Type: object

Period covered by the invoice

 No Additional Properties

root document invoicePeriod startDate
Type: stringFormat: date

Start date of the invoice period
Example:

"2025-01-01"

root document invoicePeriod endDate
Type: stringFormat: date

End date of the invoice period
Example:

"2025-01-20"

root document buyerReference
Type: array

Buyer reference information

 No Additional Items

Each item of this array must be:

root document buyerReference root_document_buyerReference
Type: object
No Additional Properties

root document buyerReference buyerReference items id
Type: string

Buyer reference information
Example:

"abs1234"

root document buyerAccountingReference
Type: array

Buyer accounting reference information

 No Additional Items

Each item of this array must be:

root document buyerAccountingReference root_document_buyerAccountingReference
Type: object
No Additional Properties

root document buyerAccountingReference buyerAccountingReference items language
Type: string

Text language code
Example:

"en"

root document buyerAccountingReference buyerAccountingReference items text
Type: string

Buyer accounting reference information
Example:

"4217:2323:2323"

root document precedingDocumentReference
Type: array

References to preceding documents

 No Additional Items

Each item of this array must be:

root document precedingDocumentReference root_document_precedingDocumentReference
Type: object
No Additional Properties

root document precedingDocumentReference precedingDocumentReference items id
Type: string

Preceding document identifier
Example:

"12345677"

root document precedingDocumentReference precedingDocumentReference items issueDate
Type: stringFormat: date

Preceding document issue date
Example:

"2024-12-01"

root document salesOrderReference
Type: array

Sales order references

 No Additional Items

Each item of this array must be:

root document salesOrderReference root_document_salesOrderReference
Type: object
No Additional Properties

root document salesOrderReference salesOrderReference items id
Type: string

Sales order references
Example:

"112233"

root document purchaseOrderReference
Type: array

Purchase order references

 No Additional Items

Each item of this array must be:

root document purchaseOrderReference root_document_purchaseOrderReference
Type: object
No Additional Properties

root document purchaseOrderReference purchaseOrderReference items id
Type: string

Purchase order references
Example:

"98776"

root document projectReference
Type: array

Associated project references

 No Additional Items

Each item of this array must be:

root document projectReference root_document_projectReference
Type: object
No Additional Properties

root document projectReference projectReference items id
Type: string

Associated project references
Example:

"PID33"

root document despatchDocumentReference
Type: array

Despatch document references

 No Additional Items

Each item of this array must be:

root document despatchDocumentReference root_document_despatchDocumentReference
Type: object
No Additional Properties

root document despatchDocumentReference despatchDocumentReference items id
Type: string

Despatch document references
Example:

"desp98"

root document originatorDocumentReference
Type: array

Originator document references

 No Additional Items

Each item of this array must be:

root document originatorDocumentReference root_document_originatorDocumentReference
Type: object
No Additional Properties

root document originatorDocumentReference originatorDocumentReference items id
Type: string

Originator document references
Example:

"PPID-123"

root document receiptDocumentReference
Type: array

Receipt document references

 No Additional Items

Each item of this array must be:

root document receiptDocumentReference root_document_receiptDocumentReference
Type: object
No Additional Properties

root document receiptDocumentReference receiptDocumentReference items id
Type: string

Receipt document references
Example:

"rec98"

root document contractDocumentReference
Type: array

Contract document references

 No Additional Items

Each item of this array must be:

root document contractDocumentReference root_document_contractDocumentReference
Type: object
No Additional Properties

root document contractDocumentReference contractDocumentReference items id
Type: string

Contract document references
Example:

"123Contractref"

root document invoicedObject
Type: array

Information about the invoiced object

 No Additional Items

Each item of this array must be:

root document invoicedObject root_document_invoicedObject
Type: object
No Additional Properties

root document invoicedObject invoicedObject items schemeID
Type: string

Invoiced object identifier scheme identifier
Example:

"AUN"

root document invoicedObject invoicedObject items value
Type: string

Invoiced object identifier
Example:

"AB23456"

root document additionalProperties
Type: array

Additional properties related to the document

 No Additional Items

Each item of this array must be:

root document additionalProperties root_document_additionalProperties
Type: object
No Additional Properties

root document additionalProperties additionalProperties items name
Type: string

Additional property name
Example:

"Time list"

root document additionalProperties additionalProperties items value
Type: string

Additional property value
Example:

"AB23456"

root document note
Type: array

Document level notes

 No Additional Items

Each item of this array must be:

root document note root_document_note
Type: object
No Additional Properties

root document note note items language
Type: string

Text language code
Example:

"en"

root document note note items text
Type: string

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"

root document note note items subjectCode
Type: string

Document level note subject code
Example:

"ZZZ"

root document seller
Type: object

Seller details

 No Additional Properties

root document seller partyIdentifiers
Type: array

Seller party identifiers

 No Additional Items

Each item of this array must be:

root document seller partyIdentifiers root_document_seller_partyIdentifiers
Type: object
No Additional Properties

root document seller partyIdentifiers partyIdentifiers items type
Type: string

Seller party identifier type
Example:

"FI:ORGNR"

root document seller partyIdentifiers partyIdentifiers items value
Type: string

Seller party identifier value. May be used to identify the seller.
Example:

"2129112-6"

root document seller name
Type: array of string

Seller trading/business name

 No Additional Items

Each item of this array must be:

root document seller name name items
Type: string

Example:

"Seller Business Name"

root document seller address
Type: object

Seller postal address details

 No Additional Properties

root document seller address street1
Type: string

Seller address line 1. The main address line in an address
Example:

"Pasilan asema-aukio 1"

root document seller address street2
Type: string

Seller address line 2. An additional address line in an address that can be used to give further details supplementing the main line

root document seller address street3
Type: string

Seller address line 3. An additional address line in an address that can be used to give further details supplementing the main line

root document seller address postOffice
Type: string

Seller city, town, village or post office
Example:

"Helsinki"

root document seller address postCode
Type: string

Seller post code
Example:

"00520"

root document seller address country
Type: object

Seller country details

 No Additional Properties

root document seller address country subDivision
Type: string

Seller country subdivision
Example:

"Uusimaa"

root document seller address country code
Type: string

Seller country code
Example:

"FI"

root document seller legalEntity
Type: object

Party legal entity details

 No Additional Properties

root document seller legalEntity name
Type: array of string

The full name of the seller

 No Additional Items

Each item of this array must be:

root document seller legalEntity name name items
Type: string

Example:

"Full formal name"

root document seller legalEntity id
Type: object

Seller legal entity identifier

 No Additional Properties
Example:

"2129112-6"

root document seller legalEntity id type
Type: string

Seller legal entity identifier type
Example:

"FI:ORGNR"

root document seller legalEntity id value
Type: string

Seller legal entity identifier value
Example:

"2129112-6"

root document seller legalEntity additionalLegalInfo
Type: string

Seller additional legal information
Example:

"Share capital"

root document seller tax
Type: object

Seller tax identifier

 No Additional Properties

root document seller tax scheme
Type: string Default: "VAT"

Seller tax identifier scheme
Example:

"VAT"

root document seller tax id
Type: object

Seller tax identifier

 No Additional Properties
Example:

"FI21291126"

root document seller tax id type
Type: string

Seller tax identifier type
Example:

"FI:VAT"

root document seller tax id value
Type: string

Seller tax identifier value
Example:

"FI21291126"

root document seller tax registrationID
Type: string

Seller tax registration identifier

root document seller contact
Type: object

Seller contact details

 No Additional Properties

root document seller contact name
Type: string

Seller contact point for a legal entity or person
Example:

"xyz123"

root document seller contact telephone
Type: string

Seller phone number for the contact point
Example:

"887 654 321"

root document seller contact email
Type: stringFormat: email

Seller email address for the contact point
Example:

"contact@seller.com"

root document sellerTaxRepresentative
Type: object

Sellers tax representative party details

 No Additional Properties

root document sellerTaxRepresentative name
Type: array of string

Seller tax representative name

 No Additional Items

Each item of this array must be:

root document sellerTaxRepresentative name name items
Type: string

Example:

"Tax Representative Name"

root document sellerTaxRepresentative address
Type: object

Seller tax representative postal address details

 No Additional Properties

root document sellerTaxRepresentative address street1
Type: string

Tax representative address line 1. The main address line in an address
Example:

"Address line 1"

root document sellerTaxRepresentative address street2
Type: string

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"

root document sellerTaxRepresentative address street3
Type: string

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"

root document sellerTaxRepresentative address postOffice
Type: string

Tax representative city, town, village or post office
Example:

"Göteborg"

root document sellerTaxRepresentative address postCode
Type: string

Tax representative post code
Example:

"12345"

root document sellerTaxRepresentative address country
Type: object

Tax representative country details

 No Additional Properties

root document sellerTaxRepresentative address country subDivision
Type: string

Tax representative country subdivision
Example:

"Region Vest"

root document sellerTaxRepresentative address country code
Type: string

Tax representative country code
Example:

"SE"

root document sellerTaxRepresentative tax
Type: object

Seller tax representative tax identifier

 No Additional Properties

root document sellerTaxRepresentative tax scheme
Type: string Default: "VAT"

Seller tax representative tax identifier scheme
Example:

"VAT"

root document sellerTaxRepresentative tax id
Type: object

Seller tax representative tax identifier

 No Additional Properties
Example:

"FI00800008"

root document sellerTaxRepresentative tax id type
Type: string

Seller tax representative tax identifier type
Example:

"FI:VAT"

root document sellerTaxRepresentative tax id value
Type: string

Seller tax representative tax identifier
Example:

"FI00800008"

root document buyer
Type: object

Buyer details

 No Additional Properties

root document buyer partyIdentifiers
Type: array

Buyer party identifiers

 No Additional Items

Each item of this array must be:

root document buyer partyIdentifiers root_document_buyer_partyIdentifiers
Type: object
No Additional Properties

root document buyer partyIdentifiers partyIdentifiers items type
Type: string

Buyer party identifier type
Example:

"NO:ORGNR"

root document buyer partyIdentifiers partyIdentifiers items value
Type: string

Buyer party identifier value. May be used to identify the buyer.
Example:

"111111111"

Example:

"111111111"

root document buyer name
Type: array of string

Buyer trading/business name

 No Additional Items

Each item of this array must be:

root document buyer name name items
Type: string

Example:

"Buyer Trading Name"

root document buyer address
Type: object

Buyer postal address details

 No Additional Properties

root document buyer address street1
Type: string

Buyer address line 1. The main address line in an address
Example:

"Karenslyst allé 56"

root document buyer address street2
Type: string

Buyer address line 2. An additional address line in an address that can be used to give further details supplementing the main line

root document buyer address street3
Type: string

Buyer address line 3. An additional address line in an address that can be used to give further details supplementing the main line

root document buyer address postOffice
Type: string

Buyer city, town, village or post office
Example:

"Oslo"

root document buyer address postCode
Type: string

Buyer post code
Example:

"0277"

root document buyer address country
Type: object

Buyer country details

 No Additional Properties

root document buyer address country subDivision
Type: string

Buyer country subdivision
Example:

"Oslo"

root document buyer address country code
Type: string

Buyer country code
Example:

"NO"

root document buyer legalEntity
Type: object

Party legal entity details

 No Additional Properties

root document buyer legalEntity name
Type: array of string

The full name of the buyer

 No Additional Items

Each item of this array must be:

root document buyer legalEntity name name items
Type: string

Example:

"Full formal name"

root document buyer legalEntity id
Type: object

Buyer legal registration identifier

 No Additional Properties
Example:

"111111111"

root document buyer legalEntity id type
Type: string

Buyer legal entity identifier type
Example:

"NO:ORGNR"

root document buyer legalEntity id value
Type: string

Buyer legal entity identifier value
Example:

"111111111"

root document buyer tax
Type: object

Buyer tax identifier

 No Additional Properties

root document buyer tax scheme
Type: string Default: "VAT"

Buyer tax identifier scheme
Example:

"VAT"

root document buyer tax id
Type: object

Buyer tax identifier

 No Additional Properties
Example:

"NO111111111"

root document buyer tax id type
Type: string

Buyer tax identifier type
Example:

"NO:VAT"

root document buyer tax id value
Type: string

Buyer tax identifier value
Example:

"NO111111111"

root document buyer contact
Type: object

Buyer contact details

 No Additional Properties

root document buyer contact name
Type: string

Buyer contact point for a legal entity or person
Example:

"Jens Jensen"

root document buyer contact telephone
Type: string

Buyer phone number for the contact point
Example:

"876 654 321"

root document buyer contact email
Type: stringFormat: email

Buyer email address for the contact point
Example:

"contact@buyer.com"

root document delivery
Type: object

Delivery information

 No Additional Properties

root document delivery date
Type: stringFormat: date

Actual delivery date
Example:

"2025-02-01"

root document delivery locationID
Type: object

Delivery location identifier

 No Additional Properties
Example:

"1111111111116"

root document delivery locationID type
Type: string

Delivery location identifier type
Example:

"GLN"

root document delivery locationID value
Type: string

Delivery location identifier value
Example:

"1111111111116"

root document delivery name
Type: array of string

The name of the party to which the goods and services are delivered

 No Additional Items

Each item of this array must be:

root document delivery name name items
Type: string

Example:

"DeliveryPartyName"

root document delivery address
Type: object

Delivery postal address details

 No Additional Properties

root document delivery address street1
Type: string

Deliver address line 1. The main address line in an address
Example:

"Delivery Street 1"

root document delivery address street2
Type: string

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"

root document delivery address street3
Type: string

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"

root document delivery address postOffice
Type: string

City, town, village or post office
Example:

"Oslo"

root document delivery address postCode
Type: string

Post code
Example:

"0277"

root document delivery address country
Type: object

Delivery country details

 No Additional Properties

root document delivery address country subDivision
Type: string

Delivery country subdivision
Example:

"South Region"

root document delivery address country code
Type: string

Delivery country code
Example:

"NO"

root document payee
Type: object

Payee details

 No Additional Properties

root document payee partyIdentifiers
Type: array

Payee party identifiers

 No Additional Items

Each item of this array must be:

root document payee partyIdentifiers root_document_payee_partyIdentifiers
Type: object
No Additional Properties

root document payee partyIdentifiers partyIdentifiers items type
Type: string

Payee party identifier type
Example:

"FI:ORGNR"

root document payee partyIdentifiers partyIdentifiers items value
Type: string

Payee party identifier value
Example:

"2129112-6"

root document payee name
Type: array of string

Payee name

 No Additional Items

Each item of this array must be:

root document payee name name items
Type: string

Example:

"Payee name"

root document payee legalEntity
Type: object

Payee legal entity details

 No Additional Properties

root document payee legalEntity name
Type: array of string

The full name of the payee

 No Additional Items

Each item of this array must be:

root document payee legalEntity name name items
Type: string

Example:

"Full formal name"

root document payee legalEntity id
Type: object

Payee legal entity identifier

 No Additional Properties
Example:

"2129112-6"

root document payee legalEntity id type
Type: string

Payee legal entity identifier type
Example:

"FI:ORGNR"

root document payee legalEntity id value
Type: string

Payee legal entity identifier value
Example:

"2129112-6"

root document payment
Type: object

Payment terms and instructions

 No Additional Properties

root document payment terms
Type: array

Payment terms

 No Additional Items

Each item of this array must be:

root document payment terms root_document_payment_terms
Type: object
No Additional Properties

root document payment terms terms items id
Type: string

Payment terms identifier

root document payment terms terms items paymentMeansID
Type: string

Payment instruction identifier related to given payment terms

root document payment terms terms items note
Type: array

A textual description of the payment terms

Must contain a minimum of 1 items

Must contain a maximum of 1 items

No Additional Items

Each item of this array must be:

root document payment terms terms items note root_document_payment_terms_note
Type: object
No Additional Properties

root document payment terms terms items note note items language
Type: string

Text language code
Example:

"en"

root document payment terms terms items note note items text
Type: string

A textual description of the payment terms

root document payment terms terms items amount
Type: number

The payment amount that these terms apply to

root document payment terms terms items installment
Type: object

Payment terms installment

 No Additional Properties

root document payment terms terms items installment dueDate
Type: stringFormat: date

Payment terms installment due date. The date before end of which the terms amount shall be settled

root document payment instructions
Type: array

Payment instructions

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root document payment instructions root_document_payment_instructions
Type: object
No Additional Properties

root document payment instructions instructions items type
Type: string

Payment means type

root document payment instructions instructions items typeName
Type: string

Payment means expressed as text

root document payment instructions instructions items paymentID
Type: object

Remittance information

 No Additional Properties

root document payment instructions instructions items paymentID type
Type: string

Payment instruction identifier type

root document payment instructions instructions items paymentID value
Type: string

Remittance information. A textual value used to establish a link between the payment and the invoice
Example:

"432948234234234"

root document payment instructions instructions items mandateID
Type: string

Payee-assigned identifier for referencing the SEPA mandate and pre-notifying the Buyer

root document payment instructions instructions items creditorID
Type: string

Bank assigned creditor identifier used for direct debiting

root document payment instructions instructions items cardAccount
Type: object

Payment card information

 No Additional Properties

root document payment instructions instructions items cardAccount primaryAccountNumber
Type: string

Payment card primary account number (PAN)

root document payment instructions instructions items cardAccount networkID
Type: string

Payment card network identifier

root document payment instructions instructions items cardAccount holderName
Type: string

Payment card holder name

root document payment instructions instructions items account
Type: object

Account details

 No Additional Properties

root document payment instructions instructions items account name
Type: string

Account name
Example:

"Payment Account"

root document payment instructions instructions items account type
Type: string

Account type
Example:

"IBAN"

root document payment instructions instructions items account id
Type: string

Account identifier
Example:

"FI5810203000100011"

root document payment instructions instructions items account institution
Type: object

Account financial institution

 No Additional Properties

root document payment instructions instructions items account institution id
Type: string

Payment service provider identifier, BIC/SWIFT etc
Example:

"BICXFIHH"

root document allowanceCharge
Type: array

Document level allowances and charges

 No Additional Items

Each item of this array must be:

root document allowanceCharge root_document_allowanceCharge
Type: object
No Additional Properties

root document allowanceCharge allowanceCharge items type
Type: string

Type of 'charge' or 'allowance'
Example:

"charge"

root document allowanceCharge allowanceCharge items reasonCode
Type: string

The reason for the document level allowance or charge, expressed as a code
Example:

"FC"

root document allowanceCharge allowanceCharge items reason
Type: array

The reason for the document level allowance or charge, expressed as text

 No Additional Items

Each item of this array must be:

root document allowanceCharge allowanceCharge items reason root_document_allowanceCharge_reason
Type: object
No Additional Properties

root document allowanceCharge allowanceCharge items reason reason items language
Type: string

Text language code
Example:

"en"

root document allowanceCharge allowanceCharge items reason reason items text
Type: string

The reason for the document level allowance or charge, expressed as text
Example:

"Freight"

Example:

"Freight"

root document allowanceCharge allowanceCharge items percentage
Type: number

Percentage used to calculate the amount
Example:

5.0

root document allowanceCharge allowanceCharge items baseAmount
Type: number

Base amount for calculating the charge or allowance
Example:

200.0

root document allowanceCharge allowanceCharge items amount
Type: number

Amount of the charge or allowance
Example:

10.0

root document allowanceCharge allowanceCharge items tax
Type: object

Tax information related to charge or allowance

 No Additional Properties

root document allowanceCharge allowanceCharge items tax scheme
Type: string Default: "VAT"

Tax scheme
Example:

"VAT"

root document allowanceCharge allowanceCharge items tax category
Type: string

Document level allowance or charge tax category code
Example:

"standard_rate"

root document allowanceCharge allowanceCharge items tax percentage
Type: number

The tax category rate, represented as percentage that applies for the relevant tax category
Example:

25.5

root document tax
Type: object

Tax details

 No Additional Properties

root document tax amount
Type: number

Total tax amount
Example:

51.0

root document tax taxCurrency
Type: object

Tax details for tax accounting currency

 No Additional Properties

root document tax taxCurrency taxableAmount
Type: number

Taxable base amount in tax accounting currency

root document tax taxCurrency amount
Type: number

Tax amount in tax accounting currency

root document tax subTotals
Type: array

Tax breakdown

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root document tax subTotals root_document_tax_subTotals
Type: object
No Additional Properties

root document tax subTotals subTotals items taxableAmount
Type: number

Taxable base amount
Example:

200.0

root document tax subTotals subTotals items amount
Type: number

Tax amount
Example:

51.0

root document tax subTotals subTotals items tax
Type: object

Tax details

 No Additional Properties

root document tax subTotals subTotals items tax scheme
Type: string Default: "VAT"

Tax scheme
Example:

"VAT"

root document tax subTotals subTotals items tax category
Type: string

Tax category code
Example:

"standard_rate"

root document tax subTotals subTotals items tax percentage
Type: number

Tax percentage rate
Example:

25.5

root document tax subTotals subTotals items tax exemption
Type: object

Tax exemption details

 No Additional Properties

root document tax subTotals subTotals items tax exemption reasonCode
Type: string

Tax exemption reason code

root document tax subTotals subTotals items tax exemption reason
Type: array

Tax exemption reason text

 No Additional Items

Each item of this array must be:

root document tax subTotals subTotals items tax exemption reason root_document_tax_subTotals_tax_exemption_reason
Type: object
No Additional Properties

root document tax subTotals subTotals items tax exemption reason reason items language
Type: string

Text language code
Example:

"en"

root document tax subTotals subTotals items tax exemption reason reason items text
Type: string

Tax exemption reason text
Example:

"Exempt"

Example:

"Exempt"

root document monetaryTotal
Type: object

Monetary totals related to the document

 No Additional Properties

root document monetaryTotal linesTotalAmount
Type: number

Sum of document line net amount
Example:

100.0

root document monetaryTotal taxExclusiveAmount
Type: number

Document total amount excluding tax
Example:

100.0

root document monetaryTotal taxInclusiveAmount
Type: number

Document total amount including tax
Example:

125.5

root document monetaryTotal allowanceTotalAmount
Type: number

Sum of allowances on document level
Example:

0.0

root document monetaryTotal chargeTotalAmount
Type: number

Sum of charges on document level
Example:

0.0

root document monetaryTotal prepaidAmount
Type: number

The sum of amounts which have been paid in advance
Example:

0.0

root document monetaryTotal roundingAmount
Type: number

Rounding amount
Example:

0.0

root document monetaryTotal payableAmount
Type: number

Amount due for payment
Example:

125.5

root document lines
Type: array

Document lines

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

root document lines root_document_lines
Type: object
No Additional Properties

root document lines lines items id
Type: string

Invoice line identifier
Example:

"1"

root document lines lines items name
Type: string

Item name
Example:

"Item name"

root document lines lines items note
Type: array

Invoice line note

 No Additional Items

Each item of this array must be:

root document lines lines items note root_document_lines_note
Type: object
No Additional Properties

root document lines lines items note note items language
Type: string

Text language code
Example:

"en"

root document lines lines items note note items text
Type: string

Invoice line note
Example:

"New article number 12345"

root document lines lines items description
Type: array

Item description

 No Additional Items

Each item of this array must be:

root document lines lines items description root_document_lines_description
Type: object
No Additional Properties

root document lines lines items description description items language
Type: string

Text language code
Example:

"en"

root document lines lines items description description items text
Type: string

Item description
Example:

"Long description of the item on the invoice line"

root document lines lines items invoicedObject
Type: array

Invoice line object identifier

 No Additional Items

Each item of this array must be:

root document lines lines items invoicedObject root_document_lines_invoicedObject
Type: object
No Additional Properties

root document lines lines items invoicedObject invoicedObject items schemeID
Type: string

Invoice line object identifier scheme identifier
Example:

"ABZ"

root document lines lines items invoicedObject invoicedObject items value
Type: string

Invoice line object identifier
Example:

"AB12345"

root document lines lines items buyerAccountingReference
Type: array

Invoice line buyer accounting reference

 No Additional Items

Each item of this array must be:

root document lines lines items buyerAccountingReference root_document_lines_buyerAccountingReference
Type: object
No Additional Properties

root document lines lines items buyerAccountingReference buyerAccountingReference items text
Type: string

Invoice line buyer accounting reference
Example:

"1287:65464"

root document lines lines items purchaseOrderReference
Type: array

Purchase order reference

 No Additional Items

Each item of this array must be:

root document lines lines items purchaseOrderReference root_document_lines_purchaseOrderReference
Type: object
No Additional Properties

root document lines lines items purchaseOrderReference purchaseOrderReference items lineID
Type: string

Purchase order line reference
Example:

"3"

root document lines lines items sellersIdentifier
Type: object

Item sellers identifier

 No Additional Properties

root document lines lines items sellersIdentifier value
Type: string

Item sellers identifier
Example:

"9873242"

root document lines lines items buyersIdentifier
Type: object

Item buyers identifier

 No Additional Properties

root document lines lines items buyersIdentifier value
Type: string

Item buyers identifier
Example:

"123455"

root document lines lines items standardIdentifier
Type: object

Item standard identifier

 No Additional Properties

root document lines lines items standardIdentifier type
Type: string

Item standard identifier type
Example:

"GTIN"

root document lines lines items standardIdentifier value
Type: string

Item standard identifier
Example:

"10986700"

root document lines lines items additionalProperties
Type: array

Additional item properties

 No Additional Items

Each item of this array must be:

root document lines lines items additionalProperties root_document_lines_additionalProperties
Type: object
No Additional Properties

root document lines lines items additionalProperties additionalProperties items name
Type: string

Line item attribute name
Example:

"Color"

root document lines lines items additionalProperties additionalProperties items value
Type: string

Line item attribute value
Example:

"Black"

root document lines lines items invoicePeriod
Type: object

Invoice line invoice period

 No Additional Properties

root document lines lines items invoicePeriod startDate
Type: stringFormat: date

Invoice line period start date
Example:

"2025-01-01"

root document lines lines items invoicePeriod endDate
Type: stringFormat: date

Invoice line period end date
Example:

"2025-01-20"

root document lines lines items originCountry
Type: object

Item country of origin

 No Additional Properties

root document lines lines items originCountry code
Type: string

Country code
Example:

"DE"

root document lines lines items classificationIdentifier
Type: array

Item classification identifier

 No Additional Items

Each item of this array must be:

root document lines lines items classificationIdentifier root_document_lines_classificationIdentifier
Type: object
No Additional Properties

root document lines lines items classificationIdentifier classificationIdentifier items schemeVersionID
Type: string

Item classification identifier identification scheme version identifier
Example:

"19.05.01"

root document lines lines items classificationIdentifier classificationIdentifier items schemeID
Type: string

Item classification identifier identification scheme identifier
Example:

"STI"

root document lines lines items classificationIdentifier classificationIdentifier items value
Type: string

Item classification identifier
Example:

"9873242"

root document lines lines items quantity
Type: object

Quantity

 No Additional Properties

root document lines lines items quantity charged
Type: object

Charged quantity

 No Additional Properties

root document lines lines items quantity charged unitCode
Type: string

Charged quantity unit of measure code
Example:

"C62"

root document lines lines items quantity charged value
Type: number

Charged quantity
Example:

5.0

root document lines lines items unitPrice
Type: object

Item net price

 No Additional Properties

root document lines lines items unitPrice baseQuantity
Type: object

Item price base quantity

 No Additional Properties

root document lines lines items unitPrice baseQuantity unitCode
Type: string

Item price base quantity unit of measure code
Example:

"C62"

root document lines lines items unitPrice baseQuantity value
Type: number

Item price base quantity
Example:

1.0

root document lines lines items unitPrice grossAmount
Type: number

Item gross price
Example:

15.0

root document lines lines items unitPrice discountAmount
Type: number

Item price discount amount
Example:

5.0

root document lines lines items unitPrice netAmount
Type: number

Item net price
Example:

10.0

root document lines lines items allowanceCharge
Type: array

Invoice line allowances and/or charges

 No Additional Items

Each item of this array must be:

root document lines lines items allowanceCharge root_document_lines_allowanceCharge
Type: object
No Additional Properties

root document lines lines items allowanceCharge allowanceCharge items type
Type: string

Type of 'charge' or 'allowance'
Example:

"charge"

root document lines lines items allowanceCharge allowanceCharge items reasonCode
Type: string

The reason for the line level allowance or charge, expressed as a code
Example:

"FC"

root document lines lines items allowanceCharge allowanceCharge items reason
Type: array

The reason for the line level allowance or charge, expressed as text

 No Additional Items

Each item of this array must be:

root document lines lines items allowanceCharge allowanceCharge items reason root_document_lines_allowanceCharge_reason
Type: object
No Additional Properties

root document lines lines items allowanceCharge allowanceCharge items reason reason items language
Type: string

Text language code
Example:

"en"

root document lines lines items allowanceCharge allowanceCharge items reason reason items text
Type: string

The reason for the line level allowance or charge, expressed as text
Example:

"Freight"

root document lines lines items allowanceCharge allowanceCharge items percentage
Type: number

Percentage used to calculate the amount. When percentage is provided, base amount must also be specified
Example:

200.0

root document lines lines items allowanceCharge allowanceCharge items baseAmount
Type: number

Base amount for calculating the charge or allowance
Example:

50.0

root document lines lines items allowanceCharge allowanceCharge items amount
Type: number

Amount of the charge or allowance
Example:

100.0

root document lines lines items lineTotalNetAmount
Type: number

Invoice line net amount
Example:

150.0

root document lines lines items tax
Type: object
No Additional Properties

root document lines lines items tax scheme
Type: string Default: "VAT"

Tax scheme
Example:

"VAT"

root document lines lines items tax category
Type: string

Invoiced item tax category code
Example:

"standard_rate"

root document lines lines items tax percentage
Type: number

Invoiced item tax category rate
Example:

25.5