---
title: "PUT /clinic-config/document-layout — replaces the PDF layout (ITE-1334). Every field is written, so a later default change never silently flips a clinic's saved choice."
method: PUT
path: "/clinic-config/document-layout"
tags: ["ClinicConfig"]
---

# PUT /clinic-config/document-layout — replaces the PDF layout (ITE-1334). Every field is written, so a later default change never silently flips a clinic's saved choice.

`PUT /clinic-config/document-layout`

## Request

- Base URL: `https://api.clinicos.vet/backend/business`
- URL: `https://api.clinicos.vet/backend/business/clinic-config/document-layout`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/docs/clinic-config/document-layout/put.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- DocumentLayoutSettingsDto: Client-facing PDF layout (ITE-1334), with every default already resolved — what this says is what prints. Requires the `DocumentLayout` flag.
  - `invoice` InvoiceLayoutDto: Invoice, receipt and per-pet receipt layout.
    - `showPatientPhoto` boolean
    - `showPaymentDetails` boolean
    - `showNotes` boolean
    - `showProviders` boolean
    - `footerText` string, nullable: The clinic's footer line; null prints string? InvoiceLayoutDto.DefaultFooterText.
    - `defaultFooterText` string, nullable: Read-only: what the footer says when string? InvoiceLayoutDto.FooterText is blank.
  - `estimate` EstimateLayoutDto: Treatment plan (estimate) layout.
    - `showPatientPhoto` boolean
    - `footerText` string, nullable: The clinic's footer line; null prints none.
  - `letterhead` LetterheadLayoutDto: The letterhead on the fixed-layout client-facing PDFs (ITE-1173): invoice, receipt, treatment plan, client statement, record exports and consent documents.
    - `showLogo` boolean: Print a logo in the header. With no logo in the Logo Library the header is text only.
    - `logoId` string, nullable: The Logo Library logo to print; null prints the logo marked as default.
    - `footerText` string, nullable: A clinic line at the foot of every page; null prints none.

## Response `200`

OK

- DocumentLayoutSettingsDto: Client-facing PDF layout (ITE-1334), with every default already resolved — what this says is what prints. Requires the `DocumentLayout` flag.
  - `invoice` InvoiceLayoutDto: Invoice, receipt and per-pet receipt layout.
    - `showPatientPhoto` boolean
    - `showPaymentDetails` boolean
    - `showNotes` boolean
    - `showProviders` boolean
    - `footerText` string, nullable: The clinic's footer line; null prints string? InvoiceLayoutDto.DefaultFooterText.
    - `defaultFooterText` string, nullable: Read-only: what the footer says when string? InvoiceLayoutDto.FooterText is blank.
  - `estimate` EstimateLayoutDto: Treatment plan (estimate) layout.
    - `showPatientPhoto` boolean
    - `footerText` string, nullable: The clinic's footer line; null prints none.
  - `letterhead` LetterheadLayoutDto: The letterhead on the fixed-layout client-facing PDFs (ITE-1173): invoice, receipt, treatment plan, client statement, record exports and consent documents.
    - `showLogo` boolean: Print a logo in the header. With no logo in the Logo Library the header is text only.
    - `logoId` string, nullable: The Logo Library logo to print; null prints the logo marked as default.
    - `footerText` string, nullable: A clinic line at the foot of every page; null prints none.

## Changes

- **2026-10-28** `099cf36186e0`: 6 info
  - added the new optional request property `letterhead` (media type: application/json)
  - added the new optional request property `letterhead` (media type: text/json)
  - added the new optional request property `letterhead` (media type: application/*+json)
  - added the optional property `letterhead` to the response with the `200` status (media type: text/plain)
  - …2 more
- **2026-10-11** `f7ab358172d0`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/changes/clinic-config/document-layout/put.md)

---

[API](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1.md) - [All operations](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/clinicos/apis/pawthosx-business-api-v1/revisions/099cf36186e0?raw)