Get started Integration Guide Services & Reach API Specification Changelogs
Search
Getting Started Invoice sending Invoice sending Consumer Invoicing Printing Email Invoicing Invoice Receiving Invoice Receiving Scanning Detect Fraud reporting Integration tools Webhooks Reference implementations Maventa Connector Embeddable User Interface Peppol Peppol Network Document Exchange Invoice Response Self-billing support Invoicing formats Invoicing formats Validation Peppol BIS 3.0 Preview Maventa JSON (table) Preview Maventa JSON (json schema) Account Management Companies and Settings Users Billing

Maventa JSON (json schema)

Preview

The MaventaJSON 1.0 Invoice format provides a unified structure for electronic invoices. It brings together common elements from multiple international and national invoice standards and extends them where needed to support a broader range of business and interoperability requirements.

Schema Docs 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.

formatName Required

   
Type string

Description: Name of the document format

Example: "MaventaJSON"

formatVersion Required

   
Type string

Description: Version of the format

Example: "1.0.0"

documentType Required

   
Type string

Description: Type of the document

Example: "invoice"

language Optional

   
Type string

Description: Document language code

Example: "en"

createdBy Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_createdBy

Description: Details about the system that created the document

system Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_createdBy_system

Description: Metadata about the system that generated the document

name Required

   
Type string

Description: Name of the system

Example: "Maventa Converter"

version Required

   
Type string

Description: Version of the system

Example: "2.28.6"

timestamp Required

   
Type string
Format date-time

Description: ISO 8601 timestamp when the document was generated

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

metadata Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_createdBy_system_metadata

Description: Additional metadata about the generating system

documentID Optional

   
Type string

Description: Internal document identifier in the senders system

notes Optional

   
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 Optional

   
Type string

libraries Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_createdBy_system_metadata_libraries

name Required

   
Type string

Description: Name of the library

Example: "converter-document"

version Required

   
Type string

Description: Version of the library

Example: "0.11.4"

patches Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_createdBy_system_metadata_patches

name Required

   
Type string

Description: Name of the patch applied

applied Optional

   
Type string

Description: When the patch was applied

Example: "after_import"

endpoints Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_endpoints

Description: Seller and buyer electronic addresses

sender Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_endpoints_sender

Description: Seller electronic address

id Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_endpoints_sender_id

Description: Seller electronic address identifier

type Required

   
Type string

Description: Seller electronic address identifier type

Example: "FI:OVTCODE"

value Required

   
Type string

Description: Seller electronic address identifier value

Example: "003721291126"

network Optional

   
Type string

Description: Seller operator or network identifier

Example: "MAVENTA"

email 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 Optional

   
Type string

receiver Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_endpoints_receiver

Description: Buyer electronic address

id Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_endpoints_receiver_id

Description: Buyer electronic address identifier

type Required

   
Type string

Description: Buyer electronic address identifier type

Example: "NO:ORGNR"

value Required

   
Type string

Description: Buyer electronic address identifier value

Example: "111111111"

network Optional

   
Type string

Description: Buyer operator or network identifier

email 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 Optional

   
Type string

attachments 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 -

root_attachments Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_attachments

primaryImage Optional

   
Type boolean
Default false

Description: Indicates the primary image

Example: false

id Required

   
Type string

Description: Identifier for the attachment

Example: "123"

description 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_attachments_description

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Description of the attachment

Example: "Technical specification"

filename Optional

   
Type string

Description: Name of the attached file

Example: "milage.csv"

mimeType Optional

   
Type string

Description: MIME type of the content

Example: "text/csv"

content Optional

   
Type string

Description: Base64-encoded content of the attachment

Example: "YTtiO2M7ZDtlO2Y7Zw=="

externalReference Optional

   
Type string
Format uri

Description: External reference URL for the attachment

Example: "http://www.techspec.no"

document Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document

Description: Document content

id Required

   
Type string

Description: Unique identifier for the document

Example: "12345678"

issueDate Required

   
Type string
Format date

Description: Date when the document was issued

Example: "2025-01-01"

taxPointDate Optional

   
Type string
Format date

Description: Tax point date

Example: "2025-01-01"

taxPointDateCode Optional

   
Type string

Description: Tax point date code

Example: "3"

dueDate Required

   
Type string
Format date

Description: The date when the payment is due

Example: "2025-02-01"

currency Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_currency

Description: Currency details

code Required

   
Type string

Description: Document currency code

Example: "EUR"

taxCurrency Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_currency_taxCurrency

Description: Tax (VAT) accounting currency code

Example: "NOK"

code Required

   
Type string

Description: Tax (VAT) accounting currency code

Example: "NOK"

invoicePeriod Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_invoicePeriod

Description: Period covered by the invoice

startDate Required

   
Type string
Format date

Description: Start date of the invoice period

Example: "2025-01-01"

endDate Required

   
Type string
Format date

Description: End date of the invoice period

Example: "2025-01-20"

buyerReference 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 -

root_document_buyerReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyerReference

id Required

   
Type string

Description: Buyer reference information

Example: "abs1234"

buyerAccountingReference 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 -

root_document_buyerAccountingReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyerAccountingReference

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Buyer accounting reference information

Example: "4217:2323:2323"

precedingDocumentReference 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 -

root_document_precedingDocumentReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_precedingDocumentReference

id Required

   
Type string

Description: Preceding document identifier

Example: "12345677"

issueDate Required

   
Type string
Format date

Description: Preceding document issue date

Example: "2024-12-01"

salesOrderReference 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 -

root_document_salesOrderReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_salesOrderReference

id Required

   
Type string

Description: Sales order references

Example: "112233"

purchaseOrderReference 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 -

root_document_purchaseOrderReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_purchaseOrderReference

id Required

   
Type string

Description: Purchase order references

Example: "98776"

projectReference 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 -

root_document_projectReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_projectReference

id Required

   
Type string

Description: Associated project references

Example: "PID33"

despatchDocumentReference 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 -

root_document_despatchDocumentReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_despatchDocumentReference

id Required

   
Type string

Description: Despatch document references

Example: "desp98"

originatorDocumentReference 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 -

root_document_originatorDocumentReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_originatorDocumentReference

id Required

   
Type string

Description: Originator document references

Example: "PPID-123"

receiptDocumentReference 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 -

root_document_receiptDocumentReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_receiptDocumentReference

id Required

   
Type string

Description: Receipt document references

Example: "rec98"

contractDocumentReference 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 -

root_document_contractDocumentReference Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_contractDocumentReference

id Required

   
Type string

Description: Contract document references

Example: "123Contractref"

invoicedObject 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 -

root_document_invoicedObject Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_invoicedObject

schemeID Optional

   
Type string

Description: Invoiced object identifier scheme identifier

Example: "AUN"

value Required

   
Type string

Description: Invoiced object identifier

Example: "AB23456"

additionalProperties 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 -

root_document_additionalProperties Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_additionalProperties

name Required

   
Type string

Description: Additional property name

Example: "Time list"

value Required

   
Type string

Description: Additional property value

Example: "AB23456"

note 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 -

root_document_note Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_note

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
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 Optional

   
Type string

Description: Document level note subject code

Example: "ZZZ"

seller Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller

Description: Seller details

partyIdentifiers 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_partyIdentifiers

type Optional

   
Type string

Description: Seller party identifier type

Example: "FI:ORGNR"

value Required

   
Type string

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

Example: "2129112-6"

name 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 Optional

   
Type string

address Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_address

Description: Seller postal address details

street1 Optional

   
Type string

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

Example: "Pasilan asema-aukio 1"

street2 Optional

   
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 Optional

   
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 Optional

   
Type string

Description: Seller city, town, village or post office

Example: "Helsinki"

postCode Optional

   
Type string

Description: Seller post code

Example: "00520"

country Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_address_country

Description: Seller country details

subDivision Optional

   
Type string

Description: Seller country subdivision

Example: "Uusimaa"

code Optional

   
Type string

Description: Seller country code

Example: "FI"

legalEntity Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_legalEntity

Description: Party legal entity details

name Required

   
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 Optional

   
Type string

id Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_legalEntity_id

Description: Seller legal entity identifier

Example: "2129112-6"

type Optional

   
Type string

Description: Seller legal entity identifier type

Example: "FI:ORGNR"

value Required

   
Type string

Description: Seller legal entity identifier value

Example: "2129112-6"

additionalLegalInfo Optional

   
Type string

Description: Seller additional legal information

Example: "Share capital"

tax Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_tax

Description: Seller tax identifier

scheme Required

   
Type string
Default "VAT"

Description: Seller tax identifier scheme

Example: "VAT"

id Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_tax_id

Description: Seller tax identifier

Example: "FI21291126"

type Optional

   
Type string

Description: Seller tax identifier type

Example: "FI:VAT"

value Required

   
Type string

Description: Seller tax identifier value

Example: "FI21291126"

registrationID Optional

   
Type string

Description: Seller tax registration identifier

contact Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_seller_contact

Description: Seller contact details

name Optional

   
Type string

Description: Seller contact point for a legal entity or person

Example: "xyz123"

telephone Optional

   
Type string

Description: Seller phone number for the contact point

Example: "887 654 321"

email Optional

   
Type string
Format email

Description: Seller email address for the contact point

Example: "contact@seller.com"

sellerTaxRepresentative Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_sellerTaxRepresentative

Description: Sellers tax representative party details

name 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 Optional

   
Type string

address Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_sellerTaxRepresentative_address

Description: Seller tax representative postal address details

street1 Optional

   
Type string

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

Example: "Address line 1"

street2 Optional

   
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 Optional

   
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 Optional

   
Type string

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

Example: "Göteborg"

postCode Optional

   
Type string

Description: Tax representative post code

Example: "12345"

country Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_sellerTaxRepresentative_address_country

Description: Tax representative country details

subDivision Optional

   
Type string

Description: Tax representative country subdivision

Example: "Region Vest"

code Optional

   
Type string

Description: Tax representative country code

Example: "SE"

tax Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_sellerTaxRepresentative_tax

Description: Seller tax representative tax identifier

scheme Required

   
Type string
Default "VAT"

Description: Seller tax representative tax identifier scheme

Example: "VAT"

id Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_sellerTaxRepresentative_tax_id

Description: Seller tax representative tax identifier

Example: "FI00800008"

type Optional

   
Type string

Description: Seller tax representative tax identifier type

Example: "FI:VAT"

value Required

   
Type string

Description: Seller tax representative tax identifier

Example: "FI00800008"

buyer Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer

Description: Buyer details

partyIdentifiers 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_partyIdentifiers

type Optional

   
Type string

Description: Buyer party identifier type

Example: "NO:ORGNR"

value Required

   
Type string

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

Example: "111111111"

name 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 Optional

   
Type string

address Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_address

Description: Buyer postal address details

street1 Optional

   
Type string

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

Example: "Karenslyst allé 56"

street2 Optional

   
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 Optional

   
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 Optional

   
Type string

Description: Buyer city, town, village or post office

Example: "Oslo"

postCode Optional

   
Type string

Description: Buyer post code

Example: "0277"

country Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_address_country

Description: Buyer country details

subDivision Optional

   
Type string

Description: Buyer country subdivision

Example: "Oslo"

code Optional

   
Type string

Description: Buyer country code

Example: "NO"

legalEntity Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_legalEntity

Description: Party legal entity details

name Required

   
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 Optional

   
Type string

id Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_legalEntity_id

Description: Buyer legal registration identifier

Example: "111111111"

type Optional

   
Type string

Description: Buyer legal entity identifier type

Example: "NO:ORGNR"

value Required

   
Type string

Description: Buyer legal entity identifier value

Example: "111111111"

tax Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_tax

Description: Buyer tax identifier

scheme Required

   
Type string
Default "VAT"

Description: Buyer tax identifier scheme

Example: "VAT"

id Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_tax_id

Description: Buyer tax identifier

Example: "NO111111111"

type Optional

   
Type string

Description: Buyer tax identifier type

Example: "NO:VAT"

value Required

   
Type string

Description: Buyer tax identifier value

Example: "NO111111111"

contact Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_buyer_contact

Description: Buyer contact details

name Optional

   
Type string

Description: Buyer contact point for a legal entity or person

Example: "Jens Jensen"

telephone Optional

   
Type string

Description: Buyer phone number for the contact point

Example: "876 654 321"

email Optional

   
Type string
Format email

Description: Buyer email address for the contact point

Example: "contact@buyer.com"

delivery Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_delivery

Description: Delivery information

date Optional

   
Type string
Format date

Description: Actual delivery date

Example: "2025-02-01"

locationID Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_delivery_locationID

Description: Delivery location identifier

Example: "1111111111116"

type Optional

   
Type string

Description: Delivery location identifier type

Example: "GLN"

value Required

   
Type string

Description: Delivery location identifier value

Example: "1111111111116"

name 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 Optional

   
Type string

address Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_delivery_address

Description: Delivery postal address details

street1 Optional

   
Type string

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

Example: "Delivery Street 1"

street2 Optional

   
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 Optional

   
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 Optional

   
Type string

Description: City, town, village or post office

Example: "Oslo"

postCode Optional

   
Type string

Description: Post code

Example: "0277"

country Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_delivery_address_country

Description: Delivery country details

subDivision Optional

   
Type string

Description: Delivery country subdivision

Example: "South Region"

code Optional

   
Type string

Description: Delivery country code

Example: "NO"

payee Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payee

Description: Payee details

partyIdentifiers 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payee_partyIdentifiers

type Optional

   
Type string

Description: Payee party identifier type

Example: "FI:ORGNR"

value Required

   
Type string

Description: Payee party identifier value

Example: "2129112-6"

name 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 Optional

   
Type string

legalEntity Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payee_legalEntity

Description: Payee legal entity details

name Optional

   
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 Optional

   
Type string

id Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payee_legalEntity_id

Description: Payee legal entity identifier

Example: "2129112-6"

type Optional

   
Type string

Description: Payee legal entity identifier type

Example: "FI:ORGNR"

value Required

   
Type string

Description: Payee legal entity identifier value

Example: "2129112-6"

payment Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment

Description: Payment terms and instructions

terms 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_terms

id Optional

   
Type string

Description: Payment terms identifier

paymentMeansID Optional

   
Type string

Description: Payment instruction identifier related to given payment terms

note Required

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_terms_note

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: A textual description of the payment terms

amount Optional

   
Type number

Description: The payment amount that these terms apply to

installment Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_terms_installment

Description: Payment terms installment

dueDate Required

   
Type string
Format date

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

instructions 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_instructions

type Required

   
Type string

Description: Payment means type

typeName Optional

   
Type string

Description: Payment means expressed as text

paymentID Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_instructions_paymentID

Description: Remittance information

type Optional

   
Type string

Description: Payment instruction identifier type

value Required

   
Type string

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

Example: "432948234234234"

mandateID Optional

   
Type string

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

creditorID Optional

   
Type string

Description: Bank assigned creditor identifier used for direct debiting

cardAccount Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_instructions_cardAccount

Description: Payment card information

primaryAccountNumber Required

   
Type string

Description: Payment card primary account number (PAN)

networkID Optional

   
Type string

Description: Payment card network identifier

holderName Required

   
Type string

Description: Payment card holder name

account Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_instructions_account

Description: Account details

name Optional

   
Type string

Description: Account name

Example: "Payment Account"

type Required

   
Type string

Description: Account type

Example: "IBAN"

id Required

   
Type string

Description: Account identifier

Example: "FI5810203000100011"

institution Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_payment_instructions_account_institution

Description: Account financial institution

id Required

   
Type string

Description: Payment service provider identifier, BIC/SWIFT etc

Example: "BICXFIHH"

allowanceCharge 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 -

root_document_allowanceCharge Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_allowanceCharge

type Required

   
Type string

Description: Type of ‘charge’ or ‘allowance’

Example: "charge"

reasonCode Optional

   
Type string

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

Example: "FC"

reason Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_allowanceCharge_reason

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

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

Example: "Freight"

percentage Optional

   
Type number

Description: Percentage used to calculate the amount

Example: 5.0

baseAmount Optional

   
Type number

Description: Base amount for calculating the charge or allowance

Example: 200.0

amount Required

   
Type number

Description: Amount of the charge or allowance

Example: 10.0

tax Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_allowanceCharge_tax

Description: Tax information related to charge or allowance

scheme Required

   
Type string
Default "VAT"

Description: Tax scheme

Example: "VAT"

category Required

   
Type string

Description: Document level allowance or charge tax category code

Example: "standard_rate"

percentage Required

   
Type number

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

Example: 25.5

tax Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax

Description: Tax details

amount Required

   
Type number

Description: Total tax amount

Example: 51.0

taxCurrency Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax_taxCurrency

Description: Tax details for tax accounting currency

taxableAmount Optional

   
Type number

Description: Taxable base amount in tax accounting currency

amount Required

   
Type number

Description: Tax amount in tax accounting currency

subTotals 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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax_subTotals

taxableAmount Required

   
Type number

Description: Taxable base amount

Example: 200.0

amount Required

   
Type number

Description: Tax amount

Example: 51.0

tax Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax_subTotals_tax

Description: Tax details

scheme Required

   
Type string
Default "VAT"

Description: Tax scheme

Example: "VAT"

category Required

   
Type string

Description: Tax category code

Example: "standard_rate"

percentage Required

   
Type number

Description: Tax percentage rate

Example: 25.5

exemption Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax_subTotals_tax_exemption

Description: Tax exemption details

reasonCode Optional

   
Type string

Description: Tax exemption reason code

reason Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_tax_subTotals_tax_exemption_reason

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Tax exemption reason text

Example: "Exempt"

monetaryTotal Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_monetaryTotal

Description: Monetary totals related to the document

linesTotalAmount Required

   
Type number

Description: Sum of document line net amount

Example: 100.0

taxExclusiveAmount Required

   
Type number

Description: Document total amount excluding tax

Example: 100.0

taxInclusiveAmount Required

   
Type number

Description: Document total amount including tax

Example: 125.5

allowanceTotalAmount Optional

   
Type number

Description: Sum of allowances on document level

Example: 0.0

chargeTotalAmount Optional

   
Type number

Description: Sum of charges on document level

Example: 0.0

prepaidAmount Optional

   
Type number

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

Example: 0.0

roundingAmount Optional

   
Type number

Description: Rounding amount

Example: 0.0

payableAmount Required

   
Type number

Description: Amount due for payment

Example: 125.5

lines 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 -

root_document_lines Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines

id Required

   
Type string

Description: Invoice line identifier

Example: "1"

name Required

   
Type string

Description: Item name

Example: "Item name"

note Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_note

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Invoice line note

Example: "New article number 12345"

description Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_description

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Item description

Example: "Long description of the item on the invoice line"

invoicedObject Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_invoicedObject

schemeID Optional

   
Type string

Description: Invoice line object identifier scheme identifier

Example: "ABZ"

value Required

   
Type string

Description: Invoice line object identifier

Example: "AB12345"

buyerAccountingReference Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_buyerAccountingReference

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

Description: Invoice line buyer accounting reference

Example: "1287:65464"

purchaseOrderReference Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_purchaseOrderReference

lineID Required

   
Type string

Description: Purchase order line reference

Example: "3"

sellersIdentifier Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_sellersIdentifier

Description: Item sellers identifier

value Required

   
Type string

Description: Item sellers identifier

Example: "9873242"

buyersIdentifier Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_buyersIdentifier

Description: Item buyers identifier

value Required

   
Type string

Description: Item buyers identifier

Example: "123455"

standardIdentifier Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_standardIdentifier

Description: Item standard identifier

type Required

   
Type string

Description: Item standard identifier type

Example: "GTIN"

value Required

   
Type string

Description: Item standard identifier

Example: "10986700"

additionalProperties Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_additionalProperties

name Required

   
Type string

Description: Line item attribute name

Example: "Color"

value Required

   
Type string

Description: Line item attribute value

Example: "Black"

invoicePeriod Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_invoicePeriod

Description: Invoice line invoice period

startDate Required

   
Type string
Format date

Description: Invoice line period start date

Example: "2025-01-01"

endDate Required

   
Type string
Format date

Description: Invoice line period end date

Example: "2025-01-20"

originCountry Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_originCountry

Description: Item country of origin

code Optional

   
Type string

Description: Country code

Example: "DE"

classificationIdentifier Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_classificationIdentifier

schemeVersionID Optional

   
Type string

Description: Item classification identifier identification scheme version identifier

Example: "19.05.01"

schemeID Required

   
Type string

Description: Item classification identifier identification scheme identifier

Example: "STI"

value Required

   
Type string

Description: Item classification identifier

Example: "9873242"

quantity Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_quantity

Description: Quantity

charged Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_quantity_charged

Description: Charged quantity

unitCode Required

   
Type string

Description: Charged quantity unit of measure code

Example: "C62"

value Required

   
Type number

Description: Charged quantity

Example: 5.0

unitPrice Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_unitPrice

Description: Item net price

baseQuantity Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_unitPrice_baseQuantity

Description: Item price base quantity

unitCode Optional

   
Type string

Description: Item price base quantity unit of measure code

Example: "C62"

value Required

   
Type number

Description: Item price base quantity

Example: 1.0

grossAmount Required

   
Type number

Description: Item gross price

Example: 15.0

discountAmount Optional

   
Type number

Description: Item price discount amount

Example: 5.0

netAmount Required

   
Type number

Description: Item net price

Example: 10.0

allowanceCharge Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_allowanceCharge

type Required

   
Type string

Description: Type of ‘charge’ or ‘allowance’

Example: "charge"

reasonCode Optional

   
Type string

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

Example: "FC"

reason Optional

   
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 Optional

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_allowanceCharge_reason

language Optional

   
Type string

Description: Text language code

Example: "en"

text Required

   
Type string

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

Example: "Freight"

percentage Optional

   
Type number

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

Example: 200.0

baseAmount Optional

   
Type number

Description: Base amount for calculating the charge or allowance

Example: 50.0

amount Required

   
Type number

Description: Amount of the charge or allowance

Example: 100.0

lineTotalNetAmount Required

   
Type number

Description: Invoice line net amount

Example: 150.0

tax Required

   
Type object
Additional properties Not allowed
Defined in #/$defs/root_document_lines_tax

scheme Required

   
Type string
Default "VAT"

Description: Tax scheme

Example: "VAT"

category Required

   
Type string

Description: Invoiced item tax category code

Example: "standard_rate"

percentage Required

   
Type number

Description: Invoiced item tax category rate

Example: 25.5
Back to top
Give feedback Contact sales Chat with support

AI Chat Support 24/7

  • • Get help via AI chat available 24/7 whenever it suits you
  • • Chat extensively uses Maventa support pages, websites, and blogs in its answers
  • • If you need assistance that the AI cannot provide, you can also ask a customer service agent to join the conversation
  • • Support requests processed Monday to Friday
Cancel Open chat

Got feedback?

Did you not find what you were looking for? Or was something explained unclearly? Or just want to share your thoughts? We are happy to hear your feedback!

Note: This form is not a way to get support, this is only for feedback for the documentation website. If you need support, please contact Maventa support.

Integration Guide Services & Reach API Specification Changelogs Integration guide Getting Started Invoice sending Consumer Invoicing Printing Email Invoicing Invoice Receiving Scanning Detect Fraud reporting Webhooks Reference implementations Maventa Connector Embeddable User Interface Peppol Network Document Exchange Invoice Response Self-billing support Invoicing formats Validation Peppol BIS 3.0 Maventa JSON (table) Maventa JSON (json schema) Companies and Settings Users Billing Services and reach Maventa services and reach e-invoicing in Belgium e-invoicing in Denmark e-invoicing in Estonia e-invoicing in Finland Mass Printing Service Amili Kassavirta Amili Perintä Ropo Perintä e-invoicing in Germany e-invoicing in Italy e-invoicing in the Netherlands e-invoicing in Norway e-invoicing in Poland e-invoicing in Sweden Api specification API overview Getting Started Common & authentication API Invoices API Documents API Companies & settings API Lookups API Detect API Validator API Receivables API Billing API Scanning API B2CFI API B2CNO API B2CSE API Partner API Getting Started API Methods Overview Account Configuration API Methods Invoice Sending API Methods Invoice Receiving API Methods B2C Norway API Methods B2C Finland API Methods Other API Methods Changelogs Product changelog Developer Changelog
Clear Send

Enter your credentials to Maventa testing environment, to authenticate and try things out with the Swagger UI. This will fetch a Bearer token using OAuth2 with the endpoint POST https://ax-stage.maventa.com/oauth2/token. The token is stored in your browser's session storage (cleared when you close the tab) and used in Swagger calls done from this documentation website. The token is valid for 1 hour.

Never use your production credentials here. This is only for testing the Maventa test environment in the Swagger UI.
All None
eui global company lookup document:receive document:send invoice:receive invoice:send company:read company:write validate receivables:assignments analysis billing:reports partner:invoice_delivery_actions partner:lookups partner:takeovers partner:lyanthe_scan_service fi_bank_message:send fi_bank_message:receive
Cancel Sign In