XRechnung & ZUGFeRD
How to get “API Key” from Portal?
To obtain the API key used with /auth/login, navigate to Settings → ERP Management → API Management in the Portal and use Generate. See Authentication.
Germany — XRechnung & ZUGFeRD
Validate XRechnung POST
Purpose of use: Validate XRechnung XML before submission. Empty error list = valid document.
Endpoint Information
| Property | Value |
|---|---|
| URL | /invoice/validate-xrechnung |
| Method | POST |
| Content-Type | application/xml (raw XML body) |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Generate ZUGFeRD XML POST
Endpoint Information
| Property | Value |
|---|---|
| URL | /invoice/generate-zugferd-xml |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Request body: UBL/JSON invoice data.
Validate ZUGFeRD PDF POST
Endpoint Information
| Property | Value |
|---|---|
| URL | /invoice/validate-zugferd-pdf |
| Method | POST |
| Content-Type | multipart/form-data |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Form field: file — PDF (multipart).
Merge ZUGFeRD PDF + XML POST
Purpose of use: Embed XML into PDF to produce PDF/A-3 ZUGFeRD with embedded factur-x.xml.
Endpoint Information
| Property | Value |
|---|---|
| URL | /invoice/merge-zugferd-pdf-xml |
| Method | POST |
| Content-Type | application/json |
| Base URL | Stage Environment URLhttps://app-stage.docnova.ai/ Production Environment URLhttps://api.docnova.ai/ |
| Authorization | Bearer JWT |
Request body (JSON)
{
"base64Pdf": "JVBERi0xLj...",
"base64Xml": "PD94bWwgdm..."
}
Request parameters
| Field | Type | Required | Description |
|---|---|---|---|
| base64Pdf | String | Yes | Base64 PDF |
| base64Xml | String | Yes | Base64 ZUGFeRD/Factur-X XML |
Example response
{
"data": "JVBERi0xLj...",
"file_type": "PDF"
}