rechnungsapi.de
    StartseitePreiseValidatorBlogKontaktAPI Docs
    🔑Anmelden🚀Loslegen
    RechnungsAPIv1.0.10
    OpenAPI JSON laden

    Server

    https://onefinancebe.finbc.de

    Auth

    Bearer Token

    Fügen Sie Ihren API-Token als Authorization-Header hinzu:

    Authorization: Bearer <your-token>

    Ihr Token finden Sie nach der Anmeldung unten im Bereich Profil.

    PDF Analyse

    POSTRechnungs-PDF analysieren

    Rechnungserzeugung

    POSTXRechnung aus JSON erzeugenPOSTZUGFeRD aus JSON + PDF erzeugenPOSTZUGFeRD-PDF aus XRechnung erstellenPOSTZUGFeRD-Rechnungs-PDF aus JSON erzeugen (Template)

    Validierung

    POSTXRechnung-XML validierenPOSTZUGFeRD-PDF validieren

    Extraktion

    POSTXRechnung aus ZUGFeRD als JSON extrahieren

    RechnungsAPI API Referenz

    Vollständige Referenz aller ZUGFeRD- und XRechnung-Endpunkte. Alle Anfragen werden per Bearer Token authentifiziert.

    v1.0.10 — Produktivhttps://onefinancebe.finbc.de

    PDF Analyse

    POST/api/v1/zugferd/createJSONFromAnalysedPdf

    Rechnungs-PDF analysieren

    Analysiert das übergebene Rechnungs-PDF und extrahiert strukturierte Daten: Käufer, Verkäufer, Positionen, MwSt. und Gesamtbeträge. Ideal als Einstiegspunkt für PDF-basierte Rechnungsworkflows.

    FieldTypeRequiredDescription
    pdfInvoiceBase64stringrequiredBase64-kodierter Inhalt der PDF-Rechnung.

    Beispiel

    json
    {
  "pdfInvoiceBase64": "JVBERi0xLjQKJf..."
}

    Beispielantwort

    json
    {
  "apiStatus": 200,
  "invoice": [
    {
      "invoiceNumber": "",
      "invoiceIssueDate": "",
      "invoiceTypeCode": "",
      "invoiceCurrencyCode": "",
      "paymentDueDate": "",
      "buyerReference": "",
      "paymentTerms": "",
      "processControl": {
        "businessProcessTypeIdentifier": "",
        "specificationIdentifier": ""
      },
      "seller": {
        "sellerName": "",
        "sellerTradingName": "",
        "sellerIdentifier": [
          ""
        ],
        "sellerLegalRegistrationIdentifier": "",
        "sellerVatIdentifier": "",
        "sellerTaxRegistrationIdentifier": "",
        "sellerAdditionalLegalInformation": "",
        "sellerElectronicAddress": "",
        "sellerPostalAddress": {
          "sellerAddressLine1": "",
          "sellerAddressLine2": "",
          "sellerAddressLine3": "",
          "sellerCity": "",
          "sellerPostCode": "",
          "sellerCountrySubdivision": "",
          "sellerCountryCode": ""
        },
        "sellerContact": {
          "sellerContactPoint": "",
          "sellerContactTelephoneNumber": "",
          "sellerContactEmailAddress": ""
        }
      },
      "buyer": {
        "buyerName": "",
        "buyerTradingName": "",
        "buyerIdentifier": "",
        "buyerLegalRegistrationIdentifier": "",
        "buyerVatIdentifier": "",
        "buyerElectronicAddress": "",
        "buyerPostalAddress": {
          "buyerAddressLine1": "",
          "buyerAddressLine2": "",
          "buyerAddressLine3": "",
          "buyerCity": "",
          "buyerPostCode": "",
          "buyerCountrySubdivision": "",
          "buyerCountryCode": ""
        },
        "buyerContact": {
          "buyerContactPoint": "",
          "buyerContactTelephoneNumber": "",
          "buyerContactEmailAddress": ""
        }
      },
      "paymentInstructions": {
        "paymentMeansTypeCode": "",
        "paymentMeansText": "",
        "remittanceInformation": "",
        "creditTransfer": [
          {
            "paymentAccountIdentifier": "",
            "paymentAccountName": "",
            "paymentServiceProviderIdentifier": ""
          }
        ],
        "paymentCardInformation": {
          "paymentCardPrimaryAccountNumber": "",
          "paymentCardHolderName": ""
        },
        "directDebit": {
          "mandateReferenceIdentifier": "",
          "bankAssignedCreditorIdentifier": "",
          "debitedAccountIdentifier": ""
        }
      },
      "documentTotals": {
        "sumOfInvoiceLineNetAmount": 0,
        "sumOfAllowancesOnDocumentLevel": 0,
        "sumOfChargesOnDocumentLevel": 0,
        "invoiceTotalAmountWithoutVat": 0,
        "invoiceTotalVatAmount": 0,
        "invoiceTotalVatAmountInAccountingCurrency": 0,
        "invoiceTotalAmountWithVat": 0,
        "paidAmount": 0,
        "roundingAmount": 0,
        "amountDueForPayment": 0
      },
      "vatBreakdown": [
        {
          "vatCategoryTaxableAmount": 0,
          "vatCategoryTaxAmount": 0,
          "vatCategoryCode": "",
          "vatCategoryRate": 0,
          "vatExemptionReasonText": "",
          "vatExemptionReasonCode": ""
        }
      ],
      "additionalSupportingDocuments": [],
      "documentLevelAllowances": [],
      "documentLevelCharges": [],
      "invoiceLine": [
        {
          "invoiceLineIdentifier": "",
          "invoiceLineNote": "",
          "invoiceLineObjectIdentifier": "",
          "invoicedQuantity": 0,
          "invoicedQuantityUnitOfMeasureCode": "",
          "invoiceLineNetAmount": 0,
          "referencedPurchaseOrderLineReference": "",
          "invoiceLineBuyerAccountingReference": "",
          "invoiceLinePeriod": {
            "invoiceLinePeriodStartDate": null,
            "invoiceLinePeriodEndDate": null
          },
          "invoiceLineAllowances": [],
          "invoiceLineCharges": [],
          "priceDetails": {
            "itemNetPrice": 0,
            "itemPriceDiscount": 0,
            "itemGrossPrice": 0,
            "itemPriceBaseQuantity": 0,
            "itemPriceBaseQuantityUnitOfMeasure": ""
          },
          "lineVatInformation": [
            {
              "invoicedItemVatCategoryCode": "",
              "invoicedItemVatRate": 0
            }
          ],
          "itemInformation": {
            "itemName": "",
            "itemDescription": "",
            "itemSellersIdentifier": "",
            "itemBuyersIdentifier": "",
            "itemStandardIdentifier": "",
            "itemClassificationIdentifier": [
              ""
            ],
            "itemCountryOfOrigin": "",
            "itemAttributes": []
          }
        }
      ]
    }
  ]
}

    Playground

    Diesen Endpunkt live im Browser testen.

    Rechnungserzeugung

    POST/api/v1/zugferd/createXinvoiceFromJson

    XRechnung aus JSON erzeugen

    Erzeugt eine valide XRechnungs-XML-Datei aus strukturierten JSON-Rechnungsdaten nach EN 16931. Gibt das XML und Validierungsfehler zurück.

    FieldTypeRequiredDescription
    invoiceobjectrequiredRechnungsobjekt nach EN 16931 Feldmapping.

    Beispiel

    json
    {
  "invoice": {
    "invoiceNumber": "",
    "invoiceIssueDate": "",
    "invoiceTypeCode": "",
    "invoiceCurrencyCode": "",
    "paymentDueDate": "",
    "buyerReference": "",
    "paymentTerms": "",
    "processControl": {
      "businessProcessTypeIdentifier": "",
      "specificationIdentifier": ""
    },
    "seller": {
      "sellerName": "",
      "sellerTradingName": "",
      "sellerIdentifier": [
        ""
      ],
      "sellerLegalRegistrationIdentifier": "",
      "sellerVatIdentifier": "",
      "sellerTaxRegistrationIdentifier": "",
      "sellerAdditionalLegalInformation": "",
      "sellerElectronicAddress": "",
      "sellerPostalAddress": {
        "sellerAddressLine1": "",
        "sellerAddressLine2": "",
        "sellerAddressLine3": "",
        "sellerCity": "",
        "sellerPostCode": "",
        "sellerCountrySubdivision": "",
        "sellerCountryCode": ""
      },
      "sellerContact": {
        "sellerContactPoint": "",
        "sellerContactTelephoneNumber": "",
        "sellerContactEmailAddress": ""
      }
    },
    "buyer": {
      "buyerName": "",
      "buyerTradingName": "",
      "buyerIdentifier": "",
      "buyerLegalRegistrationIdentifier": "",
      "buyerVatIdentifier": "",
      "buyerElectronicAddress": "",
      "buyerPostalAddress": {
        "buyerAddressLine1": "",
        "buyerAddressLine2": "",
        "buyerAddressLine3": "",
        "buyerCity": "",
        "buyerPostCode": "",
        "buyerCountrySubdivision": "",
        "buyerCountryCode": ""
      },
      "buyerContact": {
        "buyerContactPoint": "",
        "buyerContactTelephoneNumber": "",
        "buyerContactEmailAddress": ""
      }
    },
    "paymentInstructions": {
      "paymentMeansTypeCode": "",
      "paymentMeansText": "",
      "remittanceInformation": "",
      "creditTransfer": [
        {
          "paymentAccountIdentifier": "",
          "paymentAccountName": "",
          "paymentServiceProviderIdentifier": ""
        }
      ],
      "paymentCardInformation": {
        "paymentCardPrimaryAccountNumber": "",
        "paymentCardHolderName": ""
      },
      "directDebit": {
        "mandateReferenceIdentifier": "",
        "bankAssignedCreditorIdentifier": "",
        "debitedAccountIdentifier": ""
      }
    },
    "documentTotals": {
      "sumOfInvoiceLineNetAmount": 0,
      "sumOfAllowancesOnDocumentLevel": 0,
      "sumOfChargesOnDocumentLevel": 0,
      "invoiceTotalAmountWithoutVat": 0,
      "invoiceTotalVatAmount": 0,
      "invoiceTotalVatAmountInAccountingCurrency": 0,
      "invoiceTotalAmountWithVat": 0,
      "paidAmount": 0,
      "roundingAmount": 0,
      "amountDueForPayment": 0
    },
    "vatBreakdown": [
      {
        "vatCategoryTaxableAmount": 0,
        "vatCategoryTaxAmount": 0,
        "vatCategoryCode": "",
        "vatCategoryRate": 0,
        "vatExemptionReasonText": "",
        "vatExemptionReasonCode": ""
      }
    ],
    "additionalSupportingDocuments": [],
    "documentLevelAllowances": [],
    "documentLevelCharges": [],
    "invoiceLine": [
      {
        "invoiceLineIdentifier": "",
        "invoiceLineNote": "",
        "invoiceLineObjectIdentifier": "",
        "invoicedQuantity": 0,
        "invoicedQuantityUnitOfMeasureCode": "",
        "invoiceLineNetAmount": 0,
        "referencedPurchaseOrderLineReference": "",
        "invoiceLineBuyerAccountingReference": "",
        "invoiceLinePeriod": {
          "invoiceLinePeriodStartDate": null,
          "invoiceLinePeriodEndDate": null
        },
        "invoiceLineAllowances": [],
        "invoiceLineCharges": [],
        "priceDetails": {
          "itemNetPrice": 0,
          "itemPriceDiscount": 0,
          "itemGrossPrice": 0,
          "itemPriceBaseQuantity": 0,
          "itemPriceBaseQuantityUnitOfMeasure": ""
        },
        "lineVatInformation": [
          {
            "invoicedItemVatCategoryCode": "",
            "invoicedItemVatRate": 0
          }
        ],
        "itemInformation": {
          "itemName": "",
          "itemDescription": "",
          "itemSellersIdentifier": "",
          "itemBuyersIdentifier": "",
          "itemStandardIdentifier": "",
          "itemClassificationIdentifier": [
            ""
          ],
          "itemCountryOfOrigin": "",
          "itemAttributes": []
        }
      }
    ]
  }
}

    Beispielantwort

    json
    {
  "valid": false,
  "message": "xInvoice generated",
  "numberOfXInvoiceErrors": 1,
  "xInvoice": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><rsm:CrossIndustryInvoice xmlns:rsm=\"urn:un:unece:uncefact:data:standard:CrossIndustryInvoice:100\">...</rsm:CrossIndustryInvoice>",
  "xInvoiceErrors": [
    {
      "id": "BR-CO-25",
      "line": null,
      "location": "/rsm:CrossIndustryInvoice",
      "message": "In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.",
      "schemaFile": "EN16931-CII-validation",
      "type": "fatal"
    }
  ]
}

    Playground

    Diesen Endpunkt live im Browser testen.

    POST/api/v1/zugferd/createZugferdFromJson

    ZUGFeRD aus JSON + PDF erzeugen

    Kombiniert strukturierte JSON-Rechnungsdaten mit einem vorhandenen PDF zu einem ZUGFeRD-konformen PDF/A-3-Dokument mit eingebetteter XRechnungs-XML.

    FieldTypeRequiredDescription
    invoiceobjectrequiredRechnungsobjekt.
    invoicePdf64string (base64)requiredBase64-kodiertes PDF für die XML-Einbettung.

    Beispiel

    json
    {
  "invoice": {
    "invoiceNumber": "",
    "invoiceIssueDate": "",
    "invoiceTypeCode": "",
    "invoiceCurrencyCode": "",
    "paymentDueDate": "",
    "buyerReference": "",
    "paymentTerms": "",
    "processControl": {
      "businessProcessTypeIdentifier": "",
      "specificationIdentifier": ""
    },
    "seller": {
      "sellerName": "",
      "sellerTradingName": "",
      "sellerIdentifier": [
        ""
      ],
      "sellerLegalRegistrationIdentifier": "",
      "sellerVatIdentifier": "",
      "sellerTaxRegistrationIdentifier": "",
      "sellerAdditionalLegalInformation": "",
      "sellerElectronicAddress": "",
      "sellerPostalAddress": {
        "sellerAddressLine1": "",
        "sellerAddressLine2": "",
        "sellerAddressLine3": "",
        "sellerCity": "",
        "sellerPostCode": "",
        "sellerCountrySubdivision": "",
        "sellerCountryCode": ""
      },
      "sellerContact": {
        "sellerContactPoint": "",
        "sellerContactTelephoneNumber": "",
        "sellerContactEmailAddress": ""
      }
    },
    "buyer": {
      "buyerName": "",
      "buyerTradingName": "",
      "buyerIdentifier": "",
      "buyerLegalRegistrationIdentifier": "",
      "buyerVatIdentifier": "",
      "buyerElectronicAddress": "",
      "buyerPostalAddress": {
        "buyerAddressLine1": "",
        "buyerAddressLine2": "",
        "buyerAddressLine3": "",
        "buyerCity": "",
        "buyerPostCode": "",
        "buyerCountrySubdivision": "",
        "buyerCountryCode": ""
      },
      "buyerContact": {
        "buyerContactPoint": "",
        "buyerContactTelephoneNumber": "",
        "buyerContactEmailAddress": ""
      }
    },
    "paymentInstructions": {
      "paymentMeansTypeCode": "",
      "paymentMeansText": "",
      "remittanceInformation": "",
      "creditTransfer": [
        {
          "paymentAccountIdentifier": "",
          "paymentAccountName": "",
          "paymentServiceProviderIdentifier": ""
        }
      ],
      "paymentCardInformation": {
        "paymentCardPrimaryAccountNumber": "",
        "paymentCardHolderName": ""
      },
      "directDebit": {
        "mandateReferenceIdentifier": "",
        "bankAssignedCreditorIdentifier": "",
        "debitedAccountIdentifier": ""
      }
    },
    "documentTotals": {
      "sumOfInvoiceLineNetAmount": 0,
      "sumOfAllowancesOnDocumentLevel": 0,
      "sumOfChargesOnDocumentLevel": 0,
      "invoiceTotalAmountWithoutVat": 0,
      "invoiceTotalVatAmount": 0,
      "invoiceTotalVatAmountInAccountingCurrency": 0,
      "invoiceTotalAmountWithVat": 0,
      "paidAmount": 0,
      "roundingAmount": 0,
      "amountDueForPayment": 0
    },
    "vatBreakdown": [
      {
        "vatCategoryTaxableAmount": 0,
        "vatCategoryTaxAmount": 0,
        "vatCategoryCode": "",
        "vatCategoryRate": 0,
        "vatExemptionReasonText": "",
        "vatExemptionReasonCode": ""
      }
    ],
    "additionalSupportingDocuments": [],
    "documentLevelAllowances": [],
    "documentLevelCharges": [],
    "invoiceLine": [
      {
        "invoiceLineIdentifier": "",
        "invoiceLineNote": "",
        "invoiceLineObjectIdentifier": "",
        "invoicedQuantity": 0,
        "invoicedQuantityUnitOfMeasureCode": "",
        "invoiceLineNetAmount": 0,
        "referencedPurchaseOrderLineReference": "",
        "invoiceLineBuyerAccountingReference": "",
        "invoiceLinePeriod": {
          "invoiceLinePeriodStartDate": null,
          "invoiceLinePeriodEndDate": null
        },
        "invoiceLineAllowances": [],
        "invoiceLineCharges": [],
        "priceDetails": {
          "itemNetPrice": 0,
          "itemPriceDiscount": 0,
          "itemGrossPrice": 0,
          "itemPriceBaseQuantity": 0,
          "itemPriceBaseQuantityUnitOfMeasure": ""
        },
        "lineVatInformation": [
          {
            "invoicedItemVatCategoryCode": "",
            "invoicedItemVatRate": 0
          }
        ],
        "itemInformation": {
          "itemName": "",
          "itemDescription": "",
          "itemSellersIdentifier": "",
          "itemBuyersIdentifier": "",
          "itemStandardIdentifier": "",
          "itemClassificationIdentifier": [
            ""
          ],
          "itemCountryOfOrigin": "",
          "itemAttributes": []
        }
      }
    ]
  },
  "invoicePdf64": "JVBERi0xLjQK..."
}

    Beispielantwort

    json
    {
  "message": "ZUGFeRD created",
  "zugferdValid": false,
  "xInvoiceValid": false,
  "numberOfZugferdErrors": 1,
  "numberOfxInvoiceErrors": 1,
  "zugferd": "JVBERi0xLjcKJY/6qbAKMyAwIG9iago8PC9...",
  "zugferdErrorList": [],
  "xInvoice": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><rsm:CrossIndustryInvoice>...</rsm:CrossIndustryInvoice>",
  "xInvoiceErrorList": []
}

    Playground

    Diesen Endpunkt live im Browser testen.

    POST/api/v1/zugferd/createZugferdPdfFromXinvoice

    ZUGFeRD-PDF aus XRechnung erstellen

    Erstellt ein ZUGFeRD-konformes PDF/A-3, indem eine vorhandene XRechnungs-XML in ein PDF-Dokument eingebettet wird.

    FieldTypeRequiredDescription
    xInvoiceXmlstringrequiredXRechnungs-XML als String.
    invoicePdf64string (base64)requiredBase64-kodiertes PDF für die XML-Einbettung.

    Beispiel

    json
    {
  "xInvoiceXml": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><rsm:CrossIndustryInvoice>...</rsm:CrossIndustryInvoice>",
  "invoicePdf64": "JVBERi0xLjQK..."
}

    Beispielantwort

    json
    {
  "valid": false,
  "message": "zugferd created",
  "numberOfZugferdErrors": 0,
  "zugferdFile": "JVBERi0xLjcKJaOIwOMKMyAwIG9iago...",
  "zugferdErrors": []
}

    Playground

    Diesen Endpunkt live im Browser testen.

    POST/api/v1/zugferd/createInvoicePdfFromJson

    ZUGFeRD-Rechnungs-PDF aus JSON erzeugen (Template)

    Erzeugt ein ZUGFeRD-konformes Rechnungs-PDF aus JSON-Daten über ein eigenes Word- oder Design-Template. Ab 2027 in Deutschland verpflichtend.

    FieldTypeRequiredDescription
    invoiceobjectrequiredRechnungsobjekt.
    templateIdstringrequiredID des Templates für die PDF-Erzeugung.

    Beispiel

    json
    {
  "templateId": "your-template-id",
  "invoice": {
    "invoiceNumber": "",
    "invoiceIssueDate": "",
    "invoiceTypeCode": "",
    "invoiceCurrencyCode": "",
    "paymentDueDate": "",
    "buyerReference": "",
    "paymentTerms": "",
    "processControl": {
      "businessProcessTypeIdentifier": "",
      "specificationIdentifier": ""
    },
    "seller": {
      "sellerName": "",
      "sellerTradingName": "",
      "sellerIdentifier": [
        ""
      ],
      "sellerLegalRegistrationIdentifier": "",
      "sellerVatIdentifier": "",
      "sellerTaxRegistrationIdentifier": "",
      "sellerAdditionalLegalInformation": "",
      "sellerElectronicAddress": "",
      "sellerPostalAddress": {
        "sellerAddressLine1": "",
        "sellerAddressLine2": "",
        "sellerAddressLine3": "",
        "sellerCity": "",
        "sellerPostCode": "",
        "sellerCountrySubdivision": "",
        "sellerCountryCode": ""
      },
      "sellerContact": {
        "sellerContactPoint": "",
        "sellerContactTelephoneNumber": "",
        "sellerContactEmailAddress": ""
      }
    },
    "buyer": {
      "buyerName": "",
      "buyerTradingName": "",
      "buyerIdentifier": "",
      "buyerLegalRegistrationIdentifier": "",
      "buyerVatIdentifier": "",
      "buyerElectronicAddress": "",
      "buyerPostalAddress": {
        "buyerAddressLine1": "",
        "buyerAddressLine2": "",
        "buyerAddressLine3": "",
        "buyerCity": "",
        "buyerPostCode": "",
        "buyerCountrySubdivision": "",
        "buyerCountryCode": ""
      },
      "buyerContact": {
        "buyerContactPoint": "",
        "buyerContactTelephoneNumber": "",
        "buyerContactEmailAddress": ""
      }
    },
    "paymentInstructions": {
      "paymentMeansTypeCode": "",
      "paymentMeansText": "",
      "remittanceInformation": "",
      "creditTransfer": [
        {
          "paymentAccountIdentifier": "",
          "paymentAccountName": "",
          "paymentServiceProviderIdentifier": ""
        }
      ],
      "paymentCardInformation": {
        "paymentCardPrimaryAccountNumber": "",
        "paymentCardHolderName": ""
      },
      "directDebit": {
        "mandateReferenceIdentifier": "",
        "bankAssignedCreditorIdentifier": "",
        "debitedAccountIdentifier": ""
      }
    },
    "documentTotals": {
      "sumOfInvoiceLineNetAmount": 0,
      "sumOfAllowancesOnDocumentLevel": 0,
      "sumOfChargesOnDocumentLevel": 0,
      "invoiceTotalAmountWithoutVat": 0,
      "invoiceTotalVatAmount": 0,
      "invoiceTotalVatAmountInAccountingCurrency": 0,
      "invoiceTotalAmountWithVat": 0,
      "paidAmount": 0,
      "roundingAmount": 0,
      "amountDueForPayment": 0
    },
    "vatBreakdown": [
      {
        "vatCategoryTaxableAmount": 0,
        "vatCategoryTaxAmount": 0,
        "vatCategoryCode": "",
        "vatCategoryRate": 0,
        "vatExemptionReasonText": "",
        "vatExemptionReasonCode": ""
      }
    ],
    "additionalSupportingDocuments": [],
    "documentLevelAllowances": [],
    "documentLevelCharges": [],
    "invoiceLine": [
      {
        "invoiceLineIdentifier": "",
        "invoiceLineNote": "",
        "invoiceLineObjectIdentifier": "",
        "invoicedQuantity": 0,
        "invoicedQuantityUnitOfMeasureCode": "",
        "invoiceLineNetAmount": 0,
        "referencedPurchaseOrderLineReference": "",
        "invoiceLineBuyerAccountingReference": "",
        "invoiceLinePeriod": {
          "invoiceLinePeriodStartDate": null,
          "invoiceLinePeriodEndDate": null
        },
        "invoiceLineAllowances": [],
        "invoiceLineCharges": [],
        "priceDetails": {
          "itemNetPrice": 0,
          "itemPriceDiscount": 0,
          "itemGrossPrice": 0,
          "itemPriceBaseQuantity": 0,
          "itemPriceBaseQuantityUnitOfMeasure": ""
        },
        "lineVatInformation": [
          {
            "invoicedItemVatCategoryCode": "",
            "invoicedItemVatRate": 0
          }
        ],
        "itemInformation": {
          "itemName": "",
          "itemDescription": "",
          "itemSellersIdentifier": "",
          "itemBuyersIdentifier": "",
          "itemStandardIdentifier": "",
          "itemClassificationIdentifier": [
            ""
          ],
          "itemCountryOfOrigin": "",
          "itemAttributes": []
        }
      }
    ]
  }
}

    Beispielantwort

    json
    {
  "message": "invoice and pdf created",
  "fileName": "in-2525-4n4_20250805_1755765122.pdf",
  "fileExtension": "pdf",
  "fileSize": 78573,
  "filecontentB64": "JVBERi0xLjQK..."
}

    Beispielantwort

    json
    {
  "message": "invoice and pdf created",
  "fileName": "in-2525-4n4_20250805_1755765122.pdf",
  "fileExtension": "pdf",
  "fileSize": 78573,
  "filecontentB64": "JVBERi0xLjQK..."
}

    Playground

    Diesen Endpunkt live im Browser testen.

    Validierung

    POST/api/v1/zugferd/validateXinvoiceXML

    XRechnung-XML validieren

    Validiert XRechnungs-XML gegen EN 16931 und XRechnung-Business-Regeln. Gibt strukturierte Fehler mit Regel-IDs und Positionen zurück, damit Verstöße vor dem Versand behoben werden können.

    FieldTypeRequiredDescription
    xinvoiceXMLstringrequiredXRechnungs-XML-Inhalt als String.

    Beispiel

    json
    {
  "xinvoiceXML": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>..."
}

    Beispielantwort

    json
    {
  "valid": false,
  "message": "validated. (7835)",
  "xInvoiceErrors": [
    {
      "id": "BR-CO-25",
      "line": null,
      "location": "/rsm:CrossIndustryInvoice",
      "message": "In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.",
      "schemaFile": "EN16931-CII-validation",
      "type": "fatal"
    }
  ]
}

    Playground

    Diesen Endpunkt live im Browser testen.

    POST/api/v1/zugferd/validateZugferdPdf

    ZUGFeRD-PDF validieren

    Validiert ein bestehendes ZUGFeRD-PDF inkl. eingebettetem XML gegen EN 16931. Liefert ein klares Bestanden/Nicht-bestanden mit einer detaillierten Fehlerliste.

    FieldTypeRequiredDescription
    zugferdFile64string (base64)requiredBase64-kodiertes ZUGFeRD-PDF.

    Beispiel

    json
    {
  "zugferdFile64": "JVBERi0xLjQK..."
}

    Beispielantwort

    json
    {
  "valid": false,
  "message": "File was validated",
  "numberOfZugferdErrors": 10,
  "zugferdErrors": [
    {
      "id": "BR-CO-25",
      "line": null,
      "location": "/rsm:CrossIndustryInvoice",
      "message": "In case the Amount due for payment (BT-115) is positive, either the Payment due date (BT-9) or the Payment terms (BT-20) shall be present.",
      "schemaFile": "EN16931-CII-validation",
      "type": "fatal"
    }
  ]
}

    Playground

    Diesen Endpunkt live im Browser testen.

    Extraktion

    POST/api/v1/zugferd/extractXInvoiceFromZugferdToJson

    XRechnung aus ZUGFeRD als JSON extrahieren

    Extrahiert die eingebettete XRechnungs-XML aus einem ZUGFeRD-PDF und gibt sie als strukturiertes JSON-Objekt für die Weiterverarbeitung zurück.

    FieldTypeRequiredDescription
    zugferdFileBase64string (base64)requiredDas ZUGFeRD-PDF-Dokument als Base64-kodierter String.

    Beispiel

    json
    {
  "zugferdFileBase64": "JVBERi0xLjcKJbe3wvUKMyAwIG9iago8PC9UeXBl..."
}

    Beispielantwort

    json
    {
  "invoice": {
    "invoiceNumber": "",
    "invoiceIssueDate": "",
    "invoiceTypeCode": "",
    "invoiceCurrencyCode": "",
    "paymentDueDate": "",
    "buyerReference": "",
    "paymentTerms": "",
    "processControl": {
      "businessProcessTypeIdentifier": "",
      "specificationIdentifier": ""
    },
    "seller": {
      "sellerName": "",
      "sellerTradingName": "",
      "sellerIdentifier": [
        ""
      ],
      "sellerLegalRegistrationIdentifier": "",
      "sellerVatIdentifier": "",
      "sellerTaxRegistrationIdentifier": "",
      "sellerAdditionalLegalInformation": "",
      "sellerElectronicAddress": "",
      "sellerPostalAddress": {
        "sellerAddressLine1": "",
        "sellerAddressLine2": "",
        "sellerAddressLine3": "",
        "sellerCity": "",
        "sellerPostCode": "",
        "sellerCountrySubdivision": "",
        "sellerCountryCode": ""
      },
      "sellerContact": {
        "sellerContactPoint": "",
        "sellerContactTelephoneNumber": "",
        "sellerContactEmailAddress": ""
      }
    },
    "buyer": {
      "buyerName": "",
      "buyerTradingName": "",
      "buyerIdentifier": "",
      "buyerLegalRegistrationIdentifier": "",
      "buyerVatIdentifier": "",
      "buyerElectronicAddress": "",
      "buyerPostalAddress": {
        "buyerAddressLine1": "",
        "buyerAddressLine2": "",
        "buyerAddressLine3": "",
        "buyerCity": "",
        "buyerPostCode": "",
        "buyerCountrySubdivision": "",
        "buyerCountryCode": ""
      },
      "buyerContact": {
        "buyerContactPoint": "",
        "buyerContactTelephoneNumber": "",
        "buyerContactEmailAddress": ""
      }
    },
    "paymentInstructions": {
      "paymentMeansTypeCode": "",
      "paymentMeansText": "",
      "remittanceInformation": "",
      "creditTransfer": [
        {
          "paymentAccountIdentifier": "",
          "paymentAccountName": "",
          "paymentServiceProviderIdentifier": ""
        }
      ],
      "paymentCardInformation": {
        "paymentCardPrimaryAccountNumber": "",
        "paymentCardHolderName": ""
      },
      "directDebit": {
        "mandateReferenceIdentifier": "",
        "bankAssignedCreditorIdentifier": "",
        "debitedAccountIdentifier": ""
      }
    },
    "documentTotals": {
      "sumOfInvoiceLineNetAmount": 0,
      "sumOfAllowancesOnDocumentLevel": 0,
      "sumOfChargesOnDocumentLevel": 0,
      "invoiceTotalAmountWithoutVat": 0,
      "invoiceTotalVatAmount": 0,
      "invoiceTotalVatAmountInAccountingCurrency": 0,
      "invoiceTotalAmountWithVat": 0,
      "paidAmount": 0,
      "roundingAmount": 0,
      "amountDueForPayment": 0
    },
    "vatBreakdown": [
      {
        "vatCategoryTaxableAmount": 0,
        "vatCategoryTaxAmount": 0,
        "vatCategoryCode": "",
        "vatCategoryRate": 0,
        "vatExemptionReasonText": "",
        "vatExemptionReasonCode": ""
      }
    ],
    "additionalSupportingDocuments": [],
    "documentLevelAllowances": [],
    "documentLevelCharges": [],
    "invoiceLine": [
      {
        "invoiceLineIdentifier": "",
        "invoiceLineNote": "",
        "invoiceLineObjectIdentifier": "",
        "invoicedQuantity": 0,
        "invoicedQuantityUnitOfMeasureCode": "",
        "invoiceLineNetAmount": 0,
        "referencedPurchaseOrderLineReference": "",
        "invoiceLineBuyerAccountingReference": "",
        "invoiceLinePeriod": {
          "invoiceLinePeriodStartDate": null,
          "invoiceLinePeriodEndDate": null
        },
        "invoiceLineAllowances": [],
        "invoiceLineCharges": [],
        "priceDetails": {
          "itemNetPrice": 0,
          "itemPriceDiscount": 0,
          "itemGrossPrice": 0,
          "itemPriceBaseQuantity": 0,
          "itemPriceBaseQuantityUnitOfMeasure": ""
        },
        "lineVatInformation": [
          {
            "invoicedItemVatCategoryCode": "",
            "invoicedItemVatRate": 0
          }
        ],
        "itemInformation": {
          "itemName": "",
          "itemDescription": "",
          "itemSellersIdentifier": "",
          "itemBuyersIdentifier": "",
          "itemStandardIdentifier": "",
          "itemClassificationIdentifier": [
            ""
          ],
          "itemCountryOfOrigin": "",
          "itemAttributes": []
        }
      }
    ]
  }
}

    Playground

    Diesen Endpunkt live im Browser testen.

    rechnungsapi.de

    Professionelle E-Rechnungs-APIs für KMUs. Transformieren Sie Ihr ERP-System mit ZUGFeRD-konformen Lösungen und DSGVO-konformer KI-Technologie.

    DSGVO-konform & sicher

    Produkt

    • Preise

    Rechtliches

    • Impressum
    • Datenschutzerklärung
    • Nutzungsbedingungen
    • Kontakt
    • DSGVO-Konformität

    © 2025 rechnungsapi.de

    support@rechnungsapi.de