Skip to main content
GET
/
einvoicing
/
data_input_fields
Retrieves data input fields
curl --request GET \
  --url https://api.example.com/einvoicing/data_input_fields \
  --header 'Authorization: <api-key>'
{
  "country": "DE",
  "transaction_type": "B2B",
  "model": "PEPPOL",
  "document_type": "ubl-invoice",
  "fields": [
    {
      "path": "Invoice.cbc:ID",
      "field_name": "cbc:ID",
      "description": "Unique identifier for the invoice",
      "data_type": "string",
      "documentation_link": "",
      "accepted_values": [],
      "default_value": "",
      "example": "INV-1001",
      "inclusion_type": "Mandatory"
    },
    {
      "path": "Invoice.cbc:Note",
      "field_name": "cbc:Note",
      "description": "Optional description or remarks",
      "data_type": "string",
      "documentation_link": "",
      "accepted_values": [],
      "default_value": "",
      "example": "B2B Transaction",
      "inclusion_type": "Optional"
    },
    {
      "path": "Invoice/cbc:BuyerReference",
      "field_name": "cbc:BuyerReference",
      "description": "Buyer Reference: An identifier assigned by the Buyer used for internal routing purposes. An invoice must have buyer reference or purchase order reference.\n",
      "data_type": "string",
      "documentation_link": "",
      "accepted_values": [],
      "default_value": "",
      "example": "abs1234",
      "inclusion_type": "Conditional",
      "condition": null
    },
    {
      "path": "Invoice.cac:InvoiceLine.cbc:LineExtensionAmount",
      "field_name": "cbc:LineExtensionAmount",
      "description": "Invoice line net amount — The total amount of the Invoice line. This amount is net (without VAT), and must be rounded to a maximum of 2 decimals.\n",
      "data_type": "number",
      "documentation_link": "",
      "accepted_values": [],
      "default_value": "",
      "example": 2145,
      "inclusion_type": "Conditional",
      "condition": null
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://spidocs.chargebee.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Query Parameters

​
country
string
required

The ISO 3166-1 alpha-2 country code representing the country for which the e-invoicing data input fields need to be retrieved. Different countries may have varying e-invoicing requirements.

Example:

"DE"

​
transaction_type
enum<string>
required

The transaction type for which the data input fields need to be retrieved. Required fields may vary depending on the type: B2B (Business to Business), B2C (Business to Consumer), or B2G (Business to Government).

Available options:
B2B,
B2C,
B2G
Example:

"B2B"

​
model
enum<string>
required

Indicates the eInvoicing flow model that governs the document exchange and processing mechanism. Different countries adopt different models based on legal, technical, and administrative mandates. Supported values:

  • PEPPOL: A standardized, secure eInvoicing network enabling cross-border electronic document exchange between businesses and governments.
  • EINVOICE: Traditional eInvoicing model where invoices are digitally exchanged between businesses and sometimes stored.
  • CLEARANCE: Invoices must be pre-approved by a tax authority before they are sent to the buyer.
  • REPORTING: Invoices are shared with tax authorities after issuance, usually for compliance and audit purposes.
  • ZUGFERD: A hybrid eInvoicing format used in Germany combining PDF and XML for human and machine readability.
  • CTC: Continuous Transaction Controls involve real-time or near-real-time invoice validation and transmission to tax authorities.
  • NEMHANDEL: Denmark’s national infrastructure for eInvoicing that supports secure delivery via specific formats like OIOUBL.
  • FACE: Spain’s centralized system (FACe/FACeB2B) for routing invoices to government or private recipients.
  • VERIFACTU: Spain’s mechanism for validating and reporting sales invoices directly to the tax agency.
Available options:
PEPPOL,
EINVOICE,
CLEARANCE,
REPORTING,
ZUGFERD,
CTC,
NEMHANDEL,
FACE,
VERIFACTU
Example:

"PEPPOL"

​
document_type
string
required

Type of business document.

Example:

"ubl-invoice"

Response

Successfully retrieved the data input fields for the given scenario.

​
country
string

The ISO country code for the scenario.

Example:

"DE"

​
transaction_type
enum<string>

The type of transaction (B2B, B2C, B2G).

Available options:
B2B,
B2C,
B2G
Example:

"B2B"

​
model
enum<string>

Indicates the eInvoicing flow model that governs the document exchange and processing mechanism. Different countries adopt different models based on legal, technical, and administrative mandates. Supported values:

  • PEPPOL: A standardized, secure eInvoicing network enabling cross-border electronic document exchange between businesses and governments.
  • EINVOICE: Traditional eInvoicing model where invoices are digitally exchanged between businesses and sometimes stored.
  • CLEARANCE: Invoices must be pre-approved by a tax authority before they are sent to the buyer.
  • REPORTING: Invoices are shared with tax authorities after issuance, usually for compliance and audit purposes.
  • ZUGFERD: A hybrid eInvoicing format used in Germany combining PDF and XML for human and machine readability.
  • CTC: Continuous Transaction Controls involve real-time or near-real-time invoice validation and transmission to tax authorities.
  • NEMHANDEL: Denmark’s national infrastructure for eInvoicing that supports secure delivery via specific formats like OIOUBL.
  • FACE: Spain’s centralized system (FACe/FACeB2B) for routing invoices to government or private recipients.
  • VERIFACTU: Spain’s mechanism for validating and reporting sales invoices directly to the tax agency.
Available options:
PEPPOL,
EINVOICE,
CLEARANCE,
REPORTING,
ZUGFERD,
CTC,
NEMHANDEL,
FACE,
VERIFACTU
Example:

"PEPPOL"

​
document_type
string

Type of business document.

Example:

"ubl-invoice"

​
fields
object[]

List of input fields with inclusion metadata.