{"openapi":"3.0.3","info":{"title":"beliq API","description":"EU e-invoicing platform. Generate, validate, parse, and convert EN 16931 invoices against authority-pinned, nightly-drift-checked rules. beliq produces and checks the compliant document; transmission (Peppol, plateforme agréée, KSeF, SDI), archiving, and tax-authority reporting stay with your access point.","version":"0.2.0"},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","name":"X-API-Key","in":"header"},"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"InvoiceLine":{"additionalProperties":false,"type":"object","required":["description","quantity","unitCode","unitPrice","lineTotal","vatRate","vatCategoryCode"],"properties":{"description":{"minLength":1,"maxLength":1000,"type":"string"},"quantity":{"exclusiveMinimum":0,"type":"number"},"unitCode":{"minLength":1,"maxLength":10,"type":"string"},"unitPrice":{"minimum":0,"type":"number"},"lineTotal":{"type":"number"},"vatRate":{"minimum":0,"maximum":100,"type":"number"},"vatCategoryCode":{"minLength":1,"maxLength":10,"type":"string"},"itemId":{"maxLength":50,"type":"string"},"buyerItemId":{"maxLength":50,"type":"string"},"subLines":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/InvoiceLine"}}}}}},"paths":{"/v1/me":{"get":{"operationId":"getAccount","summary":"Account, plan, and quota context for the calling API key (no quota cost).","tags":["Account"],"responses":{"200":{"description":"Default Response","headers":{"x-beliq-livemode":{"schema":{"type":"string"},"description":"\"true\" for a live key, \"false\" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota."},"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["keyId","keyPrefix","livemode","org","plan","rateLimitPerMinute","quota"],"properties":{"keyId":{"anyOf":[{"type":"string"},{"type":"null"}]},"keyPrefix":{"anyOf":[{"type":"string"},{"type":"null"}]},"livemode":{"description":"False for a blq_test_ key, true otherwise. Selects which allowance the quota block below describes: a live key spends the plan quota over a window anchored on the organization billing day, a test key the flat sandbox allowance over the UTC calendar month. Mirrors the x-beliq-livemode response header, for callers that only see a parsed body.","type":"boolean"},"org":{"type":"object","required":["id","name","rulesetChannel"],"properties":{"id":{"type":"string"},"name":{"type":"string"},"rulesetChannel":{"anyOf":[{"type":"string","enum":["latest"]},{"type":"string","enum":["previous"]}]}}},"plan":{"type":"object","required":["id","name"],"properties":{"id":{"description":"The subscription_plans row the organization references, or null when it references none, which is every organization on the free tier.","anyOf":[{"type":"integer"},{"type":"null"}]},"name":{"description":"Never null. An organization that references no plan row is on the free tier and reads back under the free tier name.","type":"string"}}},"rateLimitPerMinute":{"type":"number"},"quota":{"type":"object","required":["limit","used","remaining","resetsAt"],"properties":{"limit":{"type":"integer"},"used":{"type":"integer"},"remaining":{"type":"integer"},"resetsAt":{"description":"ISO 8601 UTC. The end of the window limit and used were counted over. On a live key that window is one month anchored on the organization billing day, so only an organization billed on the 1st resets at the turn of the month; on a test key it is the turn of the UTC month.","type":"string"}}}}},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}},"/v1/generate":{"post":{"operationId":"generateInvoice","summary":"Generate a compliant e-invoice from an EN 16931 invoice object.","tags":["Documents"],"description":"Returns the generated file as a raw binary body by default. Binary responses carry the applied ruleset/artifact versions on the `X-Version-Block` header (compact JSON, e.g. `schematronVersion`, `ciusVersion`, `facturxProfile`) and the verifiability seal on `X-Ruleset-Sha256` / `X-Ruleset-Artifacts`. Request `Accept: application/json` to receive a JSON envelope instead: the file base64-encoded in `output`, its SHA-256 in `sha256` (run `sha256sum` on the download to reproduce it), and the ruleset seal in `validationResult`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["standard","output","invoice"],"properties":{"standard":{"anyOf":[{"type":"string","enum":["xrechnung"]},{"type":"string","enum":["zugferd"]},{"type":"string","enum":["facturx"]},{"type":"string","enum":["peppol-bis"]},{"type":"string","enum":["fatturapa"]},{"type":"string","enum":["facturae"]},{"type":"string","enum":["eslog"]}]},"profile":{"anyOf":[{"type":"string","enum":["minimum"]},{"type":"string","enum":["basicwl"]},{"type":"string","enum":["basic"]},{"type":"string","enum":["en16931"]},{"type":"string","enum":["extended"]},{"type":"string","enum":["extended-ctc-fr"]},{"type":"string","enum":["xrechnung"]},{"type":"string","enum":["peppol"]},{"type":"string","enum":["romania-ro-cius"]},{"type":"string","enum":["netherlands-nlcius"]},{"type":"string","enum":["ordinaria"]},{"type":"string","enum":["eracun"]},{"type":"string","enum":["fa3"]}]},"facturxProfile":{"anyOf":[{"type":"string","enum":["minimum"]},{"type":"string","enum":["basicwl"]},{"type":"string","enum":["basic"]},{"type":"string","enum":["en16931"]},{"type":"string","enum":["extended"]},{"type":"string","enum":["extended-ctc-fr"]}]},"output":{"anyOf":[{"type":"string","enum":["xml"]},{"type":"string","enum":["pdf"]}]},"invoice":{"additionalProperties":false,"type":"object","required":["number","issueDate","currencyCode","seller","buyer","lines","totalNetAmount","totalTaxAmount","totalGrossAmount"],"properties":{"number":{"minLength":1,"maxLength":200,"type":"string"},"issueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"dueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"currencyCode":{"minLength":3,"maxLength":3,"type":"string"},"taxCurrencyCode":{"minLength":3,"maxLength":3,"type":"string"},"taxTotalInAccountingCurrency":{"type":"number"},"documentType":{"anyOf":[{"type":"string","enum":["invoice"]},{"type":"string","enum":["creditnote"]}]},"precedingInvoiceReference":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"minLength":1,"maxLength":200,"type":"string"},"issueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}},"buyerReference":{"maxLength":200,"type":"string"},"orderReference":{"maxLength":200,"type":"string"},"note":{"maxLength":5000,"type":"string"},"seller":{"additionalProperties":false,"type":"object","required":["name","address"],"properties":{"name":{"minLength":1,"maxLength":200,"type":"string"},"vatId":{"maxLength":20,"pattern":"^[A-Z]{2}[A-Za-z0-9]{2,18}$","type":"string"},"taxId":{"maxLength":30,"type":"string"},"registrationId":{"maxLength":50,"type":"string"},"email":{"maxLength":254,"format":"email","type":"string"},"phone":{"maxLength":30,"type":"string"},"address":{"additionalProperties":false,"type":"object","required":["city","postalCode","countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"state":{"maxLength":200,"type":"string"},"region":{"minLength":2,"maxLength":3,"type":"string"},"province":{"minLength":2,"maxLength":3,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}},"contactName":{"maxLength":200,"type":"string"},"peppol":{"additionalProperties":false,"type":"object","required":["schemeId","id"],"properties":{"schemeId":{"minLength":4,"maxLength":4,"type":"string"},"id":{"minLength":1,"maxLength":200,"type":"string"}}}}},"buyer":{"additionalProperties":false,"type":"object","required":["name","address"],"properties":{"name":{"minLength":1,"maxLength":200,"type":"string"},"vatId":{"maxLength":20,"pattern":"^[A-Z]{2}[A-Za-z0-9]{2,18}$","type":"string"},"taxId":{"maxLength":30,"type":"string"},"registrationId":{"maxLength":50,"type":"string"},"email":{"maxLength":254,"format":"email","type":"string"},"phone":{"maxLength":30,"type":"string"},"address":{"additionalProperties":false,"type":"object","required":["city","postalCode","countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"state":{"maxLength":200,"type":"string"},"region":{"minLength":2,"maxLength":3,"type":"string"},"province":{"minLength":2,"maxLength":3,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}},"contactName":{"maxLength":200,"type":"string"},"peppol":{"additionalProperties":false,"type":"object","required":["schemeId","id"],"properties":{"schemeId":{"minLength":4,"maxLength":4,"type":"string"},"id":{"minLength":1,"maxLength":200,"type":"string"}}}}},"lines":{"minItems":1,"maxItems":1000,"type":"array","items":{"additionalProperties":false,"type":"object","required":["description","quantity","unitCode","unitPrice","lineTotal","vatRate","vatCategoryCode"],"properties":{"description":{"minLength":1,"maxLength":1000,"type":"string"},"quantity":{"exclusiveMinimum":0,"type":"number"},"unitCode":{"minLength":1,"maxLength":10,"type":"string"},"unitPrice":{"minimum":0,"type":"number"},"lineTotal":{"type":"number"},"vatRate":{"minimum":0,"maximum":100,"type":"number"},"vatCategoryCode":{"minLength":1,"maxLength":10,"type":"string"},"itemId":{"maxLength":50,"type":"string"},"buyerItemId":{"maxLength":50,"type":"string"},"subLines":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/InvoiceLine"}}}}},"taxSummary":{"maxItems":200,"type":"array","items":{"additionalProperties":false,"type":"object","required":["vatCategoryCode","vatRate","taxableAmount","taxAmount"],"properties":{"vatCategoryCode":{"minLength":1,"maxLength":10,"type":"string"},"vatRate":{"minimum":0,"maximum":100,"type":"number"},"taxableAmount":{"type":"number"},"taxAmount":{"type":"number"},"exemptionReasonText":{"maxLength":1000,"type":"string"},"exemptionReasonCode":{"maxLength":100,"type":"string"}}}},"delivery":{"additionalProperties":false,"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"locationId":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"schemeId":{"maxLength":10,"type":"string"},"id":{"maxLength":200,"type":"string"}}},"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"address":{"additionalProperties":false,"type":"object","required":["countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}}}},"paymentMeans":{"additionalProperties":false,"type":"object","required":["typeCode"],"properties":{"typeCode":{"minLength":1,"maxLength":10,"type":"string"},"iban":{"maxLength":34,"type":"string"},"bic":{"maxLength":11,"type":"string"},"bankName":{"maxLength":200,"type":"string"},"paymentReference":{"maxLength":200,"type":"string"},"information":{"maxLength":200,"type":"string"},"mandateReference":{"maxLength":200,"type":"string"},"creditorId":{"maxLength":200,"type":"string"},"debitedAccountId":{"maxLength":34,"type":"string"}}},"paymentTerms":{"maxLength":500,"type":"string"},"totalNetAmount":{"type":"number"},"totalTaxAmount":{"type":"number"},"totalGrossAmount":{"type":"number"},"franceCtc":{"type":"boolean"},"businessProcessId":{"anyOf":[{"type":"string","enum":["S8"]},{"type":"string","enum":["B8"]},{"type":"string","enum":["M8"]}]},"italy":{"additionalProperties":false,"type":"object","properties":{"codiceDestinatario":{"minLength":7,"maxLength":7,"pattern":"^[A-Za-z0-9]{7}$","type":"string"},"regimeFiscale":{"minLength":2,"maxLength":10,"type":"string"},"progressivoInvio":{"minLength":1,"maxLength":10,"type":"string"},"idTrasmittente":{"additionalProperties":false,"type":"object","required":["country","id"],"properties":{"country":{"minLength":2,"maxLength":2,"type":"string"},"id":{"minLength":1,"maxLength":28,"type":"string"}}},"tipoDocumento":{"minLength":2,"maxLength":10,"type":"string"},"condizioniPagamento":{"minLength":2,"maxLength":10,"type":"string"},"modalitaPagamento":{"minLength":2,"maxLength":10,"type":"string"},"esigibilitaIVA":{"minLength":1,"maxLength":5,"type":"string"},"causale":{"maxItems":20,"type":"array","items":{"maxLength":200,"type":"string"}}}},"romania":{"additionalProperties":false,"type":"object","properties":{}},"netherlands":{"additionalProperties":false,"type":"object","properties":{}},"spain":{"additionalProperties":false,"type":"object","properties":{"modality":{"anyOf":[{"type":"string","enum":["I"]},{"type":"string","enum":["L"]}]},"invoiceIssuerType":{"anyOf":[{"type":"string","enum":["EM"]},{"type":"string","enum":["RE"]},{"type":"string","enum":["TE"]}]},"invoiceDocumentType":{"minLength":2,"maxLength":5,"type":"string"},"invoiceClass":{"minLength":2,"maxLength":5,"type":"string"},"taxTypeCode":{"minLength":1,"maxLength":5,"type":"string"},"languageName":{"minLength":2,"maxLength":5,"type":"string"},"batchIdentifier":{"minLength":1,"maxLength":200,"type":"string"},"seller":{"additionalProperties":false,"type":"object","properties":{"personTypeCode":{"anyOf":[{"type":"string","enum":["J"]},{"type":"string","enum":["F"]}]},"residenceTypeCode":{"anyOf":[{"type":"string","enum":["R"]},{"type":"string","enum":["U"]},{"type":"string","enum":["E"]}]}}},"buyer":{"additionalProperties":false,"type":"object","properties":{"personTypeCode":{"anyOf":[{"type":"string","enum":["J"]},{"type":"string","enum":["F"]}]},"residenceTypeCode":{"anyOf":[{"type":"string","enum":["R"]},{"type":"string","enum":["U"]},{"type":"string","enum":["E"]}]}}}}},"slovenia":{"additionalProperties":false,"type":"object","properties":{}}}},"verify":{"type":"boolean"},"template":{"type":"string","enum":["standard"]},"pdfTemplateId":{"pattern":"^[0-9A-Za-z]{3}-[0-9A-Za-z]{3}$","type":"string"}}}}}},"responses":{"200":{"description":"Default Response","headers":{"x-syntax":{"schema":{"type":"string"},"description":"Document syntax the engine detected: \"ubl\" or \"cii\"."},"x-profile-detected":{"schema":{"type":"string"},"description":"CIUS/profile the engine matched, e.g. \"xrechnung_3.0\"."},"x-schematron-version":{"schema":{"type":"string"},"description":"Version of the Schematron ruleset that produced the verdict."},"x-ruleset-sha256":{"schema":{"type":"string"},"description":"SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets)."},"x-validation":{"schema":{"type":"string"},"description":"One-line verdict, e.g. \"pass · 0 err · 1 warn\"."},"x-version-block":{"schema":{"type":"string"},"description":"Compact JSON naming the ruleset/artifact versions pinned for the produced format. Descriptive only; conversion runs no validation over its output."},"x-ruleset-artifacts":{"schema":{"type":"string"},"description":"The component rows x-ruleset-sha256 is built from, as \"<key>@<version>=<fileSha256>\" entries. Sort, join with newlines, and SHA-256 to reproduce the seal from published values alone."},"x-pdf-kind":{"schema":{"type":"string"},"description":"How the returned PDF was built: \"hybrid\" (PDF/A-3 with the XML embedded) or \"visual\" (rendered pages only)."},"x-beliq-livemode":{"schema":{"type":"string"},"description":"\"true\" for a live key, \"false\" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota."},"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/xml":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}},"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["invoiceId","format","standard","profile","validationResult"],"properties":{"invoiceId":{"type":"string"},"format":{"type":"string"},"standard":{"type":"string"},"profile":{"type":"string"},"validationResult":{"type":"object","required":["valid","format","errors","warnings"],"properties":{"valid":{"description":"Whether the document was verified as valid. Read together with `verified`: `valid: false` with `verified: false` means no ruleset ran, not that the document failed.","type":"boolean"},"verified":{"description":"Whether a ruleset actually executed. `false` only when `verify: false` skipped validation, in which case `errors` and `warnings` are empty because nothing looked at the document.","type":"boolean"},"format":{"anyOf":[{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["fatturapa"]},{"type":"string","enum":["facturae"]},{"type":"string","enum":["eslog"]},{"type":"string","enum":["sdi_messaggio"]},{"type":"string","enum":["poland_ksef_fa2"]},{"type":"string","enum":["poland_ksef_fa3"]},{"type":"string","enum":["unknown"]}]},"sha256":{"maxLength":64,"type":"string"},"rulesetSha256":{"maxLength":64,"type":"string"},"rulesetArtifacts":{"type":"array","items":{"type":"object","required":["key","version","fileSha256"],"properties":{"key":{"maxLength":80,"type":"string"},"version":{"maxLength":50,"type":"string"},"fileSha256":{"maxLength":64,"type":"string"}}}},"driftCheckedAt":{"format":"date-time","type":"string"},"profileDetected":{"maxLength":50,"type":"string"},"verificationTier":{"anyOf":[{"type":"string","enum":["conformance-verified"]},{"type":"string","enum":["builder-round-trip"]},{"type":"string","enum":["reconstructed-rules"]},{"type":"string","enum":["xsd-structural"]}]},"verificationBadge":{"anyOf":[{"type":"string","enum":["authority-verified"]},{"type":"string","enum":["independently-rule-checked"]},{"type":"string","enum":["structure-checked"]}]},"schematronVersion":{"maxLength":20,"type":"string"},"ciusVersion":{"maxLength":50,"type":"string"},"peppolVersion":{"maxLength":50,"type":"string"},"facturxProfile":{"maxLength":50,"type":"string"},"facturxVersion":{"maxLength":20,"type":"string"},"franceCtcApplied":{"type":"boolean"},"franceCtcVersion":{"maxLength":20,"type":"string"},"franceExtendedCtcApplied":{"type":"boolean"},"franceCtcBlockingRuleIds":{"maxItems":400,"type":"array","items":{"maxLength":100,"type":"string"}},"italyFatturapaXsdBundle":{"maxLength":200,"type":"string"},"italyFatturapaRuntimeVersion":{"maxLength":40,"type":"string"},"italySdiMessaggiXsdBundle":{"maxLength":200,"type":"string"},"italySdiMessaggiXsdVersion":{"maxLength":40,"type":"string"},"spainFacturaeXsdBundle":{"maxLength":200,"type":"string"},"spainFacturaeRuntimeVersion":{"maxLength":40,"type":"string"},"sloveniaEslogXsdBundle":{"maxLength":200,"type":"string"},"sloveniaEslogRuntimeVersion":{"maxLength":40,"type":"string"},"romaniaRoCiusVersion":{"maxLength":40,"type":"string"},"netherlandsNlciusVersion":{"maxLength":40,"type":"string"},"rulesetChannel":{"anyOf":[{"type":"string","enum":["latest"]},{"type":"string","enum":["previous"]}]},"rulesetFellBack":{"description":"True when `previous` was requested and the format had nothing for the channel to reach, so the request ran what `latest` would have run. Either nothing is retained, or what is retained has been superseded by the authority making its successor mandatory. A superseded version is still reachable by an exact pin. Present only alongside `rulesetChannel`.","type":"boolean"},"rulesetSunsetsOn":{"format":"date","description":"ISO date the retained ruleset serving this request stops being served. Present only when a retained ruleset ran (never on a default request); the earliest date when several ran. After it an exact pin 422s. It bounds the pin, not the channel: `previous` stops reaching the version on this date or on the authority's mandatory date for the successor, whichever comes first.","type":"string"},"errors":{"type":"array","items":{"type":"object","required":["ruleId","severity","message"],"properties":{"ruleId":{"maxLength":100,"type":"string"},"severity":{"anyOf":[{"type":"string","enum":["fatal"]},{"type":"string","enum":["error"]},{"type":"string","enum":["warning"]},{"type":"string","enum":["info"]}]},"location":{"maxLength":500,"type":"string"},"message":{"maxLength":2000,"type":"string"}}}},"warnings":{"type":"array","items":{"type":"object","required":["ruleId","severity","message"],"properties":{"ruleId":{"maxLength":100,"type":"string"},"severity":{"anyOf":[{"type":"string","enum":["fatal"]},{"type":"string","enum":["error"]},{"type":"string","enum":["warning"]},{"type":"string","enum":["info"]}]},"location":{"maxLength":500,"type":"string"},"message":{"maxLength":2000,"type":"string"}}}}}},"output":{"type":"string"},"outputFormat":{"maxLength":8,"type":"string"},"contentType":{"maxLength":64,"type":"string"},"sha256":{"maxLength":64,"type":"string"},"pdfKind":{"maxLength":16,"type":"string"}}},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}},"/v1/validate":{"post":{"operationId":"validateInvoice","summary":"Validate an XML or PDF e-invoice against the authority-pinned rules.","tags":["Documents"],"description":"The JSON response carries two verifiability hashes so you can check the result yourself. `sha256` is the lowercase-hex SHA-256 of the exact bytes you posted; run `sha256sum` on your file to reproduce it and confirm round-trip integrity. `rulesetSha256` fingerprints the rule artifacts the engine ran to judge the document (the compiled Schematron XSLT(s) for the EN 16931 family and its CIUS/national overlays, or the authority root XSD for XSD-only national formats), so you can confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets). `rulesetSha256` is present whenever a ruleset ran. `rulesetArtifacts` lists the component rows it is built from (`{ key, version, fileSha256 }` each): sort the `\"<key>@<version>=<fileSha256>\"` lines, join with newlines, and SHA-256 to reproduce `rulesetSha256` from these published values alone. That reproduction works for every result; the separate step of matching each component against the GET /v1/rulesets catalog covers publicly-supported formats only — a provisional national format (e.g. Italy FatturaPA) returns real, pinned components that are intentionally kept off the public catalog, so they will not appear there. `driftCheckedAt` is an ISO 8601 UTC instant reporting when those pinned artifacts were last confirmed to still match their upstream authority sources (the nightly drift check): where `rulesetSha256` proves the artifact we ran is the one we pin, `driftCheckedAt` says when we last confirmed that pin still matches what the authority publishes. It is a conservative lower bound (\"verified at least as recently as\"), present alongside `rulesetSha256` only when every pinned artifact cleared that check.","requestBody":{"required":true,"content":{"application/xml":{"schema":{}},"text/xml":{"schema":{}},"application/octet-stream":{"schema":{}},"application/pdf":{"schema":{}}}},"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["fatturapa"]},{"type":"string","enum":["sdi_messaggio"]},{"type":"string","enum":["facturae"]},{"type":"string","enum":["eslog"]}]},"in":"query","name":"format","required":false},{"schema":{"type":"boolean"},"in":"query","name":"franceCtc","required":false},{"schema":{"type":"string"},"in":"header","name":"Beliq-Ruleset","required":false,"description":"Pin the validation ruleset for this request. A channel (\"latest\" or \"previous\"), or a comma-separated list of exact per-format pins as \"<artifactKey>:<version>\" (e.g. \"xrechnung_schematron:2.4.0\"). The two forms are mutually exclusive. Default (no header) uses \"latest\". Effective on this route only — parse/generate/convert accept but ignore it. The applied ruleset is echoed in the Beliq-Ruleset-Resolved response header; see GET /v1/rulesets for selectable channels."}],"responses":{"200":{"description":"Default Response","headers":{"x-syntax":{"schema":{"type":"string"},"description":"Document syntax the engine detected: \"ubl\" or \"cii\"."},"x-profile-detected":{"schema":{"type":"string"},"description":"CIUS/profile the engine matched, e.g. \"xrechnung_3.0\"."},"x-schematron-version":{"schema":{"type":"string"},"description":"Version of the Schematron ruleset that produced the verdict."},"x-ruleset-sha256":{"schema":{"type":"string"},"description":"SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets)."},"x-validation":{"schema":{"type":"string"},"description":"One-line verdict, e.g. \"pass · 0 err · 1 warn\"."},"beliq-ruleset-resolved":{"schema":{"type":"string"},"description":"The ruleset selection that actually applied, echoed back when the request carried a Beliq-Ruleset header. Reveals a \"previous\"→\"latest\" fallback."},"x-beliq-livemode":{"schema":{"type":"string"},"description":"\"true\" for a live key, \"false\" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota."},"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["valid","format","errors","warnings"],"properties":{"valid":{"description":"Whether the document was verified as valid. Read together with `verified`: `valid: false` with `verified: false` means no ruleset ran, not that the document failed.","type":"boolean"},"verified":{"description":"Whether a ruleset actually executed. `false` only when `verify: false` skipped validation, in which case `errors` and `warnings` are empty because nothing looked at the document.","type":"boolean"},"format":{"anyOf":[{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["fatturapa"]},{"type":"string","enum":["facturae"]},{"type":"string","enum":["eslog"]},{"type":"string","enum":["sdi_messaggio"]},{"type":"string","enum":["poland_ksef_fa2"]},{"type":"string","enum":["poland_ksef_fa3"]},{"type":"string","enum":["unknown"]}]},"sha256":{"maxLength":64,"type":"string"},"rulesetSha256":{"maxLength":64,"type":"string"},"rulesetArtifacts":{"type":"array","items":{"type":"object","required":["key","version","fileSha256"],"properties":{"key":{"maxLength":80,"type":"string"},"version":{"maxLength":50,"type":"string"},"fileSha256":{"maxLength":64,"type":"string"}}}},"driftCheckedAt":{"format":"date-time","type":"string"},"profileDetected":{"maxLength":50,"type":"string"},"verificationTier":{"anyOf":[{"type":"string","enum":["conformance-verified"]},{"type":"string","enum":["builder-round-trip"]},{"type":"string","enum":["reconstructed-rules"]},{"type":"string","enum":["xsd-structural"]}]},"verificationBadge":{"anyOf":[{"type":"string","enum":["authority-verified"]},{"type":"string","enum":["independently-rule-checked"]},{"type":"string","enum":["structure-checked"]}]},"schematronVersion":{"maxLength":20,"type":"string"},"ciusVersion":{"maxLength":50,"type":"string"},"peppolVersion":{"maxLength":50,"type":"string"},"facturxProfile":{"maxLength":50,"type":"string"},"facturxVersion":{"maxLength":20,"type":"string"},"franceCtcApplied":{"type":"boolean"},"franceCtcVersion":{"maxLength":20,"type":"string"},"franceExtendedCtcApplied":{"type":"boolean"},"franceCtcBlockingRuleIds":{"maxItems":400,"type":"array","items":{"maxLength":100,"type":"string"}},"italyFatturapaXsdBundle":{"maxLength":200,"type":"string"},"italyFatturapaRuntimeVersion":{"maxLength":40,"type":"string"},"italySdiMessaggiXsdBundle":{"maxLength":200,"type":"string"},"italySdiMessaggiXsdVersion":{"maxLength":40,"type":"string"},"spainFacturaeXsdBundle":{"maxLength":200,"type":"string"},"spainFacturaeRuntimeVersion":{"maxLength":40,"type":"string"},"sloveniaEslogXsdBundle":{"maxLength":200,"type":"string"},"sloveniaEslogRuntimeVersion":{"maxLength":40,"type":"string"},"romaniaRoCiusVersion":{"maxLength":40,"type":"string"},"netherlandsNlciusVersion":{"maxLength":40,"type":"string"},"rulesetChannel":{"anyOf":[{"type":"string","enum":["latest"]},{"type":"string","enum":["previous"]}]},"rulesetFellBack":{"description":"True when `previous` was requested and the format had nothing for the channel to reach, so the request ran what `latest` would have run. Either nothing is retained, or what is retained has been superseded by the authority making its successor mandatory. A superseded version is still reachable by an exact pin. Present only alongside `rulesetChannel`.","type":"boolean"},"rulesetSunsetsOn":{"format":"date","description":"ISO date the retained ruleset serving this request stops being served. Present only when a retained ruleset ran (never on a default request); the earliest date when several ran. After it an exact pin 422s. It bounds the pin, not the channel: `previous` stops reaching the version on this date or on the authority's mandatory date for the successor, whichever comes first.","type":"string"},"errors":{"type":"array","items":{"type":"object","required":["ruleId","severity","message"],"properties":{"ruleId":{"maxLength":100,"type":"string"},"severity":{"anyOf":[{"type":"string","enum":["fatal"]},{"type":"string","enum":["error"]},{"type":"string","enum":["warning"]},{"type":"string","enum":["info"]}]},"location":{"maxLength":500,"type":"string"},"message":{"maxLength":2000,"type":"string"}}}},"warnings":{"type":"array","items":{"type":"object","required":["ruleId","severity","message"],"properties":{"ruleId":{"maxLength":100,"type":"string"},"severity":{"anyOf":[{"type":"string","enum":["fatal"]},{"type":"string","enum":["error"]},{"type":"string","enum":["warning"]},{"type":"string","enum":["info"]}]},"location":{"maxLength":500,"type":"string"},"message":{"maxLength":2000,"type":"string"}}}}}},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"415":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}},"/v1/parse":{"post":{"operationId":"parseInvoice","summary":"Parse an XML or PDF e-invoice into a structured invoice object.","tags":["Documents"],"requestBody":{"required":true,"content":{"application/xml":{"schema":{}},"text/xml":{"schema":{}},"application/octet-stream":{"schema":{}},"application/pdf":{"schema":{}}}},"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["fatturapa"]},{"type":"string","enum":["sdi_messaggio"]},{"type":"string","enum":["facturae"]},{"type":"string","enum":["eslog"]}]},"in":"query","name":"format","required":false}],"responses":{"200":{"description":"Default Response","headers":{"x-syntax":{"schema":{"type":"string"},"description":"Document syntax the engine detected: \"ubl\" or \"cii\"."},"x-profile-detected":{"schema":{"type":"string"},"description":"CIUS/profile the engine matched, e.g. \"xrechnung_3.0\"."},"x-schematron-version":{"schema":{"type":"string"},"description":"Version of the Schematron ruleset that produced the verdict."},"x-ruleset-sha256":{"schema":{"type":"string"},"description":"SHA-256 fingerprint of the rule artifacts the engine ran. Reproduce it from x-ruleset-artifacts to confirm the ruleset that judged you is the one beliq publicly pins (see GET /v1/rulesets)."},"x-validation":{"schema":{"type":"string"},"description":"One-line verdict, e.g. \"pass · 0 err · 1 warn\"."},"x-beliq-livemode":{"schema":{"type":"string"},"description":"\"true\" for a live key, \"false\" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota."},"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["format","invoice"],"properties":{"format":{"anyOf":[{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]}]},"profileDetected":{"maxLength":50,"type":"string"},"invoice":{"additionalProperties":false,"type":"object","required":["number","issueDate","currencyCode","seller","buyer","lines","totalNetAmount","totalTaxAmount","totalGrossAmount"],"properties":{"number":{"minLength":1,"maxLength":200,"type":"string"},"issueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"dueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"currencyCode":{"minLength":3,"maxLength":3,"type":"string"},"taxCurrencyCode":{"minLength":3,"maxLength":3,"type":"string"},"taxTotalInAccountingCurrency":{"type":"number"},"documentType":{"anyOf":[{"type":"string","enum":["invoice"]},{"type":"string","enum":["creditnote"]}]},"precedingInvoiceReference":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"minLength":1,"maxLength":200,"type":"string"},"issueDate":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}}},"buyerReference":{"maxLength":200,"type":"string"},"orderReference":{"maxLength":200,"type":"string"},"note":{"maxLength":5000,"type":"string"},"seller":{"additionalProperties":false,"type":"object","required":["name","address"],"properties":{"name":{"minLength":1,"maxLength":200,"type":"string"},"vatId":{"maxLength":20,"pattern":"^[A-Z]{2}[A-Za-z0-9]{2,18}$","type":"string"},"taxId":{"maxLength":30,"type":"string"},"registrationId":{"maxLength":50,"type":"string"},"email":{"maxLength":254,"format":"email","type":"string"},"phone":{"maxLength":30,"type":"string"},"address":{"additionalProperties":false,"type":"object","required":["city","postalCode","countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"state":{"maxLength":200,"type":"string"},"region":{"minLength":2,"maxLength":3,"type":"string"},"province":{"minLength":2,"maxLength":3,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}},"contactName":{"maxLength":200,"type":"string"},"peppol":{"additionalProperties":false,"type":"object","required":["schemeId","id"],"properties":{"schemeId":{"minLength":4,"maxLength":4,"type":"string"},"id":{"minLength":1,"maxLength":200,"type":"string"}}}}},"buyer":{"additionalProperties":false,"type":"object","required":["name","address"],"properties":{"name":{"minLength":1,"maxLength":200,"type":"string"},"vatId":{"maxLength":20,"pattern":"^[A-Z]{2}[A-Za-z0-9]{2,18}$","type":"string"},"taxId":{"maxLength":30,"type":"string"},"registrationId":{"maxLength":50,"type":"string"},"email":{"maxLength":254,"format":"email","type":"string"},"phone":{"maxLength":30,"type":"string"},"address":{"additionalProperties":false,"type":"object","required":["city","postalCode","countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"state":{"maxLength":200,"type":"string"},"region":{"minLength":2,"maxLength":3,"type":"string"},"province":{"minLength":2,"maxLength":3,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}},"contactName":{"maxLength":200,"type":"string"},"peppol":{"additionalProperties":false,"type":"object","required":["schemeId","id"],"properties":{"schemeId":{"minLength":4,"maxLength":4,"type":"string"},"id":{"minLength":1,"maxLength":200,"type":"string"}}}}},"lines":{"minItems":1,"maxItems":1000,"type":"array","items":{"additionalProperties":false,"type":"object","required":["description","quantity","unitCode","unitPrice","lineTotal","vatRate","vatCategoryCode"],"properties":{"description":{"minLength":1,"maxLength":1000,"type":"string"},"quantity":{"exclusiveMinimum":0,"type":"number"},"unitCode":{"minLength":1,"maxLength":10,"type":"string"},"unitPrice":{"minimum":0,"type":"number"},"lineTotal":{"type":"number"},"vatRate":{"minimum":0,"maximum":100,"type":"number"},"vatCategoryCode":{"minLength":1,"maxLength":10,"type":"string"},"itemId":{"maxLength":50,"type":"string"},"buyerItemId":{"maxLength":50,"type":"string"},"subLines":{"maxItems":200,"type":"array","items":{"$ref":"#/components/schemas/InvoiceLine"}}}}},"taxSummary":{"maxItems":200,"type":"array","items":{"additionalProperties":false,"type":"object","required":["vatCategoryCode","vatRate","taxableAmount","taxAmount"],"properties":{"vatCategoryCode":{"minLength":1,"maxLength":10,"type":"string"},"vatRate":{"minimum":0,"maximum":100,"type":"number"},"taxableAmount":{"type":"number"},"taxAmount":{"type":"number"},"exemptionReasonText":{"maxLength":1000,"type":"string"},"exemptionReasonCode":{"maxLength":100,"type":"string"}}}},"delivery":{"additionalProperties":false,"type":"object","properties":{"name":{"maxLength":200,"type":"string"},"locationId":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"schemeId":{"maxLength":10,"type":"string"},"id":{"maxLength":200,"type":"string"}}},"date":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"},"address":{"additionalProperties":false,"type":"object","required":["countryCode"],"properties":{"street":{"maxLength":500,"type":"string"},"additionalStreet":{"maxLength":500,"type":"string"},"city":{"maxLength":200,"type":"string"},"postalCode":{"maxLength":20,"type":"string"},"countryCode":{"minLength":2,"maxLength":2,"type":"string"},"countrySubentity":{"maxLength":10,"type":"string"}}}}},"paymentMeans":{"additionalProperties":false,"type":"object","required":["typeCode"],"properties":{"typeCode":{"minLength":1,"maxLength":10,"type":"string"},"iban":{"maxLength":34,"type":"string"},"bic":{"maxLength":11,"type":"string"},"bankName":{"maxLength":200,"type":"string"},"paymentReference":{"maxLength":200,"type":"string"},"information":{"maxLength":200,"type":"string"},"mandateReference":{"maxLength":200,"type":"string"},"creditorId":{"maxLength":200,"type":"string"},"debitedAccountId":{"maxLength":34,"type":"string"}}},"paymentTerms":{"maxLength":500,"type":"string"},"totalNetAmount":{"type":"number"},"totalTaxAmount":{"type":"number"},"totalGrossAmount":{"type":"number"},"franceCtc":{"type":"boolean"},"businessProcessId":{"anyOf":[{"type":"string","enum":["S8"]},{"type":"string","enum":["B8"]},{"type":"string","enum":["M8"]}]},"italy":{"additionalProperties":false,"type":"object","properties":{"codiceDestinatario":{"minLength":7,"maxLength":7,"pattern":"^[A-Za-z0-9]{7}$","type":"string"},"regimeFiscale":{"minLength":2,"maxLength":10,"type":"string"},"progressivoInvio":{"minLength":1,"maxLength":10,"type":"string"},"idTrasmittente":{"additionalProperties":false,"type":"object","required":["country","id"],"properties":{"country":{"minLength":2,"maxLength":2,"type":"string"},"id":{"minLength":1,"maxLength":28,"type":"string"}}},"tipoDocumento":{"minLength":2,"maxLength":10,"type":"string"},"condizioniPagamento":{"minLength":2,"maxLength":10,"type":"string"},"modalitaPagamento":{"minLength":2,"maxLength":10,"type":"string"},"esigibilitaIVA":{"minLength":1,"maxLength":5,"type":"string"},"causale":{"maxItems":20,"type":"array","items":{"maxLength":200,"type":"string"}}}},"romania":{"additionalProperties":false,"type":"object","properties":{}},"netherlands":{"additionalProperties":false,"type":"object","properties":{}},"spain":{"additionalProperties":false,"type":"object","properties":{"modality":{"anyOf":[{"type":"string","enum":["I"]},{"type":"string","enum":["L"]}]},"invoiceIssuerType":{"anyOf":[{"type":"string","enum":["EM"]},{"type":"string","enum":["RE"]},{"type":"string","enum":["TE"]}]},"invoiceDocumentType":{"minLength":2,"maxLength":5,"type":"string"},"invoiceClass":{"minLength":2,"maxLength":5,"type":"string"},"taxTypeCode":{"minLength":1,"maxLength":5,"type":"string"},"languageName":{"minLength":2,"maxLength":5,"type":"string"},"batchIdentifier":{"minLength":1,"maxLength":200,"type":"string"},"seller":{"additionalProperties":false,"type":"object","properties":{"personTypeCode":{"anyOf":[{"type":"string","enum":["J"]},{"type":"string","enum":["F"]}]},"residenceTypeCode":{"anyOf":[{"type":"string","enum":["R"]},{"type":"string","enum":["U"]},{"type":"string","enum":["E"]}]}}},"buyer":{"additionalProperties":false,"type":"object","properties":{"personTypeCode":{"anyOf":[{"type":"string","enum":["J"]},{"type":"string","enum":["F"]}]},"residenceTypeCode":{"anyOf":[{"type":"string","enum":["R"]},{"type":"string","enum":["U"]},{"type":"string","enum":["E"]}]}}}}},"slovenia":{"additionalProperties":false,"type":"object","properties":{}}}}}},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"415":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}},"/v1/convert":{"post":{"operationId":"convertInvoice","summary":"Convert an e-invoice between formats within the EN 16931 family.","tags":["Documents"],"description":"The `X-Version-Block` response header (compact JSON) names the ruleset/artifact versions this engine build pins for the produced target format. It is descriptive (convert runs no validation over its output) and mirrors the data published by `GET /v1/rulesets`.","requestBody":{"required":true,"content":{"application/xml":{"schema":{}},"text/xml":{"schema":{}},"application/octet-stream":{"schema":{}},"application/pdf":{"schema":{}}}},"parameters":[{"schema":{"anyOf":[{"type":"string","enum":["auto"]},{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["zugferd"]},{"type":"string","enum":["facturx"]},{"type":"string","enum":["xrechnung"]},{"type":"string","enum":["peppol-bis"]}]},"in":"query","name":"sourceFormat","required":false},{"schema":{"anyOf":[{"type":"string","enum":["cii"]},{"type":"string","enum":["ubl"]},{"type":"string","enum":["zugferd"]},{"type":"string","enum":["facturx"]},{"type":"string","enum":["xrechnung"]},{"type":"string","enum":["peppol-bis"]}]},"in":"query","name":"targetFormat","required":true},{"schema":{"anyOf":[{"type":"string","enum":["minimum"]},{"type":"string","enum":["basicwl"]},{"type":"string","enum":["basic"]},{"type":"string","enum":["en16931"]},{"type":"string","enum":["extended"]},{"type":"string","enum":["extended-ctc-fr"]}]},"in":"query","name":"targetProfile","required":false},{"schema":{"type":"boolean"},"in":"query","name":"dropFranceCtcOverlay","required":false}],"responses":{"200":{"description":"Default Response","headers":{"x-source-format":{"schema":{"type":"string"},"description":"Format the engine read."},"x-target-format":{"schema":{"type":"string"},"description":"Format the engine produced."},"x-profile-detected":{"schema":{"type":"string"},"description":"CIUS/profile the engine matched, e.g. \"xrechnung_3.0\"."},"x-lost-elements-count":{"schema":{"type":"string"},"description":"How many source elements had no target equivalent. \"0\" means the conversion was lossless at the element level."},"x-lost-elements":{"schema":{"type":"string"},"description":"JSON array naming the source elements that had no target equivalent, so a caller can decide whether the loss matters for their use."},"x-conversion-tools":{"schema":{"type":"string"},"description":"Toolchain that performed the conversion, for audit purposes."},"x-output-envelope":{"schema":{"type":"string"},"description":"Envelope the produced document is wrapped in, when it has one."},"x-version-block":{"schema":{"type":"string"},"description":"Compact JSON naming the ruleset/artifact versions pinned for the produced format. Descriptive only; conversion runs no validation over its output."},"x-beliq-livemode":{"schema":{"type":"string"},"description":"\"true\" for a live key, \"false\" for a test key. Test-mode documents are watermarked and do not draw on the live monthly quota."},"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/xml":{"schema":{"type":"string","format":"binary"}},"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"401":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"403":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"413":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"415":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"422":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"500":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"503":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}},"/v1/rulesets":{"get":{"operationId":"getRulesets","summary":"Active ruleset/artefact versions + ruleset-hash catalog per supported format (public, no quota cost).","tags":["Reference"],"description":"Public reference for the ruleset versions and artifact hashes Beliq pins. `artifacts` is the ruleset-hash catalog: each rule artifact that can run for a publicly-supported format, with the SHA-256 of its exact file bytes. To verify a `POST /v1/validate` response for a publicly-supported format, confirm each of its `rulesetArtifacts` components appears here, then reproduce its `rulesetSha256` by sorting the components’ `\"<key>@<version>=<fileSha256>\"` lines, joining with newlines, and taking the SHA-256. (The `rulesetSha256` reproduction needs only the response’s own components, so it holds for any result. Formats beliq carries on no public surface run real, pinned artifacts that are intentionally omitted here, so their components will not appear in this catalog.) For compiled-Schematron families the published hash proves the artifact Beliq ran is the one Beliq pins, not a value reproducible from the authority’s raw source. `scheduledChanges` lists announced bumps that have not taken effect yet; each row names both the `formats` and the `capabilities` the changing artifact judges, and a bump can reach you through a capability alone.","security":[],"responses":{"200":{"description":"Default Response","headers":{"x-request-id":{"schema":{"type":"string"},"description":"Correlation id for this request. Quote it in a support request; it is the key the API, the engine, and error tracking all record."}},"content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean"},"data":{"type":"object","required":["rulesets","channels","scheduledChanges","artifacts"],"properties":{"rulesets":{"type":"array","items":{"type":"object","required":["format","label","standard","authority","region","specVersion","rulesetVersion","rulesetArtefact","versionKey","verificationTier","rulesProvenance","verificationBadge","releaseDate","repo","tag","retained"],"properties":{"format":{"type":"string"},"label":{"type":"string"},"standard":{"type":"string"},"authority":{"type":"string"},"region":{"type":"string"},"specVersion":{"type":"string"},"rulesetVersion":{"type":"string"},"rulesetArtefact":{"type":"string"},"versionKey":{"type":"string"},"verificationTier":{"anyOf":[{"type":"string","enum":["conformance-verified"]},{"type":"string","enum":["builder-round-trip"]},{"type":"string","enum":["reconstructed-rules"]},{"type":"string","enum":["xsd-structural"]},{"type":"null"}]},"rulesProvenance":{"anyOf":[{"type":"string","enum":["authority-conformance"]},{"type":"string","enum":["authority-artifact"]},{"type":"string","enum":["community"]},{"type":"string","enum":["beliq-authored"]},{"type":"string","enum":["none"]}]},"verificationBadge":{"anyOf":[{"type":"string","enum":["authority-verified"]},{"type":"string","enum":["independently-rule-checked"]},{"type":"string","enum":["structure-checked"]}]},"releaseDate":{"anyOf":[{"type":"string"},{"type":"null"}]},"repo":{"anyOf":[{"type":"string"},{"type":"null"}]},"tag":{"anyOf":[{"type":"string"},{"type":"null"}]},"retained":{"description":"Versions of this format's artefact still on disk but no longer served, oldest first. Empty for a format whose artefact has never had a breaking bump, and empty for one inside a notice period, where the outgoing release is still what `rulesetVersion` names.","type":"array","items":{"type":"object","required":["version","releaseDate","servingFrom","retainedUntil","supersededMandatoryOn"],"properties":{"version":{"type":"string"},"releaseDate":{"description":"ISO 8601 date (YYYY-MM-DD) the authority released this version, or null when it publishes none.","anyOf":[{"type":"string"},{"type":"null"}]},"servingFrom":{"description":"ISO 8601 date (YYYY-MM-DD) Beliq started serving this version as `latest`.","type":"string"},"retainedUntil":{"description":"ISO 8601 date (YYYY-MM-DD) after which this version is no longer served at all, or null when nothing retires it. The last day an exact pin resolves; after it, the pin returns a 422.","anyOf":[{"type":"string"},{"type":"null"}]},"supersededMandatoryOn":{"description":"ISO 8601 date (YYYY-MM-DD) the authority made this version's successor mandatory, or null when it published no date. Once it has passed, `Beliq-Ruleset: previous` no longer resolves to this version and sets `rulesetFellBack: true`, because a document built to it is rejected by the receiving corner. An exact version pin is unaffected and still reaches it until `retainedUntil`.","anyOf":[{"type":"string"},{"type":"null"}]}}}}}}},"channels":{"type":"array","items":{"type":"object","required":["id","label","description"],"properties":{"id":{"anyOf":[{"type":"string","enum":["latest"]},{"type":"string","enum":["previous"]}]},"label":{"type":"string"},"description":{"type":"string"}}}},"scheduledChanges":{"type":"array","items":{"type":"object","required":["versionKey","formats","capabilities","from","to","effectiveOn","noticePublishedOn","retiredOn"],"properties":{"versionKey":{"type":"string"},"formats":{"type":"array","items":{"type":"string"}},"capabilities":{"type":"array","items":{"type":"string"}},"from":{"type":"string"},"to":{"type":"string"},"effectiveOn":{"description":"ISO 8601 date (YYYY-MM-DD). When `latest` moves from `from` to `to`.","type":"string"},"noticePublishedOn":{"description":"ISO 8601 date (YYYY-MM-DD) the change was announced in the public ruleset changelog, or null when it has not been recorded yet.","anyOf":[{"type":"string"},{"type":"null"}]},"retiredOn":{"description":"ISO 8601 date (YYYY-MM-DD) after which `from` is no longer served at all, or null when nothing retires it. Later than `effectiveOn`, and the date to act on: it is when an exact pin on `from` starts returning a 422. It does not bound the `previous` channel, which stops resolving to `from` on this date or on the authority's mandatory date for `to`, whichever comes first.","anyOf":[{"type":"string"},{"type":"null"}]}}}},"artifacts":{"type":"array","items":{"type":"object","required":["key","version","fileSha256"],"properties":{"key":{"maxLength":80,"type":"string"},"version":{"maxLength":50,"type":"string"},"fileSha256":{"maxLength":64,"type":"string"}}}}}},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}},"429":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false]},"error":{"type":"object","required":["code","message"],"properties":{"code":{"anyOf":[{"type":"string","enum":["VALIDATION_ERROR"]},{"type":"string","enum":["INVALID_INVOICE"]},{"type":"string","enum":["PROFILE_STANDARD_MISMATCH"]},{"type":"string","enum":["DOCUMENT_TYPE_STANDARD_MISMATCH"]},{"type":"string","enum":["PARSE_FAILED"]},{"type":"string","enum":["AUTHENTICATION_REQUIRED"]},{"type":"string","enum":["INVALID_API_KEY"]},{"type":"string","enum":["QUOTA_EXCEEDED"]},{"type":"string","enum":["RATE_LIMITED"]},{"type":"string","enum":["ACCOUNT_THROTTLED"]},{"type":"string","enum":["ENGINE_UNAVAILABLE"]},{"type":"string","enum":["INTERNAL_ERROR"]},{"type":"string","enum":["NOT_FOUND"]},{"type":"string","enum":["CONVERSION_UNSUPPORTED_PAIR"]},{"type":"string","enum":["CONVERSION_LOSSY_FAILCLOSED"]},{"type":"string","enum":["CONVERSION_TOOL_UNAVAILABLE"]},{"type":"string","enum":["CONVERSION_TOOL_ERROR"]},{"type":"string","enum":["PDF_TEMPLATE_AUTH_REQUIRED"]},{"type":"string","enum":["PDF_TEMPLATE_NOT_FOUND"]},{"type":"string","enum":["PDF_TEMPLATE_INVALID"]},{"type":"string","enum":["TRANSMISSION_DISABLED"]},{"type":"string","enum":["TRANSMISSION_NO_PROVIDER"]},{"type":"string","enum":["IDEMPOTENCY_KEY_REUSED"]},{"type":"string","enum":["INVALID_IDEMPOTENCY_KEY"]},{"type":"string","enum":["SENDER_NOT_REGISTERED"]},{"type":"string","enum":["CONTENT_ALREADY_SENT"]},{"type":"string","enum":["INBOX_UNKNOWN_PROVIDER"]},{"type":"string","enum":["INBOX_VERIFICATION_FAILED"]},{"type":"string","enum":["INBOX_SIGNATURE_EXPIRED"]},{"type":"string","enum":["ENROLLMENT_MODE_UNSUPPORTED"]},{"type":"string","enum":["ENROLLMENT_REFUSED"]},{"type":"string","enum":["RECIPIENT_NOT_ROUTABLE"]},{"type":"string","enum":["SENDER_COUNTRY_MISSING"]},{"type":"string","enum":["DOCUMENT_PARTY_MISMATCH"]},{"type":"string","enum":["FRENCH_DOMESTIC_FLOW"]},{"type":"string","enum":["FRANCE_CTC_BLOCKING_FINDINGS"]},{"type":"string","enum":["FRANCE_CTC_NOT_JUDGED"]},{"type":"string","enum":["FRANCE_INVOICE_NUMBER_BURNED"]},{"type":"string","enum":["UNSUPPORTED_SYNTAX"]},{"type":"string","enum":["MALFORMED_DOCUMENT"]},{"type":"string","enum":["EMPTY_DOCUMENT"]},{"type":"string","enum":["MISSING_CUSTOMIZATION_ID"]},{"type":"string","enum":["MISSING_PROCESS_ID"]}]},"message":{"type":"string"},"details":{"type":"object","additionalProperties":{}},"incidentId":{"maxLength":20,"description":"Support correlation ID, present on 5xx responses only. Quote it when contacting support.","type":"string"}}}}}}}}}}}},"servers":[{"url":"https://api.beliq.eu"}],"security":[{"apiKey":[]},{"bearerAuth":[]}],"tags":[{"name":"Documents","description":"Generate, validate, parse, and convert e-invoice documents."},{"name":"Account","description":"Account, plan, and quota context for the calling API key."},{"name":"Reference","description":"Read-only reference data: the ruleset/artefact versions beliq validates and generates against. Public, no API key required."}],"x-providerName":"beliq.eu","x-logo":{"url":"https://beliq.eu/beliq-logo-3ring-only.svg","backgroundColor":"#FFFFFF"},"x-apisguru-categories":["financial"],"x-origin":[{"format":"openapi","version":"3.0","url":"https://api.beliq.eu/openapi.json"}]}