invoicexml-com Invoice Xml.Api API

openapi: 3.2.0
info:
  title: InvoiceXML Invoice Xml.Api API
  description: 'EN 16931 e-invoicing service: create, convert, render, extract, validate. All `/v1/create/*` invoice endpoints accept the `CreateInvoiceRequest` envelope (`{ invoice, options }`); the Order-X endpoints `/v1/create/cio` (raw Cross-Industry Order XML) and `/v1/create/order-x` (hybrid PDF/A-3) accept the `CreateOrderRequest` envelope (`{ order, options }`). Every `/v1/validate/*` endpoint has a `/report` sibling that runs the same validation but responds with a printable PDF report (`application/pdf`); the verdict also travels in the `X-Invoice-Valid` response header so callers can branch without parsing the PDF. Errors follow RFC 7807 ProblemDetails with a machine-readable `errorCode` extension (see `x-error-codes` on the document root).'
  version: 1.0.0
servers:
- url: https://api.invoicexml.com
tags:
- name: InvoiceXml.Api
paths:
  /robots.txt:
    get:
      tags:
      - InvoiceXml.Api
      responses:
        '200':
          description: OK
      summary: Get robots txt
      x-summary-source: derived
      operationId: getRobotsTxt
      x-operation-id-source: derived
x-error-codes:
- code: 4000
  name: Unknown
  description: Catch-all server error not covered by a more specific code.
- code: 4001
  name: XmlValidation
  description: Generated XML failed EN 16931 / Schematron validation (see the findings in `errors` and `warnings`).
- code: 4002
  name: ModelValidation
  description: Request body / form payload failed MVC validation (missing or invalid fields).
- code: 4003
  name: MissingFile
  description: Multipart endpoint expected a file but none was provided.
- code: 4004
  name: UnsupportedContentType
  description: Uploaded file's content-type or extension wasn't acceptable for the endpoint.
- code: 4005
  name: FileTooLarge
  description: Upload exceeded the per-file size limit, or a PDF that becomes the visual layer of a hybrid PDF (the /v1/embed upload, a pdfUrl, a /v1/transform upload kept with preserveOriginalPdf) has more than 100 pages.
- code: 4006
  name: NoEmbeddedXml
  description: PDF didn't contain an embedded ZUGFeRD/Factur-X XML attachment.
- code: 4007
  name: PdfError
  description: Failure during PDF processing (corruption, encryption, or rendering pipeline).
- code: 4008
  name: NotAnInvoice
  description: Document was classified as not being an invoice (AI extraction pre-flight).
- code: 4009
  name: MultipleInvoices
  description: Uploaded PDF appears to contain multiple invoices; submit one per request.
- code: 4010
  name: Unauthorized
  description: Bearer token missing or invalid.
- code: 4011
  name: RemoteFetchError
  description: A caller-supplied pdfUrl or logoUrl could not be fetched (invalid or blocked URL, or unreachable host). Content that is not a PDF / PNG / JPEG uses 4004, an oversized file 4005.
- code: 4012
  name: UnsupportedZugferdCode
  description: 'Historical (no longer emitted): earlier releases rejected unit-of-measure (BT-130) or payment-means (BT-81) codes the ZUGFeRD packaging library could not represent. The embedded XML now carries all codes verbatim.'
- code: 4013
  name: NoAttachments
  description: The invoice carries no embedded attachments (BG-24 with a BT-125 payload). Documents referenced only by external URI (BT-124) are not downloaded.
- code: 4014
  name: InvalidAttachment
  description: An embedded attachment (BT-125) could not be base64-decoded; the invoice XML carries a corrupt payload.
- code: 4015
  name: UnembeddableFont
  description: The supplied PDF uses fonts with no embedded font program that cannot be embedded automatically; PDF/A-3 requires embedded fonts. Re-export the PDF with fonts embedded.
- code: 4016
  name: RemoteFetchForbidden
  description: The server hosting a caller-supplied pdfUrl or logoUrl answered HTTP 403 (typically a firewall / WAF blocking server-to-server requests). Allowlist your PDF URL fetch token, shown on your account's authentication page, in the WAF protecting the file host.
- code: 4017
  name: UnsupportedZugferdProfile
  description: The invoice's Specification identifier (BT-24) is not one of the profile URNs the ZUGFeRD/Factur-X specification defines, so no compliant hybrid PDF can be produced. Declare an official profile URN, for example `urn:cen.eu:en16931:2017` (EN 16931) or `urn:cen.eu:en16931:2017#conformant#urn:factur-x.eu:1p0:extended` (EXTENDED).
- code: 4018
  name: UnsupportedOrderXProfile
  description: The order's guideline identifier is not one of the profile URNs the Order-X 1.0 specification defines, so no compliant hybrid PDF can be produced. Declare `urn:order-x.eu:1p0:basic`, `urn:order-x.eu:1p0:comfort` or `urn:order-x.eu:1p0:extended`.
- code: 4019
  name: TooManyRequests
  description: 'HTTP 429: too many requests for this API key are being processed at the same time and none finished in time, or, on the email endpoints, too many emails are being sent at once. Retry after the number of seconds given in the `Retry-After` header.'
- code: 4020
  name: EmailNotInPlan
  description: 'HTTP 403: the account''s plan does not include sending invoices by email; the pricing page lists the plans that include it. Nothing was generated or sent.'
- code: 4021
  name: EmailSendingDisabled
  description: 'HTTP 403: email sending is switched off or paused for this account. Nothing was sent; contact support@invoicexml.com.'
- code: 4022
  name: EmailDomainNotVerified
  description: 'HTTP 400: the sender address is on a sending domain that has not finished verification. Publish the domain''s DNS records and check its status on the Verified email domains page of your dashboard. Nothing was sent.'
- code: 4023
  name: ProcessingTimeout
  description: 'HTTP 503: the request took longer than 90 seconds and was stopped. Retry it; if it keeps timing out, send a smaller or simpler document.'