ZugferdCreate

Create ZUGFeRD PDF from documents

POST

https://api.365businessapi.com

/api/v4/pdf/zugferd/create

key (query)

Create ZUGFeRD PDF from documents › Request Body

Represents a PDF Merge V4 Request

businessdev.API.Models.Pdf.v4.Merge.MergeRequest

businessdev.Pdf.Model.IDocumentSettings

array | null

copies

integer · int32

copyOrder

businessdev.Pdf.Model.Enums.Merge.CopyOrder · enum

Enum values:

Collated

Grouped

Create ZUGFeRD PDF from documents › Responses

200

businessdev.WebApi.Model.Pdf.v3.Response

businessdev.WebApi.BaseModel.Common.v2.File

status

businessdev.WebApi.BaseModel.Enums.BaseResponse.Result · enum

Enum values:

None

Error

NotFound

BadRequest

UnauthorizedAccess

DebugSessionResult

TooManyRequests

processingTimeInMilliseconds

integer · int64

POST/api/v4/pdf/zugferd/create

curl 'https://api.365businessapi.com/api/v4/pdf/zugferd/create?key=<api-key>' \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "documentSettings": {
    "conformanceLevel": "None",
    "compress": false,
    "title": "<title>",
    "attachments": [
      {
        "fileName": "<fileName>",
        "description": "<description>",
        "mimeType": "<mimeType>",
        "modificationDate": "2026-10-31T12:00:00Z",
        "data": "BASE64_ENCODED_FILE",
        "relationship": "Source"
      }
    ],
    "zugferdOptions": {
      "version": "V1",
      "conformanceLevel": "None",
      "fileName": "<fileName>",
      "description": "<description>",
      "mimeType": "<mimeType>",
      "modificationDate": "2026-10-31T12:00:00Z",
      "data": "BASE64_ENCODED_FILE",
      "relationship": "Source"
    },
    "signingOptions": {
      "data": "BASE64_ENCODED_FILE",
      "password": "<password>"
    },
    "brandingOptions": {
      "creatorTool": "<creatorTool>",
      "producer": "<producer>"
    },
    "securityOptions": {
      "mode": "Open",
      "permissions": "Default",
      "ownerPassword": "<ownerPassword>",
      "userPassword": "<userPassword>"
    }
  },
  "fileMergeOptions": [
    {
      "data": "BASE64_ENCODED_FILE",
      "rotation": "None"
    }
  ],
  "copies": 1,
  "copyOrder": "Collated"
}'

Example Request Body

{
  "documentSettings": {
    "conformanceLevel": "None",
    "compress": false,
    "title": "<title>",
    "attachments": [
      {
        "fileName": "<fileName>",
        "description": "<description>",
        "mimeType": "<mimeType>",
        "modificationDate": "2026-10-31T12:00:00Z",
        "data": "BASE64_ENCODED_FILE",
        "relationship": "Source"
      }
    ],
    "zugferdOptions": {
      "version": "V1",
      "conformanceLevel": "None",
      "fileName": "<fileName>",
      "description": "<description>",
      "mimeType": "<mimeType>",
      "modificationDate": "2026-10-31T12:00:00Z",
      "data": "BASE64_ENCODED_FILE",
      "relationship": "Source"
    },
    "signingOptions": {
      "data": "BASE64_ENCODED_FILE",
      "password": "<password>"
    },
    "brandingOptions": {
      "creatorTool": "<creatorTool>",
      "producer": "<producer>"
    },
    "securityOptions": {
      "mode": "Open",
      "permissions": "Default",
      "ownerPassword": "<ownerPassword>",
      "userPassword": "<userPassword>"
    }
  },
  "fileMergeOptions": [
    {
      "data": "BASE64_ENCODED_FILE",
      "rotation": "None"
    }
  ],
  "copies": 1,
  "copyOrder": "Collated"
}

json

application/json

Example Responses

{
  "file": {
    "mime": "mime",
    "data": "U3dhZ2dlcg=="
  },
  "status": "None",
  "processingTimeInMilliseconds": 0
}

json

application/json

Upgrade ZugferdExtractInvoice