Factur-X: Generate & Validate E-Invoices

 ⟨3165 unchanged words⟩ you passed to generate_invoice. Not an extract_invoice result.","type":"object"},"issue_date":{"description":"Credit note  ⟨45 unchanged words⟩ 

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Draft a full or partial credit note"}

 ⟨46 unchanged words⟩  PDF metadata: fr (default) or en.","type":"string"},"pdf_base64":{"description":"Standard base64  ⟨42 unchanged words⟩ 

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Embed CII XML into a PDF"}

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Explain a validation finding"}

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Extract e-invoice data"}

 ⟨3150 unchanged words⟩ Full JSON Schema in the resource facturx://schema/invoice.","type":"object"},"language":{"$ref":"#/$defs/Language"," ⟨11 unchanged words⟩ en. Ignored when output is cii-xml or ubl-xml.","type":"string"},"output":{"$ref":"#/$defs/OutputFormat"," ⟨23 unchanged words⟩  XML alone. ubl-xml: UBL 2.1 XML alone.","type":"string"},"party_check":{"anyOf":[{"type" ⟨76 unchanged words⟩  file is emitted), basicwl (no lines)","type":"string"}},"required":["invoice"],"title ⟨3 unchanged words⟩ 

{"idempotentHint":true,"openWorldHint":true,"readOnlyHint":true,"title":"Generate an EN 16931 invoice"}

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Get an invoice or credit-note example"}

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Validate your invoice document"}

{"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Try fixed invoice samples (no document input)"}

Check whetherone ainvoice party is invoice-ready

Ask EU VerifyCheck whetherexactly one seller or buyerbuyer's canregistry appearidentifiers onand anreadiness invoice.through EU Verify.

    Use to correct one party's identifiers; use check_invoice_parties ⟨126 unchanged words⟩ 

Draft a creditfull noteor frompartial ancredit invoicenote

ReturnDraft thea credit-notetype-381 bodycredit fornote anfrom invoice:an typeexisting 381invoice, same partiesfor andall lines, amountsor unchanged.selected quantities.

    Use for a full creditto ofreverse an existing invoice, notinvoice's forcharges; extractinguse aget_invoice_example PDFfor ora validatingsynthetic acredit-note document.example.
    invoice must be the original generate_invoice input object ⟨34 unchanged words⟩ it removes that deadline rather than inheriting it.

    AllOmit 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 amountsVAT rates are retainedretained.
    Selected-line mode clears original totals, soprepayments, thisrounding doesand notpaid calculatestatus 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 partialcredit refund.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  ⟨64 unchanged words⟩ 

Get a validan invoice bodyor credit-note example

Return a complete invoice bodyor youcredit-note canexample to edit and pass to generate_invoice.

    Use this first, ⟨29 unchanged words⟩ 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, ⟨17 unchanged words⟩ 

{"properties":{"document_type":{"default":"invoice","description":"invoice (default): type 380; credit_note: type 381 with a sample original-invoice reference.","enum":["invoice","credit_note"],"title":"Document Type","type":"string"},"profile":{"default":"en16931","description": ⟨32 unchanged words⟩ 

Validate e-invoiceyour invoice document

 ⟨12 unchanged words⟩ , and report the fields to fix.

    Use onwhen receivedthe documentscaller orsupplies 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  ⟨105 unchanged words⟩ 

Try freefixed invoice validation orsamples download(no sampledocument filesinput)

TryDemonstrate validationthe withoutengine signup,on abundled keysynthetic orsamples paidonly; credits,never usingchecks fixeda syntheticuser's invoices.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  ⟨116 unchanged words⟩ 

 ⟨7 unchanged words⟩ with CII XML into one Factur-X PDF/A-3.

    Use whenfor youran systemexisting alreadyvisual producedinvoice; theuse visualgenerate_invoice invoice.to Forrender invoice JSONdata thator needsproduce rendering,UBL.
    use generate_invoice instead. pdf_base64 must encodeMatch the PDFPDF's bytesparties, not alines fileand URLtotals orto data-URI;
    xml is unencoded CII text for that same invoice. The tool does not compare the visible PDF amounts
    with the XMLyourself: ensure theycheck agreeexamines beforeonly embedding.XML Itand cannot embed UBL; use generate_invoice for UBL output.

    check validates the XML,detect
    disagreement notwith the PDF's visible content: choose base forPDF. ENThe 16931embedded only,profile orcomes thefrom default
    fr-ctcxml; forneither Frenchcheck additions.nor language sets PDF
    changes metadata;it. itlanguage does not translate or redraw yourthe PDF.
    

    Invalid base64, non-PDF input, non-CII XML or failed rules producereturn a tool error andwith no file;
     rule failureserrors include ids for correction. Use validate_invoice if youids. needFor a findings report.
    Requires a plan key and consumesfindings onereport documentuse onvalidate_invoice. success.Success Returnsreturns a JSON text summary
     (profile, size_bytes, warning 
    count) plusand a base64 PDF/A-3 embedded resource. Requires a plan key; success consumes one document, errors
    consume none. Nothing is stored or sent.
    

 ⟨11 unchanged words⟩ ":{"default":"fr-ctc","description":"Rule set the XML must pass beforevalidation embeddingrules: fr-ctc (default, EN 16931 plusadds French BR-FR-*) or baseto (EN 16931 only). A failed check is a tool error listing the rule ids, not a validation report,16931; andbase nouses PDFEN is16931 returned.only.","enum":["base","fr-ctc"], ⟨18 unchanged words⟩ or en."},"pdf_base64":{"description":"Required. Standard base64 of the visual invoice PDF. After decoding it must be a 

 ⟨14 unchanged words⟩ value.

    Use after validate_invoice or a generate_invoice rule error; thiserror, explainsnot ato findingvalidate butan doesinvoice notitself.
    validate orrule modifyis antrimmed invoice.and Passuppercased theto finding'sselect rulea id,guide notentry. itsmessage/json_pointer prosemust message;come surroundingfrom spacesthat
    are removedsame andfinding: thenonempty idvalues isoverride uppercased.its Passgeneric messagecontext, andbut json_pointernever fromchange the same findingselected tofix retainor
    its specific context: nonemptyexample. valuesOmit overridethem theto guide'suse genericguide messagedefaults andfor suggestedknown field.rules.

    Returns rule, known, json_pointermessage, messagejson_pointer, fix and example (plus problem for aexample; known rule).
    The shortrules guidealso coversinclude selectedproblem.
    Selected BR-FR rules and BR-CO-17/BR-CO-26.BR-CO-17/BR-CO-26 have guidance.
    Unknown ids return known=false
     and example=null, preserving yourwith message/pointer;the thissupplied iscontext, not a validation pass or aan toolerror; error.consult
    Use the original finding rather than inventing a correction.finding. No key or document quota is needed;
    nothing is stored and no external registernothing is called.stored.
    

 ⟨6 unchanged words⟩ null"}],"default":null,"description":"json_pointer from the finding. Used as-isOriginal whenfinding's youjson_pointer sendfield it.path.","title":"Json Pointer"},"message" ⟨4 unchanged words⟩ null"}],"default":null,"description":"TheOriginal findingfinding's message, echoed back when the rule is not in the short guide.text.","title":"Message"},"rule":{"description":"Rule id fromValidation arule findingidentifier, for example BR-FR-01 or BR-CO-26. Required.","title":"Rule","type":"string ⟨6 unchanged words⟩ 

Read an e-invoice and return its business data asExtract JSON:invoice numberparties, dates, seller, buyerlines, totals, and VAT breakdown,as lines.

    UseJSON for bookkeeping, matching or summaries of a received Factur-X PDF, CII or UBL XML. This parses
    embedded/XML data; it does not OCR a scanned PDF, validate rules, repair totals or change the input.
    matching.

    Use validate_invoice for compliance and generate_invoice to create a document.

    Prefer xml for text already available; use document_base64compliance; forthis fileperforms bytesno withoutOCR aor data-URIrecalculation. prefix.
    SendSupply one inputsource: 
    nonblank xml takes precedence if bothoverrides aredocument_base64 supplied.without Leaveinspecting include_xml=falseit, for
    businessso fieldsomit only;xml setto itextract truea whenPDF's
    attachment. youinclude_xml alsoreturns needthat theselected source XML for validationarchiving or archiving.
    The extracted fields arevalidation, not aXML
    reconstructed generate_invoicefrom inputfields. body;Extracted mapfields themneed intomapping thatbefore tool'suse invoiceas schema.generate_invoice input.

    Returns flavor,fields profile,and guideline,format/profile xml_filenamemetadata, fields andplus PDF metadata (null for XML input), plus
    xml whenPDF requested.input. Missing business values 
    remain null andnull; numeric values are strings, not
    recalculated numbers.strings. Missing input, invalid base64, malformed/unrecognized XML 
    or a PDF without
    embedded e-invoiceembedded XML isreturns a tool error, not a successfulan empty extraction. 
    Requires a plan key;
    successful extractionssuccess consumeconsumes one document, errors doconsume not.none. Nothing is stored or sent to recipients.sent.
    

 ⟨6 unchanged words⟩ null"}],"default":null,"description":"Base64Standard base64 of a Factur-X PDF, or of a CII or UBL XML file. Give this or xml. If both are set, nonblank xml is used. Invalid base64 is a tool error. A PDF with no embedded e-invoiceUBL XML is a tool error, not an empty result. Omit both andfile; theno tooldata-URI errors.prefix.","title":"Document Base64"},"include_xml":{"default":false,"description":"When true, the result also includes theInclude rawsource XML text, which can be large. Default false returns onlyin the parsed fieldsresult;

 ⟨22 unchanged words⟩ , 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
     ⟨194 unchanged words⟩ 

 ⟨16 unchanged words⟩ to fix.

    Use on received documents or after a correction;corrections; use extract_invoice to read business data instead.
    Prefer xml for XML already available as text; use document_base64 for PDF or XML filebusiness bytes,data.
    without a data-URI prefix. SendSupply one inputsource: nonblank xml takes precedence if both are supplied.
    The profile is detected from the document, notoverrides selecteddocument_base64 bywithout check.inspecting Chooseit. check=baseTo forcheck ENa 16931PDF's
    only;attachment, theomit defaultxml. fr-ctccheck adds French rules and canto reportthe French-fielddetected omissionsprofile; onit foreigncannot invoices.

    Runschange XSDthat beforeprofile.
    Use schematron;base schemafor failuresnon-French skipinvoices theto lateravoid rules.French-field findings.

    Returns valid, profile, flavor,
    checks_run/checks_skippedvalidity and findings with severity, rule, messageids and json_pointerfield whenpointers available.for explain_finding. XSD failures
    Inspectskip schematron; inspect checks_skipped before treating the reportvalidation as complete;complete. warningsWarnings alone do not make valid false.
    Fix the fields identified in findings, or use explain_finding for guidance. No invoicenot isinvalidate changedan orinvoice. stored.
    Rule failures andor a PDF without embedded XML return valid=false normally.valid=false; Missingmissing input, 
    invalid base64,
    malformed XMLmalformed or unrecognized invoice XML instead return a tool error. 
    Requires a plan key;
    everykey: completed reportreports consumesconsume one document, even valid=false.when Toolinvalid; tool errors do not.
    No invoice is changed, stored or sent.
    

 ⟨2 unchanged words⟩ :{"default":"fr-ctc","description":"fr-ctc (default): EN 16931 plus French CTC rules (BR-FR-*). base: EN 16931 only. A failed rule is a normal result with valid false and findings, not a tool error.","enum":["base","fr-ctc"], ⟨9 unchanged words⟩ null"}],"default":null,"description":"Base64Standard base64 of a Factur-X PDF, or of a CII or UBL XML file. Give this or xml. If both are set, nonblank xml is used. Invalid base64 is a tool error. OmitUBL bothXML andfile; theno tooldata-URI errors.prefix.","title":"Document Base64"},"xml" ⟨7 unchanged words⟩ ,"description":"CII or UBL XML as plainunencoded

 ⟨9 unchanged words⟩  same parties and lines, amounts unchanged.

    Use whenfor thea customerfull wantscredit of an avoirexisting invoice, not for anextracting invoicea youPDF alreadyor generated.validating Noa APIdocument.
    invoice keymust isbe requiredthe original generate_invoice input object, not extract_invoice output.
    number and issue_date belong to the callnew doescredit notnote; countthe asoriginal number/date are copied into
    preceding_invoices. Give number a document.distinct preceding_invoicesvalue isand setuse toYYYY-MM-DD dates. due_date replaces the
    original deadline; omitting it removes that deadline rather than inheriting it.

    All original numberlines, quantities and
    issue dateamounts (BR-FR-06).are Amountsretained, stayso positive;this dodoes not negatecalculate lines.a Apartial documentrefund.
    Keep thatamounts ispositive: alreadytype 381 expresses the credit. Existing credit notes, a reused invoice number
    creditor notenegative isline amounts produce a tool error. CallDefault generate_invoicepayment withremittance references follow the
    new number; a custom reference is preserved. Returns invoice, type_code, preceding_invoice and next.
    Pass the returned invoice to emitgenerate_invoice with the file.original profile to create the document.
    NothingNo key or document quota is stored.needed for drafting; nothing is stored, sent or refunded.
    

 ⟨13 unchanged words⟩ PDF/A-3.

    Use when your system already produced the PDFvisual andinvoice. youFor onlyinvoice needJSON that needs rendering,
    use generate_invoice instead. pdf_base64 must encode the hybridPDF bytes, not a file FrenchURL platformsor accept.data-URI;
    Doxml is unencoded CII text for that same invoice. The tool does not usecompare tothe createvisible anPDF invoiceamounts
    with fromthe dataXML: callensure they agree before embedding. It cannot embed UBL; use generate_invoice, whichfor rendersUBL output.

    check validates the PDFXML, too.not Both
    pdf_base64the andPDF's xmlvisible arecontent: required.choose Invalidbase base64for EN 16931 only, aor filethe thatdefault
    fr-ctc isfor notFrench aadditions. language sets PDF, XMLmetadata; thatit isdoes not CII,translate or XMLredraw your PDF.
    thatInvalid failsbase64, `check`non-PDF areinput, non-CII XML or failed rules produce a tool errors,error and no PDFfile;
    rule isfailures returned.include Aids failedfor checkcorrection. listsUse rulevalidate_invoice ids.if Nothingyou isneed a findings report.
    stored.Requires a plan key and consumes one document on success. Returns a JSON text summary
    (profile, plussize_bytes, thewarning PDF/A-3count) asplus a base64 PDF/A-3 embedded resource. Nothing is stored or sent.
    

 ⟨14 unchanged words⟩ value.

    Use after validate_invoice or a generate_invoice rule error.error; Nothis APIexplains keya isfinding required,but anddoes not
    validate or modify an invoice. Pass the call
    doesfinding's notrule countid, asnot aits document.prose Knownmessage; rulessurrounding spaces
    are removed and the Frenchid BR-FRis checksuppercased. Pass message and BR-CO-17json_pointer /from BR-CO-26the same finding to retain
    describedits inspecific context: nonempty values override the docs.guide's Angeneric unknownmessage and suggested field.

    Returns rule, returnsknown, json_pointer, message, fix and example (plus problem for a known false:rule).
    The keepshort theguide findingcovers messageselected BR-FR rules and BR-CO-17/BR-CO-26. Unknown ids return known=false
    json_pointerand example=null, andpreserving doyour message/pointer; this is not inventa validation pass or a fix.tool Nothingerror.
    Use the original finding rather than inventing a correction. No key or document quota is stored.needed;
    nothing is stored and no external register is called.
    

 ⟨13 unchanged words⟩  buyer, totals, VAT breakdown, lines.

    Use tofor getbookkeeping, thematching contentor summaries of a received Factur-X PDF, CII XML or UBL XMLXML. forThis bookkeepingparses
    embedded/XML data; it does not OCR a scanned PDF, matchingvalidate rules, repair totals or
    summaries. Doeschange notthe judgeinput.
    Use validate_invoice for compliance: calland validate_invoicegenerate_invoice to create a document.

    Prefer xml for that.text Givealready exactlyavailable; use document_base64 for file bytes without a data-URI prefix.
    Send one ofinput: nonblank xml takes precedence if both are supplied. Leave include_xml=false for
    document_base64business fields only; set it true when you also need the source XML for validation or xml.archiving.
    The Sendingextracted neitherfields isare not a toolgenerate_invoice error;input sendingbody; bothmap usesthem xml.into Invalidthat base64tool's invoice schema.

    Returns flavor, aprofile, guideline, xml_filename, fields and PDF
    with nometadata embedded(null e-invoicefor XML input), XMLplus
    xml thatwhen isrequested. Missing business values remain null and numeric values are strings, not
    recalculated well-formednumbers. Missing input, orinvalid base64, malformed/unrecognized XML thator isa notPDF anwithout
    embedded e-invoice XML is a tool
    error. Those cases doerror, not returna ansuccessful empty fields object.extraction. Read-only,Requires nothinga stored.plan Returnskey;
    {profile,successful fields{...}}extractions andconsume one document, witherrors include_xmldo true,not. theNothing XMLis text.stored or sent to recipients.
    

 ⟨24 unchanged words⟩  this or xml. If both are set, nonblank xml is used. Invalid base64 is a tool  ⟨84 unchanged words⟩  If both are set, this value is used.used when nonblank. XML that is not well-formed or not an ⟨16 unchanged words⟩ 

 ⟨53 unchanged words⟩  call validate_invoice;
    to read one, call extract_invoice.

    profile is the ENStart 16931invoice levelfrom writtenget_invoice_example, inreplacing thesample XML:parties en16931and (default),dates. extended,Leave extended-ctc-fr,totals orand basicwl.line
    output isnet_amount facturx-pdfomitted (default,to PDF/A-3compute withthem CIIfrom inside)quantities, cii-xmlprices, or ubl-xml.allowances checkand ischarges. fr-ctcFor (defaultubl-xml,
    EN 16931profile plusmust Frenchbe BR-FR-*)en16931 or base (EN 16931 only); the fileextended-ctc-fr; isextended returnedand onlybasicwl ifare thoseCII/PDF-only. rulesprofile pass.selects
    party_checkthe asksXML EUmodel Verifywhile first.check not_readyselects isvalidation arules: tooluse errorcheck=base namingfor thenon-French field,invoices;
    changing andcheck nodoes filenot isdisable returned.
    languageparty_check. islanguage frand orfooter_text enaffect foronly the visual PDF.

    Omitted footer_textparty_check isenables optionalregistry PDFchecks footeronly text.

    Forfor extended-ctc-fr,extended-ctc-fr; EUtrue/false Verifyexplicitly
    overrides checksthat thedefault. sellerEnabled andchecks buyersend first.party Aidentifiers/address readyand fileseller includesIBAN ato datedEU evidenceVerify.
    id. A registernot_ready outageverdict doesblocks notoutput block.with Thefield invoicepointers. isSuccessful validatedchecks (XSDadd +evidence schematronids;
    registry foroutages `check`)do beforenot it
    isblock returned;generation aand ruleare failurereported listsas idswarnings, suchnot asproof BR-CO-10of orreadiness.
    XSD/business-rule BR-FR-01failures soreturn youa cantool error with rule ids; fix the input and retry.
    Nothing

    Requires isa stored,plan andkey; theeach invoicesuccessful isresult notuses sent.one document, including repeated calls.
    Returns a JSON text summary plus(totals, thewarnings, documentevidence) and an embedded resource: base64 PDF for
    facturx-pdf,or XML texttext. otherwise.No invoice is stored or sent to a recipient.
    

{"idempotentHint":true,"openWorldHint":falsetrue,"readOnlyHint":true}

 ⟨12 unchanged words⟩ and report the fields to fix.

    Use on any documentreceived youdocuments didor notafter producea withcorrection; generate_invoice,use orextract_invoice to re-checkread afterbusiness adata fix.instead.
    Prefer Doxml notfor XML already available as text; use to
    readdocument_base64 thefor invoicePDF content:or callXML extract_invoice.file Givebytes,
    without exactlya data-URI prefix. Send one ofinput: document_base64nonblank orxml xml.takes Sending
    neitherprecedence isif aboth toolare error;supplied.
    The sendingprofile bothis usesdetected xml.from Invalidthe base64document, XMLnot thatselected isby notcheck. well-formed,Choose orcheck=base XMLfor that
    isEN not16931
    only; anthe e-invoicedefault isfr-ctc aadds toolFrench error.rules Runsand XSD,can thenreport theFrench-field ENomissions 16931on schematron,foreign plusinvoices.

    Runs FrenchXSD BR-FR-*before rules
    whenschematron; checkschema isfailures fr-ctc.skip Read-only,the nothinglater stored.rules. Returns {valid, profile, findings[]}. Each finding hasflavor,
    the rulechecks_run/checks_skipped idand (forfindings examplewith BR-CO-10)severity, therule, message, and json_pointer when available.
    Inspect checks_skipped before treating the invoicereport fieldas cancomplete; bewarnings named,
    soalone youdo cannot patchmake thatvalid fieldfalse.
    Fix andthe retry.fields Aidentified non-compliantin documentfindings, includingor use explain_finding for guidance. No invoice is changed or stored.
    Rule failures and a PDF with nowithout embedded XML return valid=false normally. Missing input, invalid base64,
    ismalformed XML or unrecognized invoice XML instead return a normaltool resulterror. withRequires valida falseplan key;
    every completed report consumes one document, noteven anvalid=false. error.Tool errors do not.
    

 ⟨65 unchanged words⟩  this or xml. If both are set, nonblank xml is used. Invalid base64 is a tool  ⟨32 unchanged words⟩  If both are set, this value is used.used when nonblank. Well-formed XML that is not an e-invoice is ⟨9 unchanged words⟩ 

 ⟨18 unchanged words⟩ Use to get the content of a received invoice (Factur-X PDF, CII XML or UBL XML) for bookkeeping, matching
    or or
    summaries. Does not judge compliance: call validate_invoice for that. Give exactly one of
    document_base64 or xml. Sending neither is a tool error; sending both uses xml. Invalid base64, a PDF
    with no embedded e-invoice XML, XML that is not well-formed, or XML that is not an e-invoice is a tool
    error. Those cases do not return an empty fields object. Read-only, nothing stored.
    Returns Returns
    {profile, fields{...}} and, with include_xml true, the XML text.
    

 ⟨6 unchanged words⟩ null"}],"default":null,"description":"Base64 of a Factur-X PDF, (theor embeddedof a CII or UBL XML isfile. read)Give this or xml. If both are set, xml is used. Invalid base64 is a CII/UBLtool error. A PDF with no embedded e-invoice XML fileis a tool error, base64not encodedan empty result. Omit both and the tool errors.","title":"Document Base64"},"include_xml":{"default":false,"description":"AlsoWhen returntrue, the result also includes the raw XML text, (large);which defaultcan be large. Default false returns only the parsed fields (number, dates, parties, totals, VAT, lines).","title":"Include Xml","type": ⟨9 unchanged words⟩ description":"CII or UBL XML as plain text;text. alternativeAlternative to document_base64,: give exactly oneone. If both are set, this value is used. XML that is not well-formed or not an e-invoice is a tool error, not an empty fields object.","title":"Xml"}},"title": ⟨3 unchanged words⟩ 

Generate Factur-Xan EN 16931 invoice

Create aan new,EN compliant16931 e-invoice (from structured data: Factur-X PDF/A-3, CII XML, or UBL XML) from structured invoice2.1 data.XML.

    Use when you have the invoice content (parties, lines, and dates) and need the document. Do not use when you
     already have a 
    visual PDF and a Factur-XCII XML to combine: call embed_xml. To check a document you did not
     create here, call validate_invoice; 
    to read one, call extract_invoice.

    Theprofile resultis the EN 16931 level written in the XML: en16931 (default), extended, extended-ctc-fr, or basicwl.
    output is validatedfacturx-pdf (XSDdefault, +PDF/A-3 schematronwith forCII `check`inside), beforecii-xml, itor ubl-xml. check is returned;fr-ctc on(default,
    EN failure16931 plus French BR-FR-*) or base (EN 16931 only); the toolfile returnsis returned only if those rules pass.
    anparty_check asks EU Verify first. not_ready is a tool error listingnaming the failingfield, and no file is returned.
    language is fr or en for the visual PDF. footer_text is optional PDF footer text.

    For extended-ctc-fr, EU Verify checks the seller and buyer first. A ready file includes a dated evidence
    id. A register outage does not block. The invoice is validated (XSD + schematron for `check`) before it
    is returned; a rule failure lists ids (e.g.such as BR-CO-10, or BR-FR-01) so you can fix the input and retry.
    Nothing is stored.stored, and the invoice is not sent. Returns a text summary (number, totals, warnings) plus the document as an embedded
    resource: base64 PDF for 
    facturx-pdf, XML text for cii-xml / ubl-xml.otherwise.
    

 ⟨3100 unchanged words⟩ }],"default":null,"description":"Optional footer text onprinted in the PDF footer. Omit it for no footer. Ignored for XML-only output.","title":"Footer Text"},"invoice" ⟨41 unchanged words⟩ ":"Language of the visual PDF: fr (default) or enen. Ignored when output is cii-xml or ubl-xml."},"output":{"$ref":"#/$defs/OutputFormat", ⟨4 unchanged words⟩ default): PDF/A-3 with the visual invoice and the CII XML embeddedinside, the formathybrid file French platforms accept. cii-xml: the UN/CEFACT CII XML alone. ubl-xml: UBL 2.1 XML alone (Peppol-style).alone."},"party_check":{"anyOf":[{"type ⟨2 unchanged words⟩ null"}],"default":null,"description":"Check parties withAsk EU Verify whether the seller and buyer are invoice-ready 

Check whether an existing e-invoicea (Factur-X PDF, CII XML or UBL XML) isagainst compliantEN 16931, and report whythe not.fields to fix.

    Use on any document you did not produce with generate_invoice (supplier invoices, files from another
    system) or to re-check after a fix. Do not use to 
    read the invoice content: call extract_invoice. Give exactly one of document_base64 or xml. Sending
    neither is a tool error; sending both uses xml. Invalid base64, XML that is not well-formed, or XML that
    is not an e-invoice is a tool error. Runs XSD, then the EN 16931 schematron, (plus French BR-FR-* rules
    when forcheck fr-ctc).is fr-ctc. Read-only, nothing stored.
     Returns {valid, profile, findings[]} where. eachEach finding has 
    the rule id (e.g.for example BR-CO-10), severitythe message, and json_pointer when the invoice field can be named,
    message;so ayou can patch that field and retry. A non-compliant document, including a PDF with no embedded XML,
    is a normal result with valid false, not an error.
    

 ⟨4 unchanged words⟩ "description":"fr-ctc (default): EN 16931 +plus French CTC rules (BR-FR-*). base: EN 16931 only. A failed rule is a normal result with valid false and findings, not a tool error.","enum":["base","fr-ctc"], ⟨9 unchanged words⟩ null"}],"default":null,"description":"Base64 of a Factur-X PDF, (theor embeddedof a CII or UBL XML isfile. read)Give this or axml. CII/UBLIf XMLboth fileare set, xml is used. Invalid base64 encoded