Invoice Model

The Invoice model represents the structure of an electronic invoice compliant with the Peppol BIS Billing 3.0 standard.

Invoice Properties

A list of business terms representing the main properties of an invoice in the Oxygen Peppol API.

Name
invoice_number
Term
BT-1
Type
string
Description
Unique identifier for the invoice.
Name
issue_date
Term
BT-2
Type
string
Description
The date when the invoice was issued (YYYY-MM-DD).
Name
invoice_type_code
Term
BT-3
Type
integer
Description
A code that identifies the type of invoice (`380` for standard Invoice, `381` for Credit Invoice). Invoice Type Codes (UNCL1001) Credit Note Type Codes (UNCL1001)
Name
currency_code
Term
BT-5
Type
string
Description
Currency code (3 characters, e.g., `EUR`, `USD`). ISO 4217 Currency codes
Name
tax_currency_code
Term
BT-6
Type
string
Description
Tax currency code (3 characters).PeppolLink ISO 4217 Currency codes
Name
tax_point_date
Term
BT-7
Type
string
Description
Tax point date (YYYY-MM-DD).PeppolLink
Name
due_date
Term
BT-9
Type
string
Description
Payment due date (YYYY-MM-DD).PeppolLink
Name
buyer_reference
Term
BT-10
Type
string
Description
Buyer reference. Required if `order_reference.id` is not provided.
Name
project_reference
Term
BT-11
Type
string
Description
Project reference (Κωδικός ΑΔΑ / ΠΔΕ). Required for invoice type 380, prohibited otherwise.
Name
contract_document_reference
Term
BT-12
Type
string
Description
Contract document reference (Κωδικός ΑΔΑΜ).
Name
receipt_document_reference
Term
BT-15
Type
string
Description
Receipt document reference.PeppolLink
Name
despatch_document_reference
Term
BT-16
Type
string
Description
Despatch document reference.PeppolLink
Name
originator_document_reference
Term
BT-17
Type
string
Description
Originator document reference.PeppolLink
Name
accounting_cost
Term
BT-19
Type
string
Description
Accounting cost.PeppolLink
Name
payment_terms
Term
BT-20
Type
string
Description
Payment terms description.PeppolLink
Name
note
Term
BT-22
Type
string
Description
Invoice note (max 65,535 characters).PeppolLink
Name
order_reference
Term
BG-3
Type
object
Description
Order reference object.PeppolLink
Name
order_reference.id
Term
BT-13
Type
string
Description
Order reference ID. Required if `buyer_reference` is not provided.
Name
order_reference.sales_order_id
Term
BT-14
Type
string
Description
Sales order ID.PeppolLink
Name
billing_reference
Term
BG-3
Type
array
Description
Array of billing references. Required for invoice type 5.1.
Name
billing_reference.*.id
Term
BT-25
Type
string
Description
Billing reference ID.
Name
billing_reference.*.issue_date
Term
BT-26
Type
string
Description
Billing reference issue date (YYYY-MM-DD).PeppolLink

Example

json

{
  "id": "888888888|14/01/2026|0|1.1|ΤΔΑ|14",
  "issue_date": "2026-01-14",
  "invoice_type_code": 380,
  "currency_code": "EUR",
  "due_date": "2026-02-14",
  "buyer_reference": "REF-2026-001",
  "project_reference": "ADA-123456",
  "contract_document_reference": "ADAM-654321",
  "order_reference": {
    "id": "PO-2026-001",
    "sales_order_id": "SO-2026-001"
  },
  "payment_terms": "Payment within 30 days",
  "note": "Thank you for your business."
}

Seller Details

A group of business terms providing information about the Seller.

Name
seller
Term
BG-4
Type
object
Description
Seller information object.
Name
seller.name
Term
BT-28
Type
string
Description
Seller trading name.PeppolLink
Name
seller.identification.*.id
Term
BT-29
Type
string
Description
Seller identification ID.PeppolLink
Name
seller.identification.*.scheme_id
Type
string
Description
Seller identification (BT-29) scheme ID.PeppolLink ISO 6523 ICD list
Name
seller.legal_entity.registration_name
Term
BT-27
Type
string
Description
Seller legal registration name.
Name
seller.legal_entity.company_id
Term
BT-30
Type
string
Description
Seller company ID.PeppolLink
Name
seller.legal_entity.scheme_id
Type
string
Description
Seller legal entity (BT-30) scheme ID.PeppolLink ISO 6523 ICD list
Name
seller.legal_entity.company_legal_form
Term
BT-33
Type
string
Description
Seller legal form.PeppolLink
Name
seller.address.street_name
Term
BT-35
Type
string
Description
Seller street name.PeppolLink
Name
seller.address.additional_street_name
Term
BT-36
Type
string
Description
Seller additional street name.PeppolLink
Name
seller.address.city_name
Term
BT-37
Type
string
Description
Seller city.PeppolLink
Name
seller.address.postal_zone
Term
BT-38
Type
string
Description
Seller postal code.PeppolLink
Name
seller.address.country_subentity
Term
BT-39
Type
string
Description
Seller country subdivision (Περιφέρεια).PeppolLink
Name
seller.address.address_line
Term
BT-162
Type
string
Description
Seller address line.PeppolLink
Name
seller.address.country
Term
BT-40
Type
string
Description
Seller country code (2 characters, e.g., `GR`). ISO 3166 Country codes
Name
seller.tax_scheme.*.company_id
Term
BT-31
Type
string
Description
Seller tax registration number (VAT).
Name
seller.tax_scheme.*.scheme_id
Type
string
Description
Mandatory element. For Seller VAT identifier (BT-31), use value "VAT".
Name
seller.contact.name
Term
BT-41
Type
string
Description
Seller contact name.PeppolLink
Name
seller.contact.telephone
Term
BT-42
Type
string
Description
Seller contact telephone.PeppolLink
Name
seller.contact.email
Term
BT-43
Type
string
Description
Seller contact email.PeppolLink

Example

json

{
  "seller": {
    "name": "ΑΒΓΔ ΑΕ",
    "identification": [
      { "id": "979708945" }
    ],
    "address": {
      "street_name": "Χίου 50",
      "city_name": "Αθήνα",
      "postal_zone": "17674",
      "country": "GR"
    },
    "tax_scheme": [
      {
        "company_id": "EL979708945",
        "scheme_id": "VAT"
      }
    ],
    "legal_entity": {
      "registration_name": "ΑΒΓΔ ΑΕ",
      "company_id": "77109427000"
    },
    "contact": {
      "name": "ΑΒΓΔ ΑΕ",
      "telephone": "+30 2166 808800",
      "email": "papadopoulos@test.com"
    }
  }
}

Buyer details

A group of business terms providing information about the Buyer.

Name
buyer
Term
BG-7
Type
object
Description
Buyer information object.
Name
buyer.endpoint_id
Term
BT-49
Type
string
Description
Buyer electronic address.
Name
buyer.endpoint_scheme_id
Type
string
Description
Buyer electronic address (BT-49) scheme identifier. Electronic Address Scheme list (EAS)
Name
buyer.name
Term
BT-45
Type
string
Description
Buyer trading name.PeppolLink
Name
buyer.identification.*.id
Term
BT-46
Type
string
Description
Buyer identification.
Name
buyer.identification.*.scheme_id
Type
string
Description
Buyer identification (BT-46) scheme ID.PeppolLink ISO 6523 ICD list
Name
buyer.legal_entity.registration_name
Term
BT-44
Type
string
Description
Buyer legal registration name.
Name
buyer.legal_entity.company_id
Term
BT-47
Type
string
Description
Buyer legal registration identifier.PeppolLink
Name
buyer.legal_entity.scheme_id
Type
string
Description
Buyer legal registration identifier (BT-47) scheme ID.PeppolLink ISO 6523 ICD list
Name
buyer.address.street_name
Term
BT-50
Type
string
Description
Buyer street name.PeppolLink
Name
buyer.address.additional_street_name
Term
BT-51
Type
string
Description
Buyer additional street name.PeppolLink
Name
buyer.address.city_name
Term
BT-52
Type
string
Description
Buyer city.PeppolLink
Name
buyer.address.postal_zone
Term
BT-53
Type
string
Description
Buyer postal code.PeppolLink
Name
buyer.address.country_subentity
Term
BT-54
Type
string
Description
Buyer country subdivision (Περιφέρεια).PeppolLink
Name
buyer.address.address_line
Term
BT-163
Type
string
Description
Buyer address line.PeppolLink
Name
buyer.address.country
Term
BT-55
Type
string
Description
Buyer country code (2 characters). Country codes
Name
buyer.tax_scheme.*.company_id
Term
BT-48
Type
string
Description
Buyer tax identifier.
Name
buyer.tax_scheme.*.scheme_id
Type
string
Description
Mandatory element. For Buyer VAT identifier (BT-48), use value "VAT".
Name
buyer.contact.name
Term
BT-56
Type
string
Description
Buyer contact name.PeppolLink
Name
buyer.contact.telephone
Term
BT-57
Type
string
Description
Buyer contact telephone.PeppolLink
Name
buyer.contact.email
Term
BT-58
Type
string
Description
Buyer contact email.PeppolLink

Example

json

{
  "buyer": {
    "name": "ΣΥΝΗΓΟΡΟΣ ΤΟΥ ΠΟΛΙΤΗ",
    "identification": [
      { "id": "1007.8020000000.0001" }
    ],
    "address": {
      "street_name": "Λεωφ. Βασιλέως Κωνσταντίνου 3",
      "city_name": "Κρωπία",
      "postal_zone": "19400",
      "country": "GR"
    },
    "tax_scheme": [
      {
        "company_id": "EL099912223",
        "scheme_id": "VAT"
      }
    ],
    "legal_entity": {
      "registration_name": "ΣΥΝΗΓΟΡΟΣ ΤΟΥ ΠΟΛΙΤΗ"
    }
  }
}

Payee details

A group of business terms providing information about the Payee, i.e., the role that receives the payment. Shall be used when the Payee is different from the Seller.

Name
payee
Term
BG-10
Type
object
Description
Payee information.PeppolLink
Name
payee.name
Term
BT-59
Type
string
Description
Payee name.
Name
payee.identification.*.id
Term
BT-60
Type
string
Description
Payee identification.PeppolLink
Name
payee.identification.*.scheme_id
Type
string
Description
Payee identification (BT-60) scheme ID.PeppolLink ISO 6523 ICD list
Name
payee.legal_entity.company_id
Term
BT-61
Type
string
Description
Payee legal entity identifier.PeppolLink
Name
payee.legal_entity.scheme_id
Type
string
Description
Payee legal entity identifier (BT-61) scheme ID.PeppolLink ISO 6523 ICD list

Example

json

{
  "payee": {
    "name": "ΠΑΠΑΔΟΠΟΥΛΟΣ ΑΕ",
      "identification": [
        { "id": "123456789" }
      ],
    "legal_entity": {
      "company_id": "77109427000"
    }
  }
}

Tax Representative details

A group of business terms providing information about the Seller's tax representative.

Name
tax_representative
Term
BG-11
Type
object
Description
Tax representative party.PeppolLink
Name
tax_representative.name
Term
BT-62
Type
string
Description
Tax representative name.

Name
tax_representative.tax_scheme
Type
array
Description
Tax representative VAT identifier. Required if a tax representative is specified. Max 1 entry.
Name
tax_representative.tax_scheme.*.company_id
Term
BT-63
Type
string
Description
Tax representative VAT identifier.
Name
tax_representative.tax_scheme.*.scheme_id
Type
string
Description
Mandatory element. For Tax Representative VAT identifier (BT-63), use value "VAT".

Name
tax_representative.address
Term
BG-12
Type
object
Description
Tax representative address.
Name
tax_representative.address.street_name
Term
BT-64
Type
string
Description
Tax representative street name.PeppolLink
Name
tax_representative.address.additional_street_name
Term
BT-65
Type
string
Description
Tax representative additional street name.PeppolLink
Name
tax_representative.address.city_name
Term
BT-66
Type
string
Description
Tax representative city.PeppolLink
Name
tax_representative.address.postal_zone
Term
BT-67
Type
string
Description
Tax representative postal code.PeppolLink
Name
tax_representative.address.country_subentity
Term
BT-68
Type
string
Description
Tax representative country subdivision (District - Region).PeppolLink
Name
tax_representative.address.address_line
Term
BT-164
Type
string
Description
Tax representative address line.PeppolLink
Name
tax_representative.address.country
Term
BT-69
Type
string
Description
Tax representative country code (2 characters). ISO 3166-1:Alpha2 Country codes

Example

json

{
  "tax_representative": {
    "name": "TAX REP ΑΕ",
    "tax_scheme": [
      {
        "company_id": "EL123456789",
        "scheme_id": "VAT"
      }
    ],
    "address": {
      "street_name": "Οδός Παραδείγματος 1",
      "city_name": "Θεσσαλονίκη",
      "postal_zone": "54623",
      "country": "GR"
    }
  }
}

Delivery details

A group of business terms providing information about where and when the goods and services invoiced are delivered.

Name
delivery
Term
BG-13
Type
object
Description
Delivery information. Required for Greek sellers.
Name
delivery.party_name
Term
BT-70
Type
string
Description
Delivery party name.
Name
delivery.location.id
Term
BT-71
Type
string
Description
Delivery location identifier.PeppolLink
Name
delivery.location.scheme_id
Type
string
Description
Delivery location identifier (BT-71) scheme ID.PeppolLink ISO 6523 ICD list
Name
delivery.date
Term
BT-72
Type
string
Description
Actual delivery date (YYYY-MM-DD).PeppolLink
Name
delivery.location.address.street_name
Term
BT-75
Type
string
Description
Delivery address street name.
Name
delivery.location.address.additional_street_name
Term
BT-76
Type
string
Description
Delivery address additional street name.PeppolLink
Name
delivery.location.address.city_name
Term
BT-77
Type
string
Description
Delivery address city.
Name
delivery.location.address.postal_zone
Term
BT-78
Type
string
Description
Delivery address postal code.
Name
delivery.location.address.country_subentity
Term
BT-79
Type
string
Description
Delivery address country subdivision.PeppolLink
Name
delivery.location.address.address_line
Term
BT-165
Type
string
Description
Delivery address line.PeppolLink
Name
delivery.location.address.country
Term
BT-80
Type
string
Description
Delivery address country code (2 characters). ISO 3166-1:Alpha2 Country codes

Example

json

{
  "delivery": {
    "party_name": "ΠΑΠΑΔΟΠΟΥΛΟΣ ΑΕ",
    "location": {
      "address": {
        "street_name": "Χίου 50",
        "city_name": "Αθήνα",
        "postal_zone": "17674",
        "country": "GR"
      }
    },
    "date": "2026-01-15"
  }
}

Invoicing Period

A group of business terms providing information on the invoice period. Also called delivery period. If the group is used, the invoicing period start date and/or end date must be used.

Name
invoice_period
Term
BG-14
Type
object
Description
Invoice period.PeppolLink
Name
invoice_period.start_date
Term
BT-73
Type
string
Description
Invoice period start date (YYYY-MM-DD).PeppolLink
Name
invoice_period.end_date
Term
BT-74
Type
string
Description
Invoice period end date (YYYY-MM-DD).PeppolLink
Name
invoice_period.description_code
Term
BT-8
Type
string
Description
Value added tax point date code.PeppolLink VAT date code (UNCL2005 subset)

Example

json

{
  "invoice_period": {
    "start_date": "2026-01-01",
    "end_date": "2026-01-31"
  }
}

Payment Means

A group of business terms providing information about the payment.

Name
payment_means
Term
BG-16
Type
array
Description
Payment means array.PeppolLink
Name
payment_means.*.payment_code
Term
BT-81
Type
string
Description
Payment means type code. Payment Means Codes (UNCL4461)
Name
payment_means.*.payment_description
Term
BT-82
Type
string
Description
Payment means description.PeppolLink
Name
payment_means.*.payment_id
Term
BT-83
Type
string
Description
Remittance information.PeppolLink
Name
payment_means.*.credit_transfer.account_id
Term
BT-84
Type
string
Description
Payment account identifier (IBAN).
Name
payment_means.*.credit_transfer.account_name
Term
BT-85
Type
string
Description
Payment account name.PeppolLink
Name
payment_means.*.credit_transfer.institution_id
Term
BT-86
Type
string
Description
Payment service provider identifier (BIC).PeppolLink
Name
payment_means.*.card_account.pan
Term
BT-87
Type
string
Description
Payment card primary account number.PeppolLink
Name
payment_means.*.card_account.network_id
Type
string
Description
Payment card network identifier.PeppolLink
Name
payment_means.*.card_account.holder_name
Term
BT-88
Type
string
Description
Payment card holder name.PeppolLink
Name
payment_means.*.direct_debit.id
Term
BT-89
Type
string
Description
Direct debit mandate reference identifier.PeppolLink
Name
payment_means.*.direct_debit.payer_account_id
Term
BT-91
Type
string
Description
Debited account identifier.PeppolLink

Example

json

{
  "payment_means": [
    {
      "payment_code": "31",
      "payment_description": "Bank Transfer",
      "credit_transfer": {
        "account_id": "GR1601101250000000012300695",
        "account_name": "ΠΑΠΑΔΟΠΟΥΛΟΣ ΑΕ",
        "institution_id": "ETHNGRAA"
      }
    },
    {
      "payment_code": "54",
      "payment_description": "Credit Card",
      "card_account": {
        "pan": "4111111111111111",
        "holder_name": "JOHN DOE"
      }
    }
  ]
}

Invoice level Allowances

A group of business terms providing information about allowances applicable to the Invoice as a whole. (e.g., discounts)

Name
allowances
Term
BG-20
Type
array
Description
Document level allowances.PeppolLink
Name
allowances.*.amount
Term
BT-92
Type
decimal
Description
Allowance amount.
Name
allowances.*.base_amount
Term
BT-93
Type
decimal
Description
Allowance base amount.PeppolLink
Name
allowances.*.percent
Term
BT-94
Type
decimal
Description
Allowance percentage.PeppolLink
Name
allowances.*.tax_category.id
Term
BT-95
Type
string
Description
Allowance tax category code.
Name
allowances.*.tax_category.percent
Term
BT-96
Type
decimal
Description
Allowance tax rate.
Name
allowances.*.reason
Term
BT-97
Type
string
Description
Allowance reason. Required if reason_code not provided.
Name
allowances.*.reason_code
Term
BT-98
Type
string
Description
Allowance reason code.PeppolLink Allowance reason codes (UNCL5189)

Example

json

{
  "allowances": [
    {
      "amount": 10.00,
      "base_amount": 100.00,
      "percent": 10.0,
      "tax_category": {
        "id": "S",
        "percent": 24.0
      },
      "reason": "Promotional discount",
      "reason_code": "95"
    },
    {
      "amount": 5.00,
      "tax_category": {
        "id": "S",
        "percent": 24.0
      },
      "reason": "Loyalty discount",
      "reason_code": "95"
    }
  ]
}

Invoice level Charges

A group of business terms providing information about charges and taxes other than VAT, applicable to the Invoice as a whole. (e.g., shipping fees)

Name
charges
Term
BG-21
Type
array
Description
Document level charges.PeppolLink
Name
charges.*.amount
Term
BT-99
Type
decimal
Description
Charge amount.
Name
charges.*.base_amount
Term
BT-100
Type
decimal
Description
Charge base amount.PeppolLink
Name
charges.*.percent
Term
BT-101
Type
decimal
Description
Charge percentage.PeppolLink
Name
charges.*.tax_category.id
Term
BT-102
Type
string
Description
Charge tax category code.
Name
charges.*.tax_category.percent
Term
BT-103
Type
decimal
Description
Charge tax rate.
Name
charges.*.reason
Term
BT-104
Type
string
Description
Charge reason.
Name
charges.*.reason_code
Term
BT-105
Type
string
Description
Charge reason code.PeppolLink Charge reason codes (UNCL7161)

Example

json

{
  "charges": [
    {
      "amount": 15.00,
      "base_amount": 100.00,
      "percent": 15.0,
      "tax_category": {
        "id": "S",
        "percent": 24.0
      },
      "reason": "Shipping fee",
      "reason_code": "SAA"
    },
    {
      "amount": 7.50,
      "tax_category": {
        "id": "S",
        "percent": 24.0
      },
      "reason": "Set-up fee",
      "reason_code": "SU"
    }
  ]
}

Additional Documents

A group of business terms providing information about additional supporting documents substantiating the claims made in the Invoice. The additional supporting documents can be used for both referencing a document number which is expected to be known by the receiver, an external document (referenced by a URL) or as an embedded document, Base64 encoded (such as a time report).

Name
additional_documents
Term
BG-24
Type
array
Description
Additional supporting documents.PeppolLink
Name
additional_documents.*.id
Term
BT-122
Type
string
Description
Supporting document reference.
Name
additional_documents.*.scheme_id
Type
string
Description
Supporting document reference (BT-122) scheme identifier.PeppolLink Invoiced object identifier scheme (UNCL 1153)
Name
additional_documents.*.document_type_code
Term
BT-18
Type
string
Description
Supporting document type code, code "130" MUST be used to indicate an invoice object reference. Not used for other additional documents.PeppolLink
Name
additional_documents.*.document_description
Term
BT-123
Type
string
Description
Supporting document description.PeppolLink
Name
additional_documents.*.attachment.uri
Term
BT-124
Type
string
Description
External document location.PeppolLink
Name
additional_documents.*.attachment.embed
Term
BT-125
Type
string
Description
Attached document (base64).PeppolLink Mime code (subset of IANA code list)
Name
additional_documents.*.attachment.embed_mime_code
Type
string
Description
Attached document MIME code. Required with embed.
Name
additional_documents.*.attachment.embed_filename
Type
string
Description
Attached document filename. Required with embed.

Example

json

{
  "additional_documents": [
    {
      "id": "PO-12345",
      "scheme_id": "AFH",
      "document_type_code": "130",
      "document_description": "Purchase Order",
      "attachment": {
        "uri": "https://buyer.example.com/orders/PO-12345.pdf"
      }
    },
    {
      "id": "TimeReport-67890",
      "scheme_id": "AUU",
      "document_type_code": "130",
      "document_description": "Time Report",
      "attachment": {
        "embed": "JVBERi0xLjQKJcfs...",
        "embed_mime_code": "application/pdf",
        "embed_filename": "TimeReport-67890.pdf"
      }
    },
    {
      "id": "VRN-54321",
      "scheme_id": "ZZZ",
      "document_description": "Vehicle Registration Number"
    }
  ]
}

Invoice Lines

A group of business terms providing information on individual Invoice lines.

Name
lines
Term
BG-25
Type
array
Description
Invoice lines.
Name
lines.*.id
Term
BT-126
Type
string
Description
Invoice line identifier (must be unique).
Name
lines.*.note
Term
BT-127
Type
string
Description
Invoice line note (max 65,535 characters).PeppolLink
Name
lines.*.document_reference.id
Term
BT-128
Type
string
Description
Invoice line object identifier.PeppolLink Invoiced object identifier scheme (UNCL 1153)
Name
lines.*.document_reference.scheme_id
Type
string
Description
Invoice line object scheme identifier.PeppolLink
Name
lines.*.document_reference.document_type_code
Type
string
Description
Invoice line object document type code.PeppolLink
Name
lines.*.quantity
Term
BT-129
Type
decimal
Description
Invoiced quantity.
Name
lines.*.unit_code
Term
BT-130
Type
string
Description
Invoiced quantity unit of measure code. Unit Codes Reference
Name
lines.*.net_value
Term
BT-131
Type
decimal
Description
Invoice line net amount.
Name
lines.*.order_line_reference
Term
BT-132
Type
string
Description
Referenced purchase order line.PeppolLink
Name
lines.*.accounting_cost
Term
BT-133
Type
string
Description
Invoice line buyer accounting reference.PeppolLink
Name
lines.*.invoice_period
Term
BG-26
Type
object
Description
Invoice line period.PeppolLink
Name
lines.*.invoice_period.start_date
Term
BT-134
Type
string
Description
Invoice line period start date.PeppolLink
Name
lines.*.invoice_period.end_date
Term
BT-135
Type
string
Description
Invoice line period end date.PeppolLink

Invoice Line Allowances

Name
lines.*.allowances
Term
BG-27
Type
array
Description
Invoice line allowances.PeppolLink
Name
lines.*.allowances.*.amount
Term
BT-136
Type
decimal
Description
Invoice line allowance amount.
Name
lines.*.allowances.*.base_amount
Term
BT-137
Type
decimal
Description
Invoice line allowance base amount.PeppolLink
Name
lines.*.allowances.*.percent
Term
BT-138
Type
decimal
Description
Invoice line allowance percentage.PeppolLink
Name
lines.*.allowances.*.reason
Term
BT-139
Type
string
Description
Invoice line allowance reason.PeppolLink
Name
lines.*.allowances.*.reason_code
Term
BT-140
Type
string
Description
Invoice line allowance reason code.PeppolLink Allowance reason codes (UNCL5189)

Invoice Line Charges

Name
lines.*.charges
Term
BG-28
Type
array
Description
Invoice line charges.PeppolLink
Name
lines.*.charges.*.amount
Term
BT-141
Type
decimal
Description
Invoice line charge amount.
Name
lines.*.charges.*.base_amount
Term
BT-142
Type
decimal
Description
Invoice line charge base amount.PeppolLink
Name
lines.*.charges.*.percent
Term
BT-143
Type
decimal
Description
Invoice line charge percentage.PeppolLink
Name
lines.*.charges.*.reason
Term
BT-144
Type
string
Description
Invoice line charge reason.PeppolLink
Name
lines.*.charges.*.reason_code
Term
BT-145
Type
string
Description
Invoice line charge reason code.PeppolLink Allowance reason codes (UNCL5189)

Invoice Line Price Details

Name
lines.*.price_details
Term
BG-29
Type
object
Description
Price details.
Name
lines.*.price_details.price_amount
Term
BT-146
Type
decimal
Description
Item net price.
Name
lines.*.price_details.discount_amount
Term
BT-147
Type
decimal
Description
Item price discount.PeppolLink
Name
lines.*.price_details.base_amount
Term
BT-148
Type
decimal
Description
Item gross price.PeppolLink
Name
lines.*.price_details.base_quantity
Term
BT-149
Type
decimal
Description
Item price base quantity.PeppolLink
Name
lines.*.price_details.base_quantity_unit_code
Term
BT-150
Type
string
Description
Item price base quantity unit of measure.PeppolLink

Invoice Line Item Details

Name
lines.*.item
Term
BG-31
Type
object
Description
Item information.
Name
lines.*.item.name
Term
BT-153
Type
string
Description
Item name (max 1,000 characters).
Name
lines.*.item.description
Term
BT-154
Type
string
Description
Item description.PeppolLink
Name
lines.*.item.seller_assigned_id
Term
BT-155
Type
string
Description
Item seller's identifier.PeppolLink
Name
lines.*.item.buyer_assigned_id
Term
BT-156
Type
string
Description
Item buyer's identifier.PeppolLink
Name
lines.*.item.standard_id
Term
BT-157
Type
string
Description
Item standard identifier.PeppolLink
Name
lines.*.item.standard_scheme_id
Type
string
Description
Item standard identifier (BT-157) scheme id. Required with standard_id. ISO 6523 ICD list
Name
lines.*.item.classifications
Type
array
Description
Item classification identifiers.
Name
lines.*.item.classifications.*.code
Term
BT-158
Type
string
Description
Item classification identifier.
Name
lines.*.item.classifications.*.list_id
Type
string
Description
Item classification identifier (BT-158) list id. Item type identification code (UNCL7143)
Name
lines.*.item.classifications.*.version_id
Type
string
Description
Item classification list version.PeppolLink
Name
lines.*.item.origin_country
Term
BT-159
Type
string
Description
Item country of origin (2 characters).PeppolLink ISO 3166-1:Alpha2 Country codes

Invoice Line Tax Category

Name
lines.*.item.tax_category
Term
BG-30
Type
object
Description
Item tax category.
Name
lines.*.item.tax_category.id
Term
BT-151
Type
string
Description
Invoiced item VAT category code.
Name
lines.*.item.tax_category.percent
Term
BT-152
Type
decimal
Description
Invoiced item VAT rate.

Additional invoice line properties

Name
lines.*.properties
Term
BG-32
Type
array
Description
Item attributes.PeppolLink
Name
lines.*.properties.*.name
Term
BT-160
Type
string
Description
Item attribute name.
Name
lines.*.properties.*.value
Term
BT-161
Type
string
Description
Item attribute value.

Example

json

{
  "lines": [
    {
      "id": 1,
      "quantity": 100,
      "unit_code": "H87",
      "net_value": 9850,
      "item": {
        "name": "IT Services",
        "seller_assigned_id": "12345",
        "classifications": [
          {
            "code": "18000000-9",
            "list_id": "STI"
          }
        ],
        "tax_category": {
          "id": "S",
          "percent": 24
        }
      },
      "price_details": {
        "price_amount": 100
      },
      "allowances": [
        {
          "id": "ALLOWANCE-1",
          "amount": 200,
          "tax_category": {
            "id": "Z",
            "percent": 0
          },
          "reason": "Loyalty discount",
          "reason_code": 95
        }
      ],
      "charges": [
        {
          "id": "CHARGE-1",
          "amount": 50,
          "tax_category": {
            "id": "Z",
            "percent": 0
          },
          "reason": "Attesting",
          "reason_code": "AAI"
        }
      ]
    },
    {
      "id": 2,
      "quantity": 1,
      "unit_code": "H87",
      "net_value": 0,
      "item": {
        "name": "Promotional Item",
        "tax_category": {
          "id": "E",
          "percent": 0
        },
        "classifications": [
          {
            "code": "12",
            "list_id": "STI"
          }
        ],
        "seller_assigned_id": "44"
      },
      "price_details": {
        "price_amount": 0
      }
    }
  ]
}

Legal Monetary Totals

A group of business terms providing the monetary totals for the Invoice.

Name
totals
Term
BG-22
Type
object
Description
Document totals.
Name
totals.total_net_amount
Term
BT-106
Type
decimal
Description
Sum of invoice line net amounts.
Name
totals.total_allowance_amount
Term
BT-107
Type
decimal
Description
Sum of allowances on document level.PeppolLink
Name
totals.total_charge_amount
Term
BT-108
Type
decimal
Description
Sum of charges on document level.PeppolLink
Name
totals.total_tax_exclusive_amount
Term
BT-109
Type
decimal
Description
Invoice total amount without VAT.
Name
totals.total_tax_inclusive_amount
Term
BT-112
Type
decimal
Description
Invoice total amount with VAT.
Name
totals.total_prepaid_amount
Term
BT-113
Type
decimal
Description
Paid amount.PeppolLink
Name
totals.rounding_amount
Term
BT-114
Type
decimal
Description
Rounding amount.PeppolLink
Name
totals.total_payable_amount
Term
BT-115
Type
decimal
Description
Amount due for payment.

Example

json

{
  "totals": {
    "total_net_amount": 1000.0,
    "total_allowance_amount": 50.0,
    "total_charge_amount": 20.0,
    "total_tax_exclusive_amount": 970.0,
    "total_tax_inclusive_amount": 1200.0,
    "total_prepaid_amount": 200.0,
    "rounding_amount": 0.0,
    "total_payable_amount": 1000.0
  }
}

Invoice Model ​

Invoice Properties ​

Seller Details ​

Buyer details ​

Payee details ​

Tax Representative details ​

Delivery details ​

Invoicing Period ​

Payment Means ​

Invoice level Allowances ​

Invoice level Charges ​

Additional Documents ​

Invoice Lines ​

Invoice Line Allowances ​

Invoice Line Charges ​

Invoice Line Price Details ​

Invoice Line Item Details ​

Invoice Line Tax Category ​

Additional invoice line properties ​

Legal Monetary Totals ​

Invoice Model

Invoice Properties

Seller Details

Buyer details

Payee details

Tax Representative details

Delivery details

Invoicing Period

Payment Means

Invoice level Allowances

Invoice level Charges

Additional Documents

Invoice Lines

Invoice Line Allowances

Invoice Line Charges

Invoice Line Price Details

Invoice Line Item Details

Invoice Line Tax Category

Additional invoice line properties

Legal Monetary Totals