Factur-X: Generate & Validate E-Invoices

Check a supplied seller AND buyer together, returning combined readiness and separate evidence. Use before generate_invoice; use check_party for one party and validate_invoice for document rules. Each party needs siren, siret or vat; siret wins over siren. French identifiers or country_code=FR require SIREN/SIRET; a French lookup can derive omitted vat. Address fields activate address checks. requester_vat applies to both lookups but cannot replace either party's vat. Roles follow seller/buyer argument names; no invoice lines or full invoice body is needed. Makes at most two EU Verify requests with the caller's plan key; Pro/Scale enable register access. Returns status and parties.seller/buyer, each with status, reasons and available evidence. Only two positive results yield invoice_ready; any not_ready yields not_ready, otherwise inconclusive. Inspect both results: denied plans, invalid input, quotas and outages never establish readiness. No document quota is consumed; upstream limits still apply per lookup. Results may change on retry. No invoice is generated, stored or sent.

Check exactly one seller or buyer's registry identifiers and readiness through EU Verify. Use to correct one party's identifiers; use check_invoice_parties to check seller and buyer together, or validate_invoice for document rules. Supply siren, siret or vat; siret wins over siren. A SIREN/SIRET, country_code=FR or FR VAT triggers French checks requiring a SIREN/SIRET. Omitted vat can be derived from a successful French lookup; foreign parties normally need explicit VAT. Send address fields with a coherent country_code; requester_vat cannot substitute for the checked party's vat. Sends supplied fields to EU Verify and applicable registers. A Pro/Scale key enables checks; other plans return plan_excluded. No Factur-X document quota is consumed. Returns status, reasons with field pointers and available evidence: invoice_ready is positive, not_ready needs correction, upstream_unavailable is inconclusive and retryable, invalid_input indicates rejected input. Register results and evidence ids may change between calls. No invoice is created or stored.

Draft a type-381 credit note from an existing invoice, for all lines or selected quantities. Use to reverse an existing invoice's charges; use get_invoice_example for a synthetic credit-note example. invoice must be the original generate_invoice input object, not extract_invoice output. number and issue_date belong to the new credit note; the original number/date are copied into preceding_invoices. Give number a distinct value and use YYYY-MM-DD dates. due_date replaces the original deadline; omitting it removes that deadline rather than inheriting it. Omit credit_lines to retain all original lines and amounts. Otherwise select distinct 1-based array positions, not line ids: [{"line_index":1,"quantity":"2"}] credits two units of the first line. Omitted lines are excluded; quantities cannot exceed the original. Prices and VAT rates are retained. Selected-line mode clears original totals, prepayments, rounding and paid status for recalculation. Document allowances/charges, or reduced quantities on adjusted lines or overridden net amounts, need explicit allocation: these cases return an error; prepare a credit body for generate_invoice. No prior-credit history is stored: the caller must prevent cumulative credits beyond the original. Keep amounts positive: type 381 expresses the credit. Existing credit notes, a reused invoice number or negative line amounts produce a tool error. Default payment remittance references follow the new number; a custom reference is preserved. Returns invoice, type_code, preceding_invoice and next. Pass the returned invoice to generate_invoice with the original profile to create the document. No key or document quota is needed for drafting; nothing is stored, sent or refunded.

Combine a visual PDF you already have with CII XML into one Factur-X PDF/A-3. Use for an existing visual invoice; use generate_invoice to render invoice data or produce UBL. Match the PDF's parties, lines and totals to xml yourself: check examines only XML and cannot detect disagreement with the visible PDF. The embedded profile comes from xml; neither check nor language changes it. language does not translate the PDF. Invalid input or failed rules return a tool error with no file; rule errors include ids. For a findings report use validate_invoice. Success returns a JSON summary (profile, size_bytes, warning count) and a base64 PDF/A-3 resource. Requires a trial, prepaid or subscription allowance via OAuth or key; success consumes one document, errors consume none. Nothing is stored or sent.

Turn a validation rule id into the invoice field to change and an example value. Use after validate_invoice or a generate_invoice rule error, not to validate an invoice itself. rule is trimmed and uppercased to select a guide entry. message/json_pointer must come from that same finding: nonempty values override its generic context, but never change the selected fix or example. Omit them to use guide defaults for known rules. Returns rule, known, message, json_pointer, fix and example; known rules also include problem. Selected BR-FR rules and BR-CO-17/BR-CO-26 have guidance. Unknown ids return known=false and example=null with the supplied context, not an error; consult the original finding. No key or document quota is needed; nothing is stored.

Extract invoice parties, dates, lines, totals and VAT as JSON for bookkeeping or matching. Use validate_invoice for compliance; this performs no OCR or recalculation. Supply one source: nonblank xml overrides document_base64 without inspecting it, so omit xml to extract a PDF's attachment. include_xml returns that selected source for archiving or validation, not XML reconstructed from fields. Extracted fields need mapping before use as generate_invoice input. Returns fields and format/profile metadata, plus PDF metadata for PDF input. Missing business values remain null; numeric values are strings. Missing input, invalid base64, malformed/unrecognized XML or a PDF without embedded XML returns a tool error, not an empty extraction. Requires a trial, prepaid or subscription allowance via OAuth or API key; success consumes one operation, errors consume none. Nothing is stored or sent.

Create an EN 16931 e-invoice from structured data: Factur-X PDF/A-3, CII XML, or UBL 2.1 XML. Use when you have the parties, lines and dates and need the document. To revise one, correct the input and regenerate; save and deliver the returned file through your own system. Do not use when you already have a visual PDF and CII XML: call embed_xml. To check a document you did not create here, call validate_invoice; to read one, call extract_invoice. Start invoice from get_invoice_example, replacing sample parties and dates. Leave totals and line net_amount omitted to compute them from quantities, prices, allowances and charges. For ubl-xml, profile must be en16931 or extended-ctc-fr; extended and basicwl are CII/PDF-only. profile selects the XML model while check selects validation rules: use check=base for non-French invoices; changing check does not disable party_check. language and footer_text affect only the visual PDF. Omitted party_check enables registry checks only for extended-ctc-fr; true/false explicitly overrides that default. Enabled checks send party identifiers/address and seller IBAN to EU Verify. A not_ready verdict blocks output with field pointers. Successful checks add evidence ids; registry outages do not block generation and are reported as warnings, not proof of readiness. XSD/business-rule failures return a tool error with rule ids; fix the input and retry. Requires an authenticated trial, prepaid or subscription allowance (OAuth or API key). Each successful result uses one document operation, including repeated calls. Returns a JSON text summary (totals, warnings, evidence) and an embedded resource: base64 PDF or XML text. No invoice is stored or sent to a recipient.

Return a complete invoice or credit-note example to edit and pass to generate_invoice. Use this first, instead of inventing fields. No API key is required, and the call does not count as a document. The seller and buyer are sample data: replace them, the number, the dates and the lines before you generate. For credit_note, also replace preceding_invoices with the original invoice reference. To credit a real invoice already in hand, use draft_credit_note instead of this synthetic example. Amounts are positive decimal strings. Nothing is stored, and no file is created. Returns the invoice plus the profile and check to pass to generate_invoice.

Check a Factur-X PDF, CII XML or UBL XML against EN 16931, and report the fields to fix. Use when the caller supplies a document, including after corrections; use extract_invoice for business data. With no document and only a request to try the product, choose view_invoice_demo instead. Supply one source: nonblank xml overrides document_base64 without inspecting it. To check a PDF's attachment, omit xml. check adds rules to the detected profile; it cannot change that profile. Use base for non-French invoices to avoid French-field findings. Returns validity and findings with rule ids and field pointers for explain_finding. XSD failures skip schematron; inspect checks_skipped before treating validation as complete. Warnings alone do not invalidate an invoice. Rule failures or a PDF without XML return valid=false; missing input, invalid base64, malformed or unrecognized XML return a tool error. Free without a key (shared daily limit, files up to 5 MB). With an OAuth connection or API key, completed reports consume one operation even when invalid; tool errors do not. No invoice is changed, stored or sent.

Demonstrate the engine on bundled synthetic samples only; never checks a user's invoice. Use for product evaluation without a key. To check a supplied document, choose validate_invoice. Choose sample=valid to inspect a passing CII invoice or sample=invalid to see the missing-buyer-name finding. Both use the production XSD and EN 16931 engine; results may be cached for 24 hours for the same engine version and input. Inspect validated_at and cached; a cache hit is not a fresh run. Call with {} to validate the passing sample, or sample=downloads for PDF/CII/UBL files and the published report. Accepts no document data, URLs or extra arguments. No PDF or business-register checks in live mode. Shared rate limits return a retryable tool error; unavailable checks never become a passing result. Use explain_finding for a returned rule id. Your own invoices require validate_invoice with a verified-account trial, prepaid or monthly-plan key. Nothing is stored except reports for these public fixtures.