Embed a Factur-X/Zugferd XML into an existing PDF.

POST 
/business/facturx/embed

Factur-X/Zugferd is a standard for digital invoices. The data is encoded into an XML, which is attached to a human-readable PDF file. This endpoint embeds an existing XML invoice into a PDF file which is not yet a Factur-X/Zugferd invoice. It also validates that the XML is valid. To create a valid Factur-X/Zugferd invoice, the user has to guarantee that the provided PDF is in PDF/A format.

Request

Header Parameters

ipaas string

application/json

Bodyrequired

urlstring

The PDF URL.

bufferstring

The Base64-encoded PDF file. Can be specified instead of url.

xmlstringrequired

The Factur-X/Zugferd XML invoice that shall be embedded.

getAsUrlboolean

Whether the PDF should be returned as a URL. Default is false.

fileNamestring

The PDF file name. Default is a random ID.

Responses

200

Success

application/json

Schema

Schema

object

Example (auto)

{}

400

Bad Request

application/json

Schema

Schema

statusnumber
errorMessagestring

Example (auto)

{
  "status": 0,
  "errorMessage": "string"
}