{ "openapi": "3.0.3", "info": { "title": "beliq API", "description": "beliq is the platform for European e-invoicing: one API to generate, validate, convert and parse e-invoices, with the rule pack, version and check depth on its verdicts. Delivery through beliq is in development; until it is available, transmission (Peppol, plateforme agréée, SDI) and tax-authority reporting stay with your access point. Archiving stays with you, and beliq does not operate KSeF submission.", "version": "0.30.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": { "minimum": 0, "exclusiveMinimum": true, "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" }, "grossPrice": { "minimum": 0, "type": "number" }, "priceDiscount": { "minimum": 0, "type": "number" }, "priceBaseQuantity": { "minimum": 0, "exclusiveMinimum": true, "type": "number" }, "standardItemId": { "additionalProperties": false, "type": "object", "required": [ "id", "schemeId" ], "properties": { "id": { "minLength": 1, "maxLength": 200, "type": "string" }, "schemeId": { "minLength": 1, "maxLength": 10, "type": "string" } } }, "classifications": { "maxItems": 20, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "code", "listId" ], "properties": { "code": { "minLength": 1, "maxLength": 200, "type": "string" }, "listId": { "minLength": 1, "maxLength": 10, "type": "string" }, "listVersionId": { "minLength": 1, "maxLength": 50, "type": "string" } } } }, "originCountryCode": { "minLength": 2, "maxLength": 2, "type": "string" }, "attributes": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "minLength": 1, "maxLength": 200, "type": "string" }, "value": { "minLength": 1, "maxLength": 1000, "type": "string" } } } }, "allowances": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" } } } }, "charges": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" } } } }, "invoicingPeriod": { "additionalProperties": false, "minProperties": 1, "type": "object", "properties": { "startDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "endDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } } }, "subLines": { "maxItems": 200, "description": "Lines nested under this line, at most 64 levels deep with the top-level line as level 1. The 64 is Beliq's own limit, not a format rule. A deeper tree is refused with 422 `VALIDATION_ERROR` before the body is checked against this schema, and no quota unit is spent.", "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", "deliveries" ], "properties": { "keyId": { "type": "string", "nullable": true }, "keyPrefix": { "type": "string", "nullable": true }, "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.", "type": "integer", "nullable": true }, "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" } } }, "deliveries": { "description": "The monthly delivery limit and its count, or null on a test key: test sends count no deliveries. Once usage billing is live, a live delivery past the limit is refused with DELIVERY_LIMIT_REACHED.", "type": "object", "required": [ "limit", "used", "remaining", "resetsAt" ], "properties": { "limit": { "description": "Live deliveries the organization may send in this window: its monthly delivery limit.", "type": "integer" }, "used": { "description": "Live deliveries counted in this window.", "type": "integer" }, "remaining": { "type": "integer" }, "resetsAt": { "description": "ISO 8601 UTC. The end of the window, the same one quota.resetsAt names.", "type": "string" } }, "nullable": true } } }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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 an 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" ] }, { "type": "string", "enum": [ "ksef" ] } ] }, "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" }, "vatPointDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "vatPointDateCode": { "anyOf": [ { "type": "string", "enum": [ "3" ] }, { "type": "string", "enum": [ "35" ] }, { "type": "string", "enum": [ "432" ] } ] }, "invoicingPeriod": { "additionalProperties": false, "minProperties": 1, "type": "object", "properties": { "startDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "endDate": { "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" ] } ] }, "typeCode": { "pattern": "^[0-9]{2,3}$", "type": "string" }, "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" }, "salesOrderReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "contractReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "projectReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "receivingAdviceReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "despatchAdviceReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "tenderReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "invoicedObjectIdentifier": { "additionalProperties": false, "type": "object", "required": [ "id" ], "properties": { "id": { "minLength": 1, "maxLength": 200, "type": "string" }, "schemeId": { "minLength": 1, "maxLength": 10, "type": "string" } } }, "buyerAccountingReference": { "minLength": 1, "maxLength": 200, "type": "string" }, "supportingDocuments": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "id" ], "properties": { "id": { "minLength": 1, "maxLength": 200, "type": "string" }, "description": { "minLength": 1, "maxLength": 1000, "type": "string" }, "externalLocation": { "minLength": 1, "maxLength": 2048, "type": "string" }, "attachment": { "additionalProperties": false, "type": "object", "required": [ "content", "mimeCode", "filename" ], "properties": { "content": { "minLength": 1, "type": "string" }, "mimeCode": { "minLength": 1, "maxLength": 100, "type": "string" }, "filename": { "minLength": 1, "maxLength": 255, "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" } } } } }, "payee": { "additionalProperties": false, "type": "object", "required": [ "name" ], "properties": { "name": { "minLength": 1, "maxLength": 200, "type": "string" }, "identifier": { "additionalProperties": false, "type": "object", "required": [ "id" ], "properties": { "id": { "minLength": 1, "maxLength": 200, "type": "string" }, "schemeId": { "minLength": 1, "maxLength": 10, "type": "string" } } }, "registrationId": { "maxLength": 50, "type": "string" } } }, "taxRepresentative": { "additionalProperties": false, "type": "object", "required": [ "name", "vatId", "address" ], "properties": { "name": { "minLength": 1, "maxLength": 200, "type": "string" }, "vatId": { "maxLength": 20, "pattern": "^[A-Z]{2}[A-Za-z0-9]{2,18}$", "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" } } } } }, "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": { "minimum": 0, "exclusiveMinimum": true, "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" }, "grossPrice": { "minimum": 0, "type": "number" }, "priceDiscount": { "minimum": 0, "type": "number" }, "priceBaseQuantity": { "minimum": 0, "exclusiveMinimum": true, "type": "number" }, "standardItemId": { "additionalProperties": false, "type": "object", "required": [ "id", "schemeId" ], "properties": { "id": { "minLength": 1, "maxLength": 200, "type": "string" }, "schemeId": { "minLength": 1, "maxLength": 10, "type": "string" } } }, "classifications": { "maxItems": 20, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "code", "listId" ], "properties": { "code": { "minLength": 1, "maxLength": 200, "type": "string" }, "listId": { "minLength": 1, "maxLength": 10, "type": "string" }, "listVersionId": { "minLength": 1, "maxLength": 50, "type": "string" } } } }, "originCountryCode": { "minLength": 2, "maxLength": 2, "type": "string" }, "attributes": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "name", "value" ], "properties": { "name": { "minLength": 1, "maxLength": 200, "type": "string" }, "value": { "minLength": 1, "maxLength": 1000, "type": "string" } } } }, "allowances": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" } } } }, "charges": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" } } } }, "invoicingPeriod": { "additionalProperties": false, "minProperties": 1, "type": "object", "properties": { "startDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" }, "endDate": { "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "type": "string" } } }, "subLines": { "maxItems": 200, "description": "Lines nested under this line, at most 64 levels deep with the top-level line as level 1. The 64 is Beliq's own limit, not a format rule. A deeper tree is refused with 422 `VALIDATION_ERROR` before the body is checked against this schema, and no quota unit is spent.", "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" }, "allowances": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount", "vatCategoryCode" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" }, "vatCategoryCode": { "minLength": 1, "maxLength": 10, "type": "string" }, "vatRate": { "minimum": 0, "maximum": 100, "type": "number" } } } }, "charges": { "maxItems": 50, "type": "array", "items": { "additionalProperties": false, "type": "object", "required": [ "amount", "vatCategoryCode" ], "properties": { "amount": { "minimum": 0, "type": "number" }, "baseAmount": { "minimum": 0, "type": "number" }, "percentage": { "minimum": 0, "maximum": 100, "type": "number" }, "reason": { "minLength": 1, "maxLength": 1000, "type": "string" }, "reasonCode": { "minLength": 1, "maxLength": 10, "type": "string" }, "vatCategoryCode": { "minLength": 1, "maxLength": 10, "type": "string" }, "vatRate": { "minimum": 0, "maximum": 100, "type": "number" } } } }, "totalNetAmount": { "type": "number" }, "totalTaxAmount": { "type": "number" }, "totalGrossAmount": { "type": "number" }, "paidAmount": { "type": "number" }, "roundingAmount": { "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": { "type": "string", "enum": [ "I" ] }, "invoiceIssuerType": { "type": "string", "enum": [ "EM" ] }, "invoiceDocumentType": { "type": "string", "enum": [ "FC" ] }, "invoiceClass": { "type": "string", "enum": [ "OO" ] }, "taxTypeCode": { "type": "string", "enum": [ "01" ] }, "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": {} }, "poland": { "additionalProperties": false, "type": "object", "properties": { "adnotacje": { "additionalProperties": false, "type": "object", "properties": { "P_16": { "anyOf": [ { "type": "string", "enum": [ "1" ] }, { "type": "string", "enum": [ "2" ] } ] }, "P_17": { "anyOf": [ { "type": "string", "enum": [ "1" ] }, { "type": "string", "enum": [ "2" ] } ] }, "P_18": { "description": "\"2\" only: beliq does not build the FA(3) structure a \"1\" here requires.", "type": "string", "enum": [ "2" ] }, "P_18A": { "anyOf": [ { "type": "string", "enum": [ "1" ] }, { "type": "string", "enum": [ "2" ] } ] }, "P_23": { "description": "\"2\" only: beliq does not build the FA(3) structure a \"1\" here requires.", "type": "string", "enum": [ "2" ] } } }, "dataWytworzenia": { "minLength": 1, "maxLength": 40, "type": "string" }, "placeOfIssue": { "minLength": 1, "maxLength": 256, "type": "string" }, "jst": { "description": "\"2\" only: beliq does not build the FA(3) structure a \"1\" here requires.", "type": "string", "enum": [ "2" ] }, "gv": { "description": "\"2\" only: beliq does not build the FA(3) structure a \"1\" here requires.", "type": "string", "enum": [ "2" ] } } } } }, "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": "Format of the document: the one the engine detected, or with verify: false, the one the request asked for. One of \"cii\", \"ubl\", \"fatturapa\", \"facturae\", \"eslog\", \"sdi_messaggio\", \"poland_ksef_fa2\", \"poland_ksef_fa3\", \"unknown\"." }, "x-profile-detected": { "schema": { "type": "string" }, "description": "CIUS/profile the engine matched, e.g. \"xrechnung_3.0\". Absent when the label is not printable ASCII; the body still carries it." }, "x-schematron-version": { "schema": { "type": "string" }, "description": "Version of CEN's EN 16931 Schematron, present only where that pack judged the document. Absent for the Factur-X MINIMUM, BASIC WL, BASIC and EXTENDED profiles, whose own pack judges them in its place, and for formats checked against their XSD alone." }, "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\". \"skipped\" with verify: false, where no ruleset ran." }, "x-version-block": { "schema": { "type": "string" }, "description": "Compact JSON naming the ruleset/artifact versions pinned for the produced format." }, "x-ruleset-artifacts": { "schema": { "type": "string" }, "description": "The component rows x-ruleset-sha256 is built from, as a compact JSON array of {key, version, fileSha256} objects. Write each row as a \"@=\" line, sort the lines, join them with newlines, and SHA-256 the result 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 \"visualization\" (rendered pages only, no XML embedded)." }, "x-beliq-idempotent-replay": { "schema": { "type": "string" }, "description": "\"true\" when this request repeats one your organisation sent in the same mode and was charged for in the last 15 minutes: the same route, query, Content-Type, Accept, ruleset selection and body, and for generate the same stored PDF template. The request was computed again and not charged. One charge covers 10 such repeats; the 11th is charged and starts a new 15 minutes. The window, what makes two requests the same and the cap are a choice Beliq made; no standard sets them. Absent when the request was charged." }, "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": "`true` when the document passed the schemas and rule packs the engine ran for its format. `false` when it failed one, and also when none ran: such a result has no `rulesetSha256`, and on `POST /v1/generate` with `verify: false` it carries `verified: false` as well.", "type": "boolean" }, "verified": { "description": "Whether a ruleset actually executed. Set on the verdict of a document beliq built (`POST /v1/generate`): `true` on its 200 and on its 422 `INVALID_INVOICE`, `false` 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" ] } ] }, "verificationBadgeLabel": { "description": "English display text for `verificationBadge`: the label the English coverage cards and the docs show for that badge. Print it as it is. Compare `verificationBadge`, not this string.", "type": "string" }, "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" }, "polandKsefFa3XsdBundle": { "maxLength": 200, "type": "string" }, "polandKsefFa3RuntimeVersion": { "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" }, "rulesetSupersededOn": { "format": "date", "description": "ISO date the authority made the successor of a ruleset this request selected mandatory, when that date is on or before the day of the verdict; the earliest date when several were. Each such ruleset also adds a `RULESET_SUPERSEDED` warning naming it, its version, the successor and the date. Absent when none was. `valid` is still the verdict of the version that ran.", "type": "string" }, "pdfInput": { "description": "Present only when the document sent to `POST /v1/validate` was a PDF: which embedded file the verdict is about, and that the PDF around it was not checked.", "type": "object", "required": [ "containerChecked", "attachmentFoundBy", "attachmentCandidates" ], "properties": { "containerChecked": { "description": "Always `false`. Nothing checked the PDF itself: not its PDF/A conformance, not its XMP metadata, not how the invoice file is attached. The verdict is about the embedded XML only.", "type": "boolean", "enum": [ false ] }, "attachmentName": { "maxLength": 255, "description": "Name of the embedded file whose XML was read, as the PDF states it. Left out when that name is longer than 255 UTF-16 code units, or holds U+0000 or half of a surrogate pair.", "type": "string" }, "attachmentFoundBy": { "description": "How that file was picked. The steps are tried in this order, and a step whose first file cannot be read hands over to the next. `associated-file`: the first entry of the catalog's `/AF` array under a known invoice attachment name. `embedded-file`: the first entry of the `/EmbeddedFiles` name tree under such a name. `xml-content`: the first `*.xml` file whose content starts like an invoice, whatever its name.", "anyOf": [ { "type": "string", "enum": [ "associated-file" ] }, { "type": "string", "enum": [ "embedded-file" ] }, { "type": "string", "enum": [ "xml-content" ] } ] }, "attachmentCandidates": { "minimum": 1, "description": "How many embedded files the step in `attachmentFoundBy` accepts, the one that was read included. Above 1, the PDF holds another file that could be taken for the invoice, and nothing compared the two.", "type": "integer" } } }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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 rule packs and schemas of its format, each pinned by version and hash.", "tags": [ "Documents" ], "description": "The JSON response carries 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, 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, and absent when none did. `rulesetArtifacts` lists the component rows it is built from (`{ key, version, fileSha256 }` each): sort the `\"@=\"` lines, join with newlines, and SHA-256 to reproduce `rulesetSha256` from these published values alone. That reproduction works for every result. Matching each component against the GET /v1/rulesets catalog works for the components it lists: some formats this route accepts run artifacts the catalog leaves out on purpose, so their components do not appear there. `driftCheckedAt` is an ISO 8601 UTC instant reporting when the nightly drift check last confirmed every pinned artifact: where `rulesetSha256` proves the artifact we ran is the one we pin, `driftCheckedAt` says when we last confirmed that pin against its source. A pin is confirmed against its pinned source URL. When the check cannot fetch the file from there and the pin names a mirror, the mirror can stand in. The mirror's file must hash to the pin, after a change of line endings where the pin declares one. A pin can instead declare that its mirror file, which differs in content such as relative schema paths, is compared with our own committed copy: a weaker claim than a match with the pinned hash. A pin confirmed through a mirror is only as current as the mirror: a change at the pinned source URL that the mirror has not copied yet goes unseen. The published drift status at https://docs.beliq.eu/api/drift-status.json names every pin the check confirmed through a mirror, and how. It is a conservative lower bound (\"verified at least as recently as\"), present alongside `rulesetSha256` only when every pinned artifact cleared that check. A query parameter this operation does not declare answers 400 `VALIDATION_ERROR`, and `error.details.fields` names it.", "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": [ "facturae" ] }, { "type": "string", "enum": [ "eslog" ] }, { "type": "string", "enum": [ "sdi_messaggio" ] }, { "type": "string", "enum": [ "poland_ksef_fa2" ] }, { "type": "string", "enum": [ "poland_ksef_fa3" ] } ] }, "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 pins as \":\". GET /v1/rulesets lists artifact keys and their versions, though not for every format this route accepts. The two forms are mutually exclusive. With no header, an API key runs its organisation's default channel, which is \"latest\" unless the organisation set \"previous\" in the dashboard, and every other caller runs \"latest\". Effective on this route only: parse/generate/convert accept but ignore it. The applied selection is echoed in the Beliq-Ruleset-Resolved response header." } ], "responses": { "200": { "description": "Default Response", "headers": { "x-syntax": { "schema": { "type": "string" }, "description": "Format the engine detected: \"cii\", \"ubl\", \"fatturapa\", \"facturae\", \"eslog\", \"sdi_messaggio\", \"poland_ksef_fa2\", \"poland_ksef_fa3\", \"unknown\"." }, "x-profile-detected": { "schema": { "type": "string" }, "description": "CIUS/profile the engine matched, e.g. \"xrechnung_3.0\". Absent when the label is not printable ASCII; the body still carries it." }, "x-schematron-version": { "schema": { "type": "string" }, "description": "Version of CEN's EN 16931 Schematron, present only where that pack judged the document. Absent for the Factur-X MINIMUM, BASIC WL, BASIC and EXTENDED profiles, whose own pack judges them in its place, and for formats checked against their XSD alone." }, "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-ruleset-artifacts": { "schema": { "type": "string" }, "description": "The component rows x-ruleset-sha256 is built from, as a compact JSON array of {key, version, fileSha256} objects. Write each row as a \"@=\" line, sort the lines, join them with newlines, and SHA-256 the result to reproduce the seal from published values alone." }, "beliq-ruleset-resolved": { "schema": { "type": "string" }, "description": "The ruleset selection that actually applied. Set when the request carried a Beliq-Ruleset header, or carried none and the API key's organisation has \"previous\" as its default channel. Reveals a \"previous\"→\"latest\" fallback." }, "x-beliq-idempotent-replay": { "schema": { "type": "string" }, "description": "\"true\" when this request repeats one your organisation sent in the same mode and was charged for in the last 15 minutes: the same route, query, Content-Type, Accept, ruleset selection and body, and for generate the same stored PDF template. The request was computed again and not charged. One charge covers 10 such repeats; the 11th is charged and starts a new 15 minutes. The window, what makes two requests the same and the cap are a choice Beliq made; no standard sets them. Absent when the request was charged." }, "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": "`true` when the document passed the schemas and rule packs the engine ran for its format. `false` when it failed one, and also when none ran: such a result has no `rulesetSha256`, and on `POST /v1/generate` with `verify: false` it carries `verified: false` as well.", "type": "boolean" }, "verified": { "description": "Whether a ruleset actually executed. Set on the verdict of a document beliq built (`POST /v1/generate`): `true` on its 200 and on its 422 `INVALID_INVOICE`, `false` 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" ] } ] }, "verificationBadgeLabel": { "description": "English display text for `verificationBadge`: the label the English coverage cards and the docs show for that badge. Print it as it is. Compare `verificationBadge`, not this string.", "type": "string" }, "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" }, "polandKsefFa3XsdBundle": { "maxLength": 200, "type": "string" }, "polandKsefFa3RuntimeVersion": { "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" }, "rulesetSupersededOn": { "format": "date", "description": "ISO date the authority made the successor of a ruleset this request selected mandatory, when that date is on or before the day of the verdict; the earliest date when several were. Each such ruleset also adds a `RULESET_SUPERSEDED` warning naming it, its version, the successor and the date. Absent when none was. `valid` is still the verdict of the version that ran.", "type": "string" }, "pdfInput": { "description": "Present only when the document sent to `POST /v1/validate` was a PDF: which embedded file the verdict is about, and that the PDF around it was not checked.", "type": "object", "required": [ "containerChecked", "attachmentFoundBy", "attachmentCandidates" ], "properties": { "containerChecked": { "description": "Always `false`. Nothing checked the PDF itself: not its PDF/A conformance, not its XMP metadata, not how the invoice file is attached. The verdict is about the embedded XML only.", "type": "boolean", "enum": [ false ] }, "attachmentName": { "maxLength": 255, "description": "Name of the embedded file whose XML was read, as the PDF states it. Left out when that name is longer than 255 UTF-16 code units, or holds U+0000 or half of a surrogate pair.", "type": "string" }, "attachmentFoundBy": { "description": "How that file was picked. The steps are tried in this order, and a step whose first file cannot be read hands over to the next. `associated-file`: the first entry of the catalog's `/AF` array under a known invoice attachment name. `embedded-file`: the first entry of the `/EmbeddedFiles` name tree under such a name. `xml-content`: the first `*.xml` file whose content starts like an invoice, whatever its name.", "anyOf": [ { "type": "string", "enum": [ "associated-file" ] }, { "type": "string", "enum": [ "embedded-file" ] }, { "type": "string", "enum": [ "xml-content" ] } ] }, "attachmentCandidates": { "minimum": 1, "description": "How many embedded files the step in `attachmentFoundBy` accepts, the one that was read included. Above 1, the PDF holds another file that could be taken for the invoice, and nothing compared the two.", "type": "integer" } } }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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" ], "description": "A query parameter this operation does not declare answers 400 `VALIDATION_ERROR`, and `error.details.fields` names it.", "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": [ "facturae" ] }, { "type": "string", "enum": [ "eslog" ] }, { "type": "string", "enum": [ "sdi_messaggio" ] }, { "type": "string", "enum": [ "poland_ksef_fa2" ] }, { "type": "string", "enum": [ "poland_ksef_fa3" ] } ] }, "in": "query", "name": "format", "required": false, "description": "Checked against the allowed values, otherwise ignored. Detection is always automatic: the syntax is read from the document itself." } ], "responses": { "200": { "description": "Default Response", "headers": { "x-syntax": { "schema": { "type": "string" }, "description": "Syntax of the parsed document: \"cii\" or \"ubl\", the two parse reads." }, "x-profile-detected": { "schema": { "type": "string" }, "description": "CIUS/profile the engine matched, e.g. \"xrechnung_3.0\". Absent when the label is not printable ASCII; the body still carries it." }, "x-schematron-version": { "schema": { "type": "string" }, "description": "Version of CEN's EN 16931 Schematron, present only where that pack judged the document. Absent for the Factur-X MINIMUM, BASIC WL, BASIC and EXTENDED profiles, whose own pack judges them in its place, and for formats checked against their XSD alone." }, "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-idempotent-replay": { "schema": { "type": "string" }, "description": "\"true\" when this request repeats one your organisation sent in the same mode and was charged for in the last 15 minutes: the same route, query, Content-Type, Accept, ruleset selection and body, and for generate the same stored PDF template. The request was computed again and not charged. One charge covers 10 such repeats; the 11th is charged and starts a new 15 minutes. The window, what makes two requests the same and the cap are a choice Beliq made; no standard sets them. Absent when the request was charged." }, "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", "warnings" ], "properties": { "format": { "anyOf": [ { "type": "string", "enum": [ "cii" ] }, { "type": "string", "enum": [ "ubl" ] } ] }, "profileDetected": { "maxLength": 50, "type": "string" }, "profileUrn": { "type": "string" }, "businessProcessId": { "type": "string" }, "franceCtcDetected": { "type": "boolean" }, "invoice": { "additionalProperties": false, "type": "object", "required": [ "lines" ], "properties": { "number": { "type": "string" }, "issueDate": { "type": "string" }, "currencyCode": { "type": "string" }, "documentType": { "anyOf": [ { "type": "string", "enum": [ "invoice" ] }, { "type": "string", "enum": [ "creditnote" ] } ] }, "typeCode": { "type": "string" }, "buyerReference": { "type": "string" }, "seller": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "vatId": { "type": "string" }, "taxId": { "type": "string" }, "address": { "additionalProperties": false, "type": "object", "properties": { "street": { "type": "string" }, "additionalStreet": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } } } }, "buyer": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "vatId": { "type": "string" }, "taxId": { "type": "string" }, "address": { "additionalProperties": false, "type": "object", "properties": { "street": { "type": "string" }, "additionalStreet": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "countryCode": { "type": "string" } } } } }, "lines": { "type": "array", "items": { "additionalProperties": false, "type": "object", "properties": { "description": { "type": "string" }, "quantity": { "type": "number" }, "unitCode": { "type": "string" }, "unitPrice": { "type": "number" }, "lineTotal": { "type": "number" }, "vatRate": { "type": "number" }, "vatCategoryCode": { "type": "string" } } } }, "delivery": { "additionalProperties": false, "type": "object", "properties": { "name": { "type": "string" }, "locationId": { "additionalProperties": false, "type": "object", "required": [ "id" ], "properties": { "schemeId": { "type": "string" }, "id": { "type": "string" } } }, "date": { "type": "string" }, "address": { "additionalProperties": false, "type": "object", "properties": { "street": { "type": "string" }, "additionalStreet": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "countrySubentity": { "type": "string" }, "countryCode": { "type": "string" } } } } }, "totalNetAmount": { "type": "number" }, "totalTaxAmount": { "type": "number" }, "totalGrossAmount": { "type": "number" } } }, "warnings": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "anyOf": [ { "type": "string", "enum": [ "PARSE_NOT_RETURNED" ] }, { "type": "string", "enum": [ "PARSE_VALUE_NOT_FOUND" ] } ] }, "message": { "type": "string" }, "field": { "type": "string" }, "terms": { "type": "array", "items": { "type": "string" } }, "elements": { "type": "array", "items": { "type": "object", "required": [ "path", "count" ], "properties": { "path": { "type": "string" }, "count": { "type": "integer" } } } } } } } } }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": "A 200 means the engine validated the converted XML before it returned it: the document carries the specification identifier of the target format and profile, and it passed the schemas and rule packs the engine runs for that identifier. For `facturx` and `zugferd` at profile `en16931` that is the plain EN 16931 identifier, and the engine names the target profile, so the document is checked against the Factur-X EN 16931 profile schema and FNFE-MPE's profile rules beside CEN's EN 16931 rules. A converted document that fails is a 422 `CONVERSION_OUTPUT_INVALID` with the verdict in `error.details.validationResult`, and is not returned. The 200 itself carries no verdict. A PDF sent for a `facturx` or `zugferd` target comes back as a PDF. When its embedded XML already is the target, the caller's own PDF comes back, with only its annotation flags normalised for PDF/A: that XML was checked and the PDF container was not. Otherwise the engine re-wraps it: the PDF's own invoice files come out, the converted XML goes in as its one invoice file, and the PDF is returned only when veraPDF's PDF/A-3b profile passes it. A PDF the engine cannot re-wrap is a 422 `CONVERSION_UNSUPPORTED_PAIR`, and `error.message` says why. With a test key the PDF is stamped as a sandbox specimen after those checks. The converters between CII and UBL are not checked field by field, so a 200 does not say that every field of the source arrived.\n\nThe `X-Version-Block` response header (compact JSON) names the versions of the rule packs that judged the returned document, read off its verdict as `POST /v1/generate` reads them. It carries no finding and is not the verdict itself. A query parameter this operation does not declare answers 400 `VALIDATION_ERROR`, and `error.details.fields` names it.", "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": "Profile the engine matched on the source, e.g. \"xrechnung\" or \"facturx:basic\". Absent when the source names none the engine knows, or when the label is not printable ASCII." }, "x-lost-elements-count": { "schema": { "type": "string" }, "description": "How many source elements the engine recorded as having no target equivalent. \"0\" means it recorded none. A loss the engine does not detect is not counted: the converters between CII and UBL are not checked field by field." }, "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. When the list would pass the engine's 6 KB header cap, it holds one {\"truncated\": true, \"reason\": ...} entry instead, and x-lost-elements-count stays the exact count." }, "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." }, "x-beliq-idempotent-replay": { "schema": { "type": "string" }, "description": "\"true\" when this request repeats one your organisation sent in the same mode and was charged for in the last 15 minutes: the same route, query, Content-Type, Accept, ruleset selection and body, and for generate the same stored PDF template. The request was computed again and not charged. One charge covers 10 such repeats; the 11th is charged and starts a new 15 minutes. The window, what makes two requests the same and the cap are a choice Beliq made; no standard sets them. Absent when the request was charged." }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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 file Beliq holds for a publicly-supported format, with the SHA-256 of its exact file bytes. A version past its `retainedUntil` stays listed until Beliq removes its files, so a row here is not by itself a version a request can still select. 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’ `\"@=\"` 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. Some formats run real, pinned artifacts that are left out of this catalog on purpose, so their components will not appear here.) 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. Each entry’s `previousChannel` says what `Beliq-Ruleset: previous` resolves to for that format on the UTC day of the request, one row per rule artifact, so you do not have to derive it from the `retained[]` dates: a retained version can be pinnable and still not be what the channel chooses. Each row also carries that artifact's own `retained[]`, which dates an overlay that has no entry of its own.", "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", "verificationBadgeLabel", "releaseDate", "repo", "tag", "retained", "previousChannel" ], "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": { "type": "string", "enum": [ "conformance-verified", "builder-round-trip", "reconstructed-rules", "xsd-structural" ], "nullable": true }, "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" ] } ] }, "verificationBadgeLabel": { "description": "English display text for `verificationBadge`: the label the English coverage cards and the docs show for that badge. Print it as it is. Compare `verificationBadge`, not this string.", "type": "string" }, "releaseDate": { "type": "string", "nullable": true }, "repo": { "type": "string", "nullable": true }, "tag": { "type": "string", "nullable": true }, "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.", "type": "string", "nullable": true }, "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.", "type": "string", "nullable": true }, "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`.", "type": "string", "nullable": true } } } }, "previousChannel": { "description": "What `Beliq-Ruleset: previous` reaches for this format, one row per rule artifact in its run set that retains a version. Empty for a format whose artifacts have never had a breaking bump. A `POST /v1/validate` request on `previous` sets `rulesetFellBack: true` only when EVERY artifact fell back, so this format falls back entirely exactly when no row here has a non-null `previousVersion`. Wider than `retained[]`, which covers only this format's own `versionKey`.", "type": "array", "items": { "type": "object", "required": [ "versionKey", "servingVersion", "previousVersion", "fallbackReason", "retained" ], "properties": { "versionKey": { "description": "The `versions.json` artefact key this row is about. Often this format's own `versionKey`, but not always: an overlay or a severity table that runs under the format's profiles decides its `previous` too, and names no format of its own.", "type": "string" }, "servingVersion": { "description": "The version `latest` serves for this artefact on the UTC day of the request. The other half of the pair to compare against `previousVersion`.", "type": "string" }, "previousVersion": { "description": "The version `Beliq-Ruleset: previous` resolves to for this artefact on the UTC day of the request, or null when the channel falls back to `latest` for it. Pin it exactly as `Beliq-Ruleset: :` to reach it regardless.", "type": "string", "nullable": true }, "fallbackReason": { "description": "Why `previous` reaches nothing for this artefact; null exactly when `previousVersion` is set. `sunset` = every retained version is past its `retainedUntil`, so not even an exact pin resolves. `notice-period` = the only retained version is the one standing in for `latest` until a scheduled bump takes effect, so there is nothing behind it yet. `superseded` = the authority made the successor mandatory, so Beliq will not choose the older ruleset on your behalf; an exact pin still reaches it until `retainedUntil`.", "type": "string", "enum": [ "sunset", "notice-period", "superseded" ], "nullable": true }, "retained": { "description": "The retained versions of this artefact, with the dates that bound each one. For the format's own `versionKey` they are the entry's `retained`. For an overlay or a severity table, which has no entry of its own, this is where its retained version and its `retainedUntil` are published. Repeated under each format the artefact judges.", "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.", "type": "string", "nullable": true }, "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.", "type": "string", "nullable": true }, "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`.", "type": "string", "nullable": true } } } } } } } } } }, "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.", "type": "string", "nullable": true }, "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.", "type": "string", "nullable": true } } } }, "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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": [ "PDFA_VIOLATION" ] }, { "type": "string", "enum": [ "PARSE_FAILED" ] }, { "type": "string", "enum": [ "AUTHENTICATION_REQUIRED" ] }, { "type": "string", "enum": [ "INVALID_API_KEY" ] }, { "type": "string", "enum": [ "INSUFFICIENT_ROLE" ] }, { "type": "string", "enum": [ "QUOTA_EXCEEDED" ] }, { "type": "string", "enum": [ "DOCUMENT_CEILING_REACHED" ] }, { "type": "string", "enum": [ "DELIVERY_LIMIT_REACHED" ] }, { "type": "string", "enum": [ "RATE_LIMITED" ] }, { "type": "string", "enum": [ "ACCOUNT_THROTTLED" ] }, { "type": "string", "enum": [ "ENGINE_UNAVAILABLE" ] }, { "type": "string", "enum": [ "DATABASE_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": [ "CONVERSION_OUTPUT_INVALID" ] }, { "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": [ "LIVE_DELIVERY_UNAVAILABLE" ] }, { "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": [ "RECIPIENT_ADDRESS_INVALID" ] }, { "type": "string", "enum": [ "DOCUMENT_PROFILE_NOT_ACCEPTED" ] }, { "type": "string", "enum": [ "SEND_CANNOT_COMPOSE_FOR_NETWORK" ] }, { "type": "string", "enum": [ "FLOW_OUTSIDE_FRENCH_PERIMETER" ] }, { "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" } ] }