{
"openapi": "3.1.0",
"info": {
"title": "E-Invoice Checker API",
"version": "1.0.0",
"summary": "Detect, parse, validate, render and fix EU and international e-invoices.",
"description": "One API for structured invoices: XRechnung (UBL/CII), ZUGFeRD 2.x / Factur-X (PDF or XML), Peppol BIS 3.0, EN 16931 UBL/CII, Polish KSeF FA(3), Croatian eRačun (HR CIUS 2025), Spanish Facturae 3.2.x and VERI*FACTU records / AEAT responses / QR URLs, Malaysian MyInvois (XML or UBL JSON). Validation uses the official rule sets (CEN EN 16931 schematron, KoSIT, OpenPeppol, Porezna uprava HR-CIUS, Facturae and AEAT XSD, LHDN SDK rules, KSeF FA(3)). Every error carries a rule id, message, XPath and a help link. Files are processed in memory and never stored.",
"contact": {
"name": "E-Invoice Checker support",
"email": "support@einvoicechecker.com",
"url": "https://einvoicechecker.com/contact/"
},
"termsOfService": "https://einvoicechecker.com/terms/"
},
"servers": [
{
"url": "https://einvoicechecker.com"
}
],
"externalDocs": {
"description": "Developer documentation",
"url": "https://einvoicechecker.com/developers/"
},
"security": [
{
"bearer": []
},
{
"apiKey": []
},
{}
],
"components": {
"securitySchemes": {
"bearer": {
"type": "http",
"scheme": "bearer",
"description": "API key from /developers/ (free plan available)"
},
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-API-Key"
}
}
},
"paths": {
"/v1/detect": {
"post": {
"operationId": "detectInvoice",
"summary": "Detect format",
"description": "Identify family, syntax, standard, profile and country of an e-invoice. Cheap first step.",
"requestBody": {
"required": true,
"description": "The invoice: multipart field \"file\" (XML, PDF, JSON), the raw file as the request body, or JSON {\"xml\": \"...\"}. A MyInvois UBL JSON document can be posted as application/json directly; a VERI*FACTU QR URL as text/plain.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
},
"application/xml": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"title": "Invoice as a string",
"properties": {
"xml": {
"type": "string",
"description": "The invoice XML (or a VERI*FACTU QR URL) as a string"
}
},
"required": [
"xml"
]
},
{
"type": "object",
"title": "MyInvois UBL JSON document",
"description": "A Malaysian MyInvois invoice in UBL JSON syntax (with _D, _A, _B and Invoice)",
"properties": {
"_D": {
"type": "string"
},
"Invoice": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"_D",
"Invoice"
]
}
]
},
"examples": {
"peppol": {
"summary": "Peppol BIS 3.0 invoice with errors",
"value": {
"xml": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Snippet12017-11-132017-12-01380EUR4025:123:43430150abc948234823984723987499887766SupplierTradingName Ltd.Main street 1Postbox 123LondonGB 123 EWGBGB1232434VATSupplierOfficialName LtdGB983294FR23342FR23342BuyerTradingName ASHovedgatan 32Po box 878Stockholm456 34SESE4598375937VATBuyer Official Name39937423947Lisa Johnson23434234lj@buyer.se2017-11-019483759475923478Delivery street 2Building 56Stockholm21234SEDelivery party Name30Snippet1IBAN32423940AccountNameBIC324098Payment within 10 days, 2% discounttrueInsurance25S25.0VAT331.251325331.25S25.0VAT130013251666.25251666.25172800Konteringsstreng123Description of itemitem name21382183120983NO09348023S25.0VAT4002-3-1500123Description 2item name 221382183120983NO09348023S25.0VAT500"
}
}
}
},
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"type": "object",
"properties": {
"family": {
"type": "string",
"example": "en16931"
},
"syntax": {
"type": "string",
"example": "ubl"
},
"standard": {
"type": "string",
"example": "XRechnung"
},
"profile": {
"type": "string"
},
"country": {
"type": "string",
"example": "DE"
},
"version": {
"type": "string"
}
}
},
{
"type": "object",
"properties": {
"source": {
"type": "string"
},
"embeddedFile": {
"type": "string"
},
"filename": {
"type": "string"
}
}
}
]
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Not a recognised e-invoice, or a PDF without embedded XML",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Rate limit or monthly quota reached",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"/v1/parse": {
"post": {
"operationId": "parseInvoice",
"summary": "Parse to JSON",
"description": "Normalise any supported invoice into one JSON model: parties, lines, VAT breakdown, totals, payment.",
"requestBody": {
"required": true,
"description": "The invoice: multipart field \"file\" (XML, PDF, JSON), the raw file as the request body, or JSON {\"xml\": \"...\"}. A MyInvois UBL JSON document can be posted as application/json directly; a VERI*FACTU QR URL as text/plain.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
},
"application/xml": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"title": "Invoice as a string",
"properties": {
"xml": {
"type": "string",
"description": "The invoice XML (or a VERI*FACTU QR URL) as a string"
}
},
"required": [
"xml"
]
},
{
"type": "object",
"title": "MyInvois UBL JSON document",
"description": "A Malaysian MyInvois invoice in UBL JSON syntax (with _D, _A, _B and Invoice)",
"properties": {
"_D": {
"type": "string"
},
"Invoice": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"_D",
"Invoice"
]
}
]
},
"examples": {
"peppol": {
"summary": "Peppol BIS 3.0 invoice with errors",
"value": {
"xml": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Snippet12017-11-132017-12-01380EUR4025:123:43430150abc948234823984723987499887766SupplierTradingName Ltd.Main street 1Postbox 123LondonGB 123 EWGBGB1232434VATSupplierOfficialName LtdGB983294FR23342FR23342BuyerTradingName ASHovedgatan 32Po box 878Stockholm456 34SESE4598375937VATBuyer Official Name39937423947Lisa Johnson23434234lj@buyer.se2017-11-019483759475923478Delivery street 2Building 56Stockholm21234SEDelivery party Name30Snippet1IBAN32423940AccountNameBIC324098Payment within 10 days, 2% discounttrueInsurance25S25.0VAT331.251325331.25S25.0VAT130013251666.25251666.25172800Konteringsstreng123Description of itemitem name21382183120983NO09348023S25.0VAT4002-3-1500123Description 2item name 221382183120983NO09348023S25.0VAT500"
}
}
}
},
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"format": {
"type": "object",
"properties": {
"family": {
"type": "string",
"example": "en16931"
},
"syntax": {
"type": "string",
"example": "ubl"
},
"standard": {
"type": "string",
"example": "XRechnung"
},
"profile": {
"type": "string"
},
"country": {
"type": "string",
"example": "DE"
},
"version": {
"type": "string"
}
}
},
"invoice": {
"type": "object",
"additionalProperties": true
}
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Not a recognised e-invoice, or a PDF without embedded XML",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Rate limit or monthly quota reached",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
},
"/v1/validate": {
"post": {
"operationId": "validateInvoice",
"summary": "Validate",
"description": "Run every rule set that applies to the detected format and return one merged report.",
"requestBody": {
"required": true,
"description": "The invoice: multipart field \"file\" (XML, PDF, JSON), the raw file as the request body, or JSON {\"xml\": \"...\"}. A MyInvois UBL JSON document can be posted as application/json directly; a VERI*FACTU QR URL as text/plain.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
},
"application/xml": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"title": "Invoice as a string",
"properties": {
"xml": {
"type": "string",
"description": "The invoice XML (or a VERI*FACTU QR URL) as a string"
}
},
"required": [
"xml"
]
},
{
"type": "object",
"title": "MyInvois UBL JSON document",
"description": "A Malaysian MyInvois invoice in UBL JSON syntax (with _D, _A, _B and Invoice)",
"properties": {
"_D": {
"type": "string"
},
"Invoice": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"_D",
"Invoice"
]
}
]
},
"examples": {
"peppol": {
"summary": "Peppol BIS 3.0 invoice with errors",
"value": {
"xml": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Snippet12017-11-132017-12-01380EUR4025:123:43430150abc948234823984723987499887766SupplierTradingName Ltd.Main street 1Postbox 123LondonGB 123 EWGBGB1232434VATSupplierOfficialName LtdGB983294FR23342FR23342BuyerTradingName ASHovedgatan 32Po box 878Stockholm456 34SESE4598375937VATBuyer Official Name39937423947Lisa Johnson23434234lj@buyer.se2017-11-019483759475923478Delivery street 2Building 56Stockholm21234SEDelivery party Name30Snippet1IBAN32423940AccountNameBIC324098Payment within 10 days, 2% discounttrueInsurance25S25.0VAT331.251325331.25S25.0VAT130013251666.25251666.25172800Konteringsstreng123Description of itemitem name21382183120983NO09348023S25.0VAT4002-3-1500123Description 2item name 221382183120983NO09348023S25.0VAT500"
}
}
}
},
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"format": {
"type": "object",
"properties": {
"family": {
"type": "string",
"example": "en16931"
},
"syntax": {
"type": "string",
"example": "ubl"
},
"standard": {
"type": "string",
"example": "XRechnung"
},
"profile": {
"type": "string"
},
"country": {
"type": "string",
"example": "DE"
},
"version": {
"type": "string"
}
}
},
"valid": {
"type": "boolean"
},
"checks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"engine": {
"type": "string"
},
"valid": {
"type": "boolean"
},
"errors": {
"type": "integer"
},
"skipped": {
"type": "boolean"
},
"reason": {
"type": "string"
}
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"rule": {
"type": "string",
"example": "BR-DE-15"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"help": {
"type": "string",
"format": "uri",
"description": "Page explaining the rule and how to fix it"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"rule": {
"type": "string",
"example": "BR-DE-15"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"help": {
"type": "string",
"format": "uri",
"description": "Page explaining the rule and how to fix it"
}
}
}
},
"source": {
"type": "string",
"enum": [
"xml",
"pdf",
"json",
"url"
]
}
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Not a recognised e-invoice, or a PDF without embedded XML",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Rate limit or monthly quota reached",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "kosit",
"in": "query",
"schema": {
"type": "boolean",
"default": true
},
"description": "Run the KoSIT validator for XRechnung/ZUGFeRD/Factur-X"
}
]
}
},
"/v1/render": {
"post": {
"operationId": "renderInvoice",
"summary": "Render HTML or PDF",
"description": "Human-readable invoice. format=pdf costs 2 units.",
"requestBody": {
"required": true,
"description": "The invoice: multipart field \"file\" (XML, PDF, JSON), the raw file as the request body, or JSON {\"xml\": \"...\"}. A MyInvois UBL JSON document can be posted as application/json directly; a VERI*FACTU QR URL as text/plain.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
},
"application/xml": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"title": "Invoice as a string",
"properties": {
"xml": {
"type": "string",
"description": "The invoice XML (or a VERI*FACTU QR URL) as a string"
}
},
"required": [
"xml"
]
},
{
"type": "object",
"title": "MyInvois UBL JSON document",
"description": "A Malaysian MyInvois invoice in UBL JSON syntax (with _D, _A, _B and Invoice)",
"properties": {
"_D": {
"type": "string"
},
"Invoice": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"_D",
"Invoice"
]
}
]
},
"examples": {
"peppol": {
"summary": "Peppol BIS 3.0 invoice with errors",
"value": {
"xml": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Snippet12017-11-132017-12-01380EUR4025:123:43430150abc948234823984723987499887766SupplierTradingName Ltd.Main street 1Postbox 123LondonGB 123 EWGBGB1232434VATSupplierOfficialName LtdGB983294FR23342FR23342BuyerTradingName ASHovedgatan 32Po box 878Stockholm456 34SESE4598375937VATBuyer Official Name39937423947Lisa Johnson23434234lj@buyer.se2017-11-019483759475923478Delivery street 2Building 56Stockholm21234SEDelivery party Name30Snippet1IBAN32423940AccountNameBIC324098Payment within 10 days, 2% discounttrueInsurance25S25.0VAT331.251325331.25S25.0VAT130013251666.25251666.25172800Konteringsstreng123Description of itemitem name21382183120983NO09348023S25.0VAT4002-3-1500123Description 2item name 221382183120983NO09348023S25.0VAT500"
}
}
}
},
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "Rendered invoice",
"content": {
"text/html": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "lang",
"in": "query",
"schema": {
"type": "string",
"enum": [
"en",
"de",
"fr",
"pl",
"nl",
"hr",
"es"
],
"default": "en"
},
"description": "Label language of the rendered invoice"
},
{
"name": "format",
"in": "query",
"schema": {
"type": "string",
"enum": [
"html",
"pdf"
],
"default": "html"
}
}
]
}
},
"/v1/inspect": {
"post": {
"operationId": "inspectInvoice",
"summary": "Inspect (parse + validate + render)",
"description": "Everything the web tool shows in one call: format, parsed invoice, validation report and HTML.",
"requestBody": {
"required": true,
"description": "The invoice: multipart field \"file\" (XML, PDF, JSON), the raw file as the request body, or JSON {\"xml\": \"...\"}. A MyInvois UBL JSON document can be posted as application/json directly; a VERI*FACTU QR URL as text/plain.",
"content": {
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
},
"application/xml": {
"schema": {
"type": "string"
}
},
"application/pdf": {
"schema": {
"type": "string",
"format": "binary"
}
},
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"title": "Invoice as a string",
"properties": {
"xml": {
"type": "string",
"description": "The invoice XML (or a VERI*FACTU QR URL) as a string"
}
},
"required": [
"xml"
]
},
{
"type": "object",
"title": "MyInvois UBL JSON document",
"description": "A Malaysian MyInvois invoice in UBL JSON syntax (with _D, _A, _B and Invoice)",
"properties": {
"_D": {
"type": "string"
},
"Invoice": {
"type": "array",
"items": {
"type": "object"
}
}
},
"required": [
"_D",
"Invoice"
]
}
]
},
"examples": {
"peppol": {
"summary": "Peppol BIS 3.0 invoice with errors",
"value": {
"xml": "urn:cen.eu:en16931:2017#compliant#urn:fdc:peppol.eu:2017:poacc:billing:3.0Snippet12017-11-132017-12-01380EUR4025:123:43430150abc948234823984723987499887766SupplierTradingName Ltd.Main street 1Postbox 123LondonGB 123 EWGBGB1232434VATSupplierOfficialName LtdGB983294FR23342FR23342BuyerTradingName ASHovedgatan 32Po box 878Stockholm456 34SESE4598375937VATBuyer Official Name39937423947Lisa Johnson23434234lj@buyer.se2017-11-019483759475923478Delivery street 2Building 56Stockholm21234SEDelivery party Name30Snippet1IBAN32423940AccountNameBIC324098Payment within 10 days, 2% discounttrueInsurance25S25.0VAT331.251325331.25S25.0VAT130013251666.25251666.25172800Konteringsstreng123Description of itemitem name21382183120983NO09348023S25.0VAT4002-3-1500123Description 2item name 221382183120983NO09348023S25.0VAT500"
}
}
}
},
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"format": {
"type": "object",
"properties": {
"family": {
"type": "string",
"example": "en16931"
},
"syntax": {
"type": "string",
"example": "ubl"
},
"standard": {
"type": "string",
"example": "XRechnung"
},
"profile": {
"type": "string"
},
"country": {
"type": "string",
"example": "DE"
},
"version": {
"type": "string"
}
}
},
"invoice": {
"type": "object",
"additionalProperties": true
},
"validation": {
"type": "object",
"properties": {
"format": {
"type": "object",
"properties": {
"family": {
"type": "string",
"example": "en16931"
},
"syntax": {
"type": "string",
"example": "ubl"
},
"standard": {
"type": "string",
"example": "XRechnung"
},
"profile": {
"type": "string"
},
"country": {
"type": "string",
"example": "DE"
},
"version": {
"type": "string"
}
}
},
"valid": {
"type": "boolean"
},
"checks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"engine": {
"type": "string"
},
"valid": {
"type": "boolean"
},
"errors": {
"type": "integer"
},
"skipped": {
"type": "boolean"
},
"reason": {
"type": "string"
}
}
}
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"rule": {
"type": "string",
"example": "BR-DE-15"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"help": {
"type": "string",
"format": "uri",
"description": "Page explaining the rule and how to fix it"
}
}
}
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"rule": {
"type": "string",
"example": "BR-DE-15"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"help": {
"type": "string",
"format": "uri",
"description": "Page explaining the rule and how to fix it"
}
}
}
},
"source": {
"type": "string",
"enum": [
"xml",
"pdf",
"json",
"url"
]
}
}
},
"html": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Not a recognised e-invoice, or a PDF without embedded XML",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Rate limit or monthly quota reached",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "lang",
"in": "query",
"schema": {
"type": "string",
"enum": [
"en",
"de",
"fr",
"pl",
"nl",
"hr",
"es"
],
"default": "en"
},
"description": "Label language of the rendered invoice"
}
]
}
},
"/v1/fix": {
"post": {
"operationId": "fixInvoice",
"summary": "Auto-fix (EN 16931)",
"description": "Correct fixable errors of an EN 16931 invoice. dry_run=1 lists the proposed changes (1 unit); applying costs 2 units.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"xml": {
"type": "string"
},
"values": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"options": {
"type": "object",
"properties": {
"totals": {
"type": "boolean"
}
}
}
},
"required": [
"xml"
]
}
},
"multipart/form-data": {
"schema": {
"type": "object",
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"required": [
"file"
]
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"valid_before": {
"type": "boolean"
},
"valid_after": {
"type": "boolean"
},
"applied": {
"type": "array",
"items": {
"type": "object"
}
},
"remaining_errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"source": {
"type": "string"
},
"rule": {
"type": "string",
"example": "BR-DE-15"
},
"message": {
"type": "string"
},
"path": {
"type": "string"
},
"help": {
"type": "string",
"format": "uri",
"description": "Page explaining the rule and how to fix it"
}
}
}
},
"xml": {
"type": "string"
}
}
}
}
}
},
"400": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"422": {
"description": "Not a recognised e-invoice, or a PDF without embedded XML",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
},
"429": {
"description": "Rate limit or monthly quota reached",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
},
"parameters": [
{
"name": "dry_run",
"in": "query",
"schema": {
"type": "boolean"
}
}
]
}
},
"/v1/me": {
"get": {
"operationId": "getUsage",
"summary": "Plan and usage of the API key",
"security": [
{
"bearer": []
},
{
"apiKey": []
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"plan": {
"type": "string"
},
"monthly_quota": {
"type": "integer"
},
"used_this_month": {
"type": "integer"
},
"remaining": {
"type": "integer"
}
}
}
}
}
},
"401": {
"description": "Error",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"error": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}