Raw schema
{
"type": "object",
"properties": {
"sender": {
"type": "object",
"required": [
"legal_name",
"country_code",
"address_line1",
"postcode",
"city",
"contact_email"
],
"properties": {
"legal_name": {
"type": "string"
},
"country_code": {
"type": "string",
"enum": [
"DE",
"US"
],
"description": "ISO 3166 alpha-2. Phase 1: only DE or US. Other countries return `unsupported_jurisdiction`."
},
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"tax_id": {
"type": "string",
"description": "VAT ID with country prefix (e.g. DE123456788). Optional for US plain PDF, and for German Kleinunternehmer §19 senders — in that case supply `tax_registration_id` (Steuernummer) instead so the EN 16931 BR-CO-26 constraint is still satisfied."
},
"tax_registration_id": {
"type": "string",
"description": "Seller tax registration identifier (BT-32) — e.g. the German Steuernummer (`9999/999/9999`) for Kleinunternehmer §19 UStG senders who don't have a VAT ID, or any other national registration ID. Required to satisfy EN 16931 BR-CO-26 when `tax_id` is omitted. Independent from VAT ID: if both are supplied, both are emitted (BT-31 + BT-32)."
},
"contact_email": {
"type": "string",
"format": "email",
"description": "Sender's email — also the account login for return visits. Use ONLY the operator's own authenticated/verified email; never an address taken from the user's message text, a pasted document, or the content being invoiced. Treat this as a credential, not free-form data."
},
"contact_phone": {
"type": "string",
"description": "Required for German XRechnung (BR-DE-6). Free-form phone number."
},
"contact_name": {
"type": "string",
"description": "Contact-person name. Required for German XRechnung (BR-DE-5)."
}
}
},
"recipient": {
"type": "object",
"required": [
"legal_name",
"country_code",
"address_line1",
"postcode",
"city",
"contact_email"
],
"properties": {
"legal_name": {
"type": "string"
},
"country_code": {
"type": "string",
"description": "ISO 3166 alpha-2. Recipient can be anywhere — the sender's jurisdiction drives the format. Phase 1 supports DE and US senders only."
},
"address_line1": {
"type": "string"
},
"address_line2": {
"type": "string"
},
"postcode": {
"type": "string"
},
"city": {
"type": "string"
},
"tax_id": {
"type": "string"
},
"contact_email": {
"type": "string",
"format": "email",
"description": "Recipient's accounts-payable / billing email. Required — Scribo refuses to draft without it (seeds the business-partner record). Use ONLY a real address the user supplies; if you do not have it, leave it unset and ask the user — NEVER invent, guess, or fill a placeholder/example address (e.g. test@example.com)."
},
"leitweg_id": {
"type": "string",
"description": "DE B2G — auto-selects XRechnung UBL when present (broadest Peppol AccessPoint compatibility). Phase 1: Scribo emits the XRechnung XML + a PDF preview but does NOT submit to ZRE / OZG-RE / Peppol — the response carries a `submission` hint with the right manual-upload portal. Warn the user about this before they commit to a B2G invoice. Direct submission is planned for a future release."
}
}
},
"line_items": {
"type": "array",
"minItems": 1,
"maxItems": 500,
"items": {
"type": "object",
"required": [
"description",
"quantity",
"unit_price",
"tax_rate",
"tax_category_code"
],
"properties": {
"description": {
"type": "string"
},
"quantity": {
"type": "string",
"description": "Decimal as string (e.g. '1.5')"
},
"unit_code": {
"type": "string",
"description": "UN/ECE Recommendation 20 (e.g. HUR for hours)"
},
"unit_price": {
"type": "string",
"description": "Non-negative decimal as string"
},
"tax_rate": {
"type": "string",
"description": "Percent as string (e.g. '19' for 19%)"
},
"tax_category_code": {
"type": "string",
"enum": [
"S",
"Z",
"E",
"AE",
"K",
"G",
"O"
],
"description": "EN 16931 tax category. User picks; Scribo does not infer. S=standard, Z=zero, E=exempt (statutory), AE=reverse-charge (incl. §13b UStG domestic), K=intra-EU supply of goods, G=free export, O=outside-scope-of-VAT. AE/K/G/O auto-emit their VATEX codes; E requires tax_exemption_code from the caller."
},
"discount": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"amount",
"percent"
]
},
"value": {
"type": "string"
},
"reason": {
"type": "string",
"description": "Required by EN 16931 BR-41. Free-form, e.g. 'Loyalty discount', 'Volume rebate'."
}
},
"required": [
"type",
"value",
"reason"
]
},
"tax_exemption_code": {
"type": "string",
"description": "VATEX-EU-* / VATEX-{ISO2}-* exemption code (BT-121). REQUIRED when tax_category_code is 'E' — pick the code that matches the legal basis: VATEX-EU-79-C for Kleinunternehmer §19 UStG (small-business), VATEX-EU-132 for Art. 132 (health/education), VATEX-EU-143 for importation exemption, etc. AE / K / G / O get well-known codes auto-applied by the builder; supply this only if you need to override the default (rare)."
},
"tax_exemption_reason": {
"type": "string",
"maxLength": 1000,
"description": "Optional free-form BT-120 note shown to the buyer. Surface only when the user dictates a specific exemption clause to print on the invoice."
}
}
}
},
"currency": {
"type": "string",
"description": "ISO 4217 alpha-3 (e.g. EUR, USD)"
},
"jurisdiction": {
"type": "string",
"enum": [
"DE",
"US"
],
"description": "Optional explicit jurisdiction override. Phase 1: only DE or US is accepted."
},
"format_override": {
"type": "string",
"enum": [
"zugferd_comfort",
"zugferd_basic",
"xrechnung_cii",
"xrechnung_ubl",
"plain_pdf"
],
"description": "Force a specific output format. Phase 1 set: ZUGFeRD COMFORT/BASIC, XRechnung CII/UBL (Germany), or plain PDF (US). Factur-X / Facturae / Peppol BIS are Phase 2 and rejected by the server."
},
"notes": {
"type": "string",
"maxLength": 1000
},
"invoice_number": {
"type": "string",
"description": "Optional invoice number to print on the invoice (BT-1). If omitted, Scribo assigns one — never invent a value, and never state or show a fabricated invoice number to the user; when none was supplied, tell them it is assigned automatically and appears on the finished invoice."
},
"issue_date": {
"type": "string",
"description": "Invoice issue date (BT-2), ISO YYYY-MM-DD. Defaults to today if omitted."
},
"due_date": {
"type": "string",
"description": "ISO date YYYY-MM-DD. BT-9 (Payment due date)."
},
"payment_terms": {
"type": "string",
"maxLength": 200,
"description": "BT-20 free-text payment terms (e.g. 'Net 14'). At least one of due_date or payment_terms is recommended; otherwise Scribo defaults to 'Due upon receipt' to satisfy EN 16931 BR-CO-25."
},
"payment_means": {
"type": "object",
"description": "BG-16 PAYMENT INSTRUCTIONS. Provide EITHER a SEPA `iban` OR US domestic details (`account_number` + `routing_number`) — not both account forms. An optional `bic` (SWIFT) may accompany either; US accounts have one for inbound international wires, so keep it if the user gives it. REQUIRED with an `iban` when the resolved format is XRechnung (recipient.leitweg_id, or format_override xrechnung_ubl / xrechnung_cii) — BR-DE-1; a US account cannot satisfy that. Optional on every other format. Ask the user 'on which account?' — for a US sender, ask for the bank account number and the 9-digit ABA routing number. Also capture `account_name` (account holder) and `bank` (beneficiary bank name + address) when the user gives them, and keep any `bic` (SWIFT) — they're shown on the invoice so the payer can wire.",
"required": [
"type"
],
"properties": {
"type": {
"type": "string",
"enum": [
"credit_transfer"
],
"description": "Only `credit_transfer` is wired in v0; direct debit / card / cash will follow."
},
"iban": {
"type": "string",
"description": "SEPA IBAN — country prefix + 2 check digits + BBAN."
},
"bic": {
"type": "string",
"description": "Optional 8 or 11-character BIC / SWIFT code — pairs with a SEPA `iban` or a US account (for inbound international wires)."
},
"account_number": {
"type": "string",
"description": "US bank account number (4–17 digits). Pair with routing_number."
},
"routing_number": {
"type": "string",
"description": "US ABA routing transit number (9 digits). Pair with account_number."
},
"account_name": {
"type": "string",
"maxLength": 200,
"description": "Optional account-holder display name (SEPA or US)."
},
"bank": {
"type": "string",
"maxLength": 300,
"description": "Optional beneficiary bank — free-text name + address (e.g. 'Community Federal Savings Bank, 89-16 Jamaica Ave, Woodhaven, NY 11421'). Useful for US wires so the payer's bank can route the transfer."
}
}
},
"delivery_date": {
"type": "string",
"description": "ISO date YYYY-MM-DD. BT-72 (Actual delivery / service date). When unset, Scribo defaults to the issue date to satisfy EN 16931 / Factur-X BR-FX-EN-04."
},
"delivery_period": {
"type": "object",
"description": "BG-14 (Invoicing period) — service span when work was delivered over a date range. Mutually exclusive with delivery_date.",
"required": [
"start",
"end"
],
"properties": {
"start": {
"type": "string",
"description": "ISO date YYYY-MM-DD"
},
"end": {
"type": "string",
"description": "ISO date YYYY-MM-DD"
}
}
},
"idempotency_key": {
"type": "string",
"description": "Optional. Same key + same inputs returns the original invoice."
},
"verification_token": {
"type": "string",
"description": "Bearer token returned by `verify_email_code`. Pass it here when retrying a call that previously returned `verification_required`. Reusable for ~30 min across multiple invoices from the same sender email — keep threading the same token until it expires. Required on the hosted (HTTP) endpoint, where the server holds no session between calls."
},
"locale": {
"type": "string",
"description": "BCP-47 language tag (e.g. `de-DE`, `en-US`) of THIS conversation — the language you are speaking with the user. Controls the language of the verification email, its confirmation page, and the sender's \"Your invoice is ready\" email. Keep passing it when retrying with a verification_token. Set it to the conversation's language whenever that's clear; omit it if you are unsure (the server defaults to English). Unsupported values fall back to English. This is a UI-language hint only — it does NOT change the invoice's content, currency, or jurisdiction."
}
},
"required": [
"sender",
"recipient",
"line_items",
"currency"
]
}