---
title: "Get PDF document preview"
method: GET
path: "/fiscal-document/v1/configs/preview"
tags: ["Configs"]
---

# Get PDF document preview

`GET /fiscal-document/v1/configs/preview`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/fiscal-document/v1/configs/preview`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize`
    - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `read:reservation`

Build and return PDF document

## Query parameters

- `previewRequest` PreviewRequest
  - `documentKind` 'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING': Kind of fiscal document
  - `sourceKind` 'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER': Kind of the source entity
  - `recipientType` 'COMPANY' | 'PERSON' | 'MANUAL'
  - `includeVat` boolean: Include VAT tax breakdown section in preview
  - `includePayments` boolean: Include payment transactions section in preview
  - `includeRoomNumber` boolean: Include room number column in reservation previews
  - `previewWatermark` boolean: Show preview watermark on the document

## Headers

- `X-Property-ID` integer, required

## Response `200`

Successful file download

---

[API](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/revisions/9c2a47775e5e?raw)
