Breaking Changes Q1 2026

February 19, 2026 - One minute read - 154 words

PDF Rendering Endpoints Will Return Full PDFs

Current Behavior:

The endpoints render, changeParameter, and sendByWithRender currently return the rendered PDF document as a series of Base64-encoded images per default.

Example:

{
  "objects": {
    ...
    "thumbs": [
      "base64 image of page 1",
      "base64 image of page 2"
    ],
    "pages": 2,
    ...
  }
}

New Behavior:

The thumbs and pages properties will be removed. Instead, the complete pdf will be returned as a single Base64-encoded string.

Example:

{
  "objects": {
    ...
    "pdf": "base64 pdf",
    ...
  }
}

How to Prepare:

You can start using the new response format now by passing the parameter getAsPdf=true to the respective endpoints.

After the breaking change goes live, these parameters will be ignored and can be removed from your requests. The new behavior (returning the full PDF) will become the default.

Affected Endpoints:

/api/v1/CreditNote/{creditNoteId}/render
/api/v1/Invoice/{invoiceId}/render
/api/v1/Letter/{letterId}/render
/api/v1/Order/{orderId}/render
/api/v1/CreditNote/{creditNoteId}/changeParameter
/api/v1/Invoice/{invoiceId}/changeParameter
/api/v1/Letter/{letterId}/changeParameter
/api/v1/Order/{orderId}/changeParameter
/api/v1/CreditNote/{creditNoteId}/sendByWithRender
/api/v1/Invoice/{invoiceId}/sendByWithRender
/api/v1/Letter/{letterId}/sendByWithRender
/api/v1/Order/{orderId}/sendByWithRender

Release Date: April 07, 2026