Submit a document

Party responsible for issuing the document (that is, the supplier). This represents the legal entity or business that creates the invoice and bears responsibility for delivering goods or services.

Party responsible for receiving the invoice (i.e., the customer).

Represents the total tax details for the document.

Optional structure used to override the standard Chargebee SPI document model fields with a flexible field-value-based approach.

This is typically used by adapters where field mapping is configured manually by the merchant in the Chargebee UI, instead of relying on pre-defined mappings managed by the provider or Chargebee.

When present, the overrides object allows the adapter to entirely ignore the standard document payload and instead:

• Use field_mapping to determine where values go in the provider's schema
• Use values to retrieve the corresponding input data using dot-paths or array-style paths

• field_mapping: A list of mapping rules that define how Chargebee parameter paths (keys from values) should be translated to the corresponding field paths in the provider schema. Includes custom fields too which are defined by merchant in chargebee.

  Each item must include:

  • target: The field path in the e-invoicing provider schema (e.g. Invoice.cbc:ID)
  • One of the below
  • source: A dot-notated field path or array path from the values section (e.g. invoice.id, line_items[].tax_category)
  • fixed_value (optional): Used if the field always has a constant value (e.g. 380 for InvoiceTypeCode)
  • expr: An inline expression evaluated against the values object to compute the target field’s value. This is used when the value depends on conditional logic, tax scenarios, payment methods, or other derived rules.

• values: Each key in this object uses dot-notation to reference the source path, including arrays and nested arrays — for example: invoice.issue_date, line_items[].id, or line_items[].tax_category[].id.

  • Scalar values (e.g., strings, numbers, dates) should be represented as flat keys:

    {
      "invoice.id": "INV-10001",
      "invoice.issue_date": "2025-04-02",
      "invoice.currency_code": "EUR"
    }

  • Complex types like arrays (e.g., line_items) should be represented as nested JSON:

    {
      "line_items": [
        { "id": "1", "line_item_tax": [ {"name" : "VAT" }] },
        { "id": "2", "line_item_tax": [ {"name" : "Local Tax"}] }
      ]
    }

This model supports maximum flexibility by separating the actual data values from Chargebee's internal schema structure. It enables provider-specific document construction without tightly coupling the adapter to Chargebee's native schema.