Input schema (JSON)
{
"type": "object",
"$defs": {
"Line": {
"type": "object",
"title": "Line",
"required": [
"item_name",
"quantity",
"unit_price"
],
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"default": null,
"description": "BT-126, auto-numbered when omitted"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Note",
"default": null,
"description": "BT-127"
},
"charges": {
"type": "array",
"items": {
"$ref": "#/$defs/LineAllowanceCharge"
},
"title": "Charges",
"description": "BG-28"
},
"quantity": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,13}|(?=[\\d.]{1,20}0*$)\\d{0,13}\\.\\d{0,6}0*$)"
}
],
"title": "Quantity",
"description": "BT-129"
},
"vat_rate": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,3}|(?=[\\d.]{1,8}0*$)\\d{0,3}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Vat Rate",
"default": null,
"description": "BT-152, required for category S"
},
"item_name": {
"type": "string",
"title": "Item Name",
"description": "BT-153"
},
"unit_code": {
"type": "string",
"title": "Unit Code",
"default": "C62",
"description": "UN/ECE Rec 20, BT-130 (C62 unit, HUR hour, DAY, KGM, MTR, LTR...)"
},
"allowances": {
"type": "array",
"items": {
"$ref": "#/$defs/LineAllowanceCharge"
},
"title": "Allowances",
"description": "BG-27"
},
"attributes": {
"type": "object",
"title": "Attributes",
"description": "BG-32 item attributes",
"additionalProperties": {
"type": "string"
}
},
"net_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Net Amount",
"default": null,
"description": "BT-131. Computed as quantity x unit_price / base_qty - allowances + charges when omitted"
},
"period_end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Period End",
"default": null,
"description": "BT-135"
},
"unit_price": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Unit Price",
"description": "Net unit price, BT-146"
},
"period_start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Period Start",
"default": null,
"description": "BT-134"
},
"vat_category": {
"$ref": "#/$defs/VatCategory",
"default": "S",
"description": "BT-151"
},
"buyer_item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Item Id",
"default": null,
"description": "BT-156"
},
"origin_country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Origin Country",
"default": null,
"description": "BT-159"
},
"price_discount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Price Discount",
"default": null,
"description": "BT-147"
},
"seller_item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Seller Item Id",
"default": null,
"description": "BT-155"
},
"gross_unit_price": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Gross Unit Price",
"default": null,
"description": "BT-148"
},
"item_description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Item Description",
"default": null,
"description": "BT-154"
},
"standard_item_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Standard Item Id",
"default": null,
"description": "BT-157, e.g. EAN/GTIN"
},
"price_base_quantity": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,13}|(?=[\\d.]{1,20}0*$)\\d{0,13}\\.\\d{0,6}0*$)"
},
{
"type": "null"
}
],
"title": "Price Base Quantity",
"default": null,
"description": "BT-149"
},
"order_line_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Order Line Reference",
"default": null,
"description": "BT-132"
},
"price_base_unit_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Base Unit Code",
"default": null,
"description": "BT-150"
},
"standard_item_id_scheme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Standard Item Id Scheme",
"default": null,
"description": "BT-157-1, e.g. 0160 = GTIN"
},
"buyer_accounting_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Accounting Reference",
"default": null,
"description": "BT-133"
}
},
"additionalProperties": false
},
"Note": {
"type": "object",
"title": "Note",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"title": "Text",
"description": "BT-22"
},
"subject_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject Code",
"default": null,
"description": "UNTDID 4451 code, BT-21 (e.g. AAI general, PMT payment, PMD penalties)"
}
},
"additionalProperties": false
},
"Party": {
"type": "object",
"title": "Party",
"required": [
"name",
"address"
],
"properties": {
"name": {
"type": "string",
"title": "Name",
"description": "Legal name, BT-27 / BT-44"
},
"siren": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Siren",
"default": null,
"description": "French SIREN (9 digits). Written as legal registration id BT-30 / BT-47 with scheme 0002."
},
"siret": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Siret",
"default": null,
"description": "French SIRET (14 digits). Shortcut for electronic_address with scheme 0225."
},
"vat_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Vat Id",
"default": null,
"description": "BT-31 / BT-48, e.g. FR12345678901"
},
"address": {
"$ref": "#/$defs/Address"
},
"contact": {
"anyOf": [
{
"$ref": "#/$defs/Contact"
},
{
"type": "null"
}
],
"default": null
},
"global_ids": {
"type": "object",
"title": "Global Ids",
"description": "BT-29 / BT-46: {schemeID: identifier}, e.g. {'0009': SIRET}",
"additionalProperties": {
"type": "string"
}
},
"legal_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Legal Info",
"default": null,
"description": "Seller only, BT-33: legal form, share capital, RCS city..."
},
"trading_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trading Name",
"default": null,
"description": "BT-28 / BT-45"
},
"electronic_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Electronic Address",
"default": null,
"description": "BT-34 / BT-49"
},
"tax_registration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tax Registration Id",
"default": null,
"description": "Seller only, BT-32"
},
"legal_registration_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Legal Registration Id",
"default": null,
"description": "BT-30 / BT-47 when not a SIREN. Ignored if siren is set."
},
"electronic_address_scheme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Electronic Address Scheme",
"default": null,
"description": "EAS code for electronic_address (BT-34-1 / BT-49-1), e.g. 0225 = SIRET (FR)"
},
"legal_registration_scheme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Legal Registration Scheme",
"default": null,
"description": "ISO 6523 ICD for legal_registration_id (BT-30-1 / BT-47-1), e.g. 0002 = SIREN"
}
},
"additionalProperties": false
},
"Totals": {
"type": "object",
"title": "Totals",
"required": [
"line_total",
"tax_exclusive",
"tax_total",
"tax_inclusive",
"amount_due"
],
"properties": {
"prepaid": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Prepaid",
"default": null,
"description": "BT-113"
},
"rounding": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Rounding",
"default": null,
"description": "BT-114"
},
"tax_total": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Tax Total",
"description": "BT-110"
},
"amount_due": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Amount Due",
"description": "BT-115"
},
"line_total": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Line Total",
"description": "BT-106"
},
"charge_total": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Charge Total",
"default": null,
"description": "BT-108"
},
"tax_exclusive": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Tax Exclusive",
"description": "BT-109"
},
"tax_inclusive": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Tax Inclusive",
"description": "BT-112"
},
"vat_breakdown": {
"type": "array",
"items": {
"$ref": "#/$defs/VatBreakdown"
},
"title": "Vat Breakdown",
"description": "BG-23"
},
"allowance_total": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Allowance Total",
"default": null,
"description": "BT-107"
}
},
"description": "Document totals (BG-22). All computed by the engine when omitted.",
"additionalProperties": false
},
"Address": {
"type": "object",
"title": "Address",
"required": [
"country"
],
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City",
"default": null,
"description": "BT-37 / BT-52"
},
"line1": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line1",
"default": null,
"description": "BT-35 / BT-50"
},
"line2": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line2",
"default": null,
"description": "BT-36 / BT-51"
},
"line3": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line3",
"default": null,
"description": "BT-162 / BT-163"
},
"country": {
"type": "string",
"title": "Country",
"maxLength": 2,
"minLength": 2,
"description": "ISO 3166-1 alpha-2, BT-40 / BT-55"
},
"postal_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Postal Code",
"default": null,
"description": "BT-38 / BT-53"
},
"country_subdivision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country Subdivision",
"default": null,
"description": "BT-39 / BT-54"
}
},
"additionalProperties": false
},
"Contact": {
"type": "object",
"title": "Contact",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "BT-41 / BT-56"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email",
"default": null,
"description": "BT-43 / BT-58"
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Phone",
"default": null,
"description": "BT-42 / BT-57"
},
"department": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Department",
"default": null,
"description": "BT-41-0 / BT-56-0 (used when name is empty)"
}
},
"additionalProperties": false
},
"Invoice": {
"type": "object",
"title": "Invoice",
"required": [
"number",
"issue_date",
"seller",
"buyer",
"lines"
],
"properties": {
"buyer": {
"$ref": "#/$defs/Party",
"description": "BG-7"
},
"lines": {
"type": "array",
"items": {
"$ref": "#/$defs/Line"
},
"title": "Lines",
"minItems": 1,
"description": "BG-25"
},
"notes": {
"type": "array",
"items": {
"$ref": "#/$defs/Note"
},
"title": "Notes",
"description": "BG-1"
},
"number": {
"type": "string",
"title": "Number",
"pattern": "^[A-Za-z0-9._/\\-]+$",
"maxLength": 35,
"description": "BT-1 (BR-FR-01/02: max 35 chars, letters, digits, . _ / -)"
},
"seller": {
"$ref": "#/$defs/Party",
"description": "BG-4"
},
"totals": {
"anyOf": [
{
"$ref": "#/$defs/Totals"
},
{
"type": "null"
}
],
"default": null,
"description": "BG-22, computed when omitted"
},
"charges": {
"type": "array",
"items": {
"$ref": "#/$defs/AllowanceCharge"
},
"title": "Charges",
"description": "BG-21"
},
"payment": {
"anyOf": [
{
"$ref": "#/$defs/Payment"
},
{
"type": "null"
}
],
"default": null,
"description": "BG-16"
},
"currency": {
"type": "string",
"title": "Currency",
"default": "EUR",
"maxLength": 3,
"minLength": 3,
"description": "BT-5"
},
"delivery": {
"anyOf": [
{
"$ref": "#/$defs/Delivery"
},
{
"type": "null"
}
],
"default": null,
"description": "BG-13"
},
"due_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date",
"default": null,
"description": "BT-9"
},
"type_code": {
"enum": [
"380",
"381",
"384",
"386",
"389",
"261",
"751"
],
"type": "string",
"title": "Type Code",
"default": "380",
"description": "UNTDID 1001, BT-3: 380 invoice, 381 credit note, 384 corrected, 386 prepayment, 389 self-billed"
},
"allowances": {
"type": "array",
"items": {
"$ref": "#/$defs/AllowanceCharge"
},
"title": "Allowances",
"description": "BG-20"
},
"issue_date": {
"type": "string",
"title": "Issue Date",
"format": "date",
"description": "BT-2"
},
"already_paid": {
"type": "boolean",
"title": "Already Paid",
"default": false,
"description": "Invoice already paid at issuance (French BT-23 variants B2/S2/M2)"
},
"payment_terms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Terms",
"default": null,
"description": "BT-20"
},
"operation_type": {
"enum": [
"goods",
"services",
"mixed"
],
"type": "string",
"title": "Operation Type",
"default": "services",
"description": "Nature of the operation, used to derive the French business process code BT-23 (B1/S1/M1)"
},
"prepaid_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Prepaid Amount",
"default": null,
"description": "BT-113 shortcut when totals are computed"
},
"tax_point_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Tax Point Date",
"default": null,
"description": "BT-7"
},
"buyer_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Reference",
"default": null,
"description": "BT-10"
},
"french_mentions": {
"$ref": "#/$defs/FrenchMentions",
"description": "Mandatory French legal mentions (BR-FR-05)"
},
"rounding_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Rounding Amount",
"default": null,
"description": "BT-114 shortcut when totals are computed"
},
"business_process": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Business Process",
"default": null,
"description": "Explicit BT-23 business process code (e.g. S1). Overrides operation_type/already_paid."
},
"tender_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tender Reference",
"default": null,
"description": "BT-17"
},
"project_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Project Reference",
"default": null,
"description": "BT-11"
},
"contract_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Contract Reference",
"default": null,
"description": "BT-12"
},
"preceding_invoices": {
"type": "array",
"items": {
"$ref": "#/$defs/PrecedingInvoice"
},
"title": "Preceding Invoices",
"description": "BG-3"
},
"additional_documents": {
"type": "array",
"items": {
"$ref": "#/$defs/AdditionalDocument"
},
"title": "Additional Documents",
"description": "BG-24"
},
"tax_exemption_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tax Exemption Reason",
"default": null,
"description": "Default BT-120 text for E/AE/K/G/O categories, e.g. 'TVA non applicable, art. 293 B du CGI'"
},
"sales_order_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Sales Order Reference",
"default": null,
"description": "BT-14"
},
"vat_accounting_currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Vat Accounting Currency",
"default": null,
"description": "BT-6"
},
"purchase_order_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Purchase Order Reference",
"default": null,
"description": "BT-13"
},
"despatch_advice_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Despatch Advice Reference",
"default": null,
"description": "BT-16"
},
"tax_exemption_reason_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tax Exemption Reason Code",
"default": null,
"description": "Default BT-121 VATEX code"
},
"buyer_accounting_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Buyer Accounting Reference",
"default": null,
"description": "BT-19"
},
"receiving_advice_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Receiving Advice Reference",
"default": null,
"description": "BT-15"
}
},
"additionalProperties": false
},
"Payment": {
"type": "object",
"title": "Payment",
"properties": {
"bic": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Bic",
"default": null,
"description": "BT-86"
},
"iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Iban",
"default": null,
"description": "Payee account, BT-84"
},
"terms": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Terms",
"default": null,
"description": "BT-20"
},
"means_code": {
"type": "string",
"title": "Means Code",
"default": "30",
"description": "UNTDID 4461, BT-81. 30 credit transfer, 58 SEPA transfer, 59 SEPA direct debit, 48 card"
},
"means_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Means Text",
"default": null,
"description": "BT-82"
},
"account_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Account Name",
"default": null,
"description": "BT-85"
},
"debited_iban": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Debited Iban",
"default": null,
"description": "Direct debit, BT-91"
},
"mandate_reference": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Mandate Reference",
"default": null,
"description": "Direct debit, BT-89"
},
"creditor_reference_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Creditor Reference Id",
"default": null,
"description": "Direct debit, BT-90"
},
"remittance_information": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Remittance Information",
"default": null,
"description": "BT-83"
}
},
"additionalProperties": false
},
"Profile": {
"enum": [
"basicwl",
"en16931",
"extended",
"extended-ctc-fr"
],
"type": "string",
"title": "Profile",
"description": "Factur-X / CII profile for generation."
},
"Delivery": {
"type": "object",
"title": "Delivery",
"properties": {
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"default": null,
"description": "Deliver-to party name, BT-70"
},
"address": {
"anyOf": [
{
"$ref": "#/$defs/Address"
},
{
"type": "null"
}
],
"default": null
},
"period_end": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Period End",
"default": null,
"description": "BT-74"
},
"actual_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Actual Date",
"default": null,
"description": "BT-72"
},
"location_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location Id",
"default": null,
"description": "BT-71"
},
"period_start": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Period Start",
"default": null,
"description": "BT-73"
},
"location_id_scheme": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Location Id Scheme",
"default": null,
"description": "BT-71-1"
}
},
"additionalProperties": false
},
"Language": {
"enum": [
"fr",
"en"
],
"type": "string",
"title": "Language"
},
"VatCategory": {
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O",
"L",
"M"
],
"type": "string",
"title": "VatCategory",
"description": "UNTDID 5305 subset used by EN 16931 (BT-151 / BT-118)."
},
"OutputFormat": {
"enum": [
"facturx-pdf",
"cii-xml",
"ubl-xml"
],
"type": "string",
"title": "OutputFormat"
},
"VatBreakdown": {
"type": "object",
"title": "VatBreakdown",
"required": [
"category",
"taxable_amount",
"tax_amount"
],
"properties": {
"rate": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,3}|(?=[\\d.]{1,8}0*$)\\d{0,3}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Rate",
"default": null,
"description": "BT-119"
},
"category": {
"$ref": "#/$defs/VatCategory",
"description": "BT-118"
},
"tax_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Tax Amount",
"description": "BT-117"
},
"taxable_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Taxable Amount",
"description": "BT-116"
},
"exemption_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Exemption Reason",
"default": null,
"description": "BT-120"
},
"exemption_reason_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Exemption Reason Code",
"default": null,
"description": "VATEX code, BT-121"
}
},
"additionalProperties": false
},
"FrenchMentions": {
"type": "object",
"title": "FrenchMentions",
"properties": {
"enabled": {
"type": "boolean",
"title": "Enabled",
"default": true,
"description": "Add the three mandatory French mentions when missing"
},
"recovery_fee": {
"type": "string",
"title": "Recovery Fee",
"default": "Indemnité forfaitaire pour frais de recouvrement en cas de retard de paiement : 40 €.",
"description": "Note code PMT"
},
"early_payment_discount": {
"type": "string",
"title": "Early Payment Discount",
"default": "Pas d'escompte pour paiement anticipé.",
"description": "Note code AAB"
},
"late_payment_penalties": {
"type": "string",
"title": "Late Payment Penalties",
"default": "Tout retard de paiement entraîne une pénalité exigible à compter de la date d'échéance, calculée sur la base de trois fois le taux d'intérêt légal.",
"description": "Note code PMD"
}
},
"description": "Legal mentions required on French B2B invoices (BR-FR-05). Added as BG-1 notes with codes PMD, PMT, AAB.",
"additionalProperties": false
},
"AllowanceCharge": {
"type": "object",
"title": "AllowanceCharge",
"required": [
"amount"
],
"properties": {
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Amount",
"description": "BT-92 / BT-99, tax excluded"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null,
"description": "BT-97 / BT-104"
},
"vat_rate": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,3}|(?=[\\d.]{1,8}0*$)\\d{0,3}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Vat Rate",
"default": null,
"description": "BT-96 / BT-103"
},
"percentage": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,3}|(?=[\\d.]{1,8}0*$)\\d{0,3}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Percentage",
"default": null,
"description": "BT-94 / BT-101"
},
"base_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Base Amount",
"default": null,
"description": "BT-93 / BT-100"
},
"reason_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason Code",
"default": null,
"description": "UNTDID 5189 / 7161, BT-98 / BT-105"
},
"vat_category": {
"$ref": "#/$defs/VatCategory",
"default": "S",
"description": "BT-95 / BT-102"
}
},
"description": "Document-level allowance (BG-20) or charge (BG-21).",
"additionalProperties": false
},
"PrecedingInvoice": {
"type": "object",
"title": "PrecedingInvoice",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"title": "Number",
"description": "BT-25"
},
"issue_date": {
"anyOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Issue Date",
"default": null,
"description": "BT-26"
}
},
"additionalProperties": false
},
"AdditionalDocument": {
"type": "object",
"title": "AdditionalDocument",
"required": [
"id"
],
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "BT-122"
},
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Url",
"default": null,
"description": "BT-124"
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null,
"description": "BT-123"
}
},
"additionalProperties": false
},
"LineAllowanceCharge": {
"type": "object",
"title": "LineAllowanceCharge",
"required": [
"amount"
],
"properties": {
"amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
}
],
"title": "Amount",
"description": "BT-136 / BT-141"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"default": null,
"description": "BT-139 / BT-144"
},
"percentage": {
"anyOf": [
{
"type": "number",
"maximum": 100,
"minimum": 0
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,3}|(?=[\\d.]{1,8}0*$)\\d{0,3}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Percentage",
"default": null,
"description": "BT-138 / BT-143"
},
"base_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "string",
"pattern": "^(?!^[-+.]*$)[+-]?0*(?:\\d{0,15}|(?=[\\d.]{1,20}0*$)\\d{0,15}\\.\\d{0,4}0*$)"
},
{
"type": "null"
}
],
"title": "Base Amount",
"default": null,
"description": "BT-137 / BT-142"
},
"reason_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason Code",
"default": null,
"description": "BT-140 / BT-145"
}
},
"additionalProperties": false
}
},
"title": "generate_invoiceArguments",
"required": [
"invoice"
],
"properties": {
"check": {
"enum": [
"base",
"fr-ctc"
],
"type": "string",
"title": "Check",
"default": "fr-ctc",
"description": "Rule set the output must pass before it is returned: fr-ctc (default) = EN 16931 + French CTC rules (BR-FR-*), base = EN 16931 only (non-French sellers)."
},
"output": {
"$ref": "#/$defs/OutputFormat",
"type": "string",
"default": "facturx-pdf",
"description": "facturx-pdf (default): PDF/A-3 with the visual invoice and CII XML inside, the hybrid file French platforms accept. cii-xml: UN/CEFACT CII XML alone. ubl-xml: UBL 2.1 XML alone."
},
"invoice": {
"$ref": "#/$defs/Invoice",
"type": "object",
"description": "Invoice data: seller, buyer, lines, dates, payment terms. Amounts are decimal strings (\"1200.00\"), dates ISO 8601. Totals and the VAT breakdown are computed. Full JSON Schema in the resource facturx://schema/invoice."
},
"profile": {
"$ref": "#/$defs/Profile",
"type": "string",
"default": "en16931",
"description": "EN 16931 conformance level written in the XML: en16931 (default, full semantic model), extended (optional business terms), extended-ctc-fr (French B2B mandate; parties are checked before the file is emitted), basicwl (no lines)"
},
"language": {
"$ref": "#/$defs/Language",
"type": "string",
"default": "fr",
"description": "Language of the visual PDF: fr (default) or en. Ignored when output is cii-xml or ubl-xml."
},
"footer_text": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Footer Text",
"default": null,
"description": "Optional text printed in the PDF footer. Omit it for no footer. Ignored for XML-only output."
},
"party_check": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Party Check",
"default": null,
"description": "Ask EU Verify whether the seller and buyer are invoice-ready before emitting. true checks. false skips. Omit it and extended-ctc-fr checks, other profiles do not. not_ready is a tool error and no file is returned."
}
}
}