---
title: "Get fiscal document preview of the type credit note"
method: POST
path: "/fiscal-document/v1/fiscal-documents/credit-note/preview"
tags: ["Fiscal Documents"]
---

# Get fiscal document preview of the type credit note

`POST /fiscal-document/v1/fiscal-documents/credit-note/preview`

## Request

- Base URL: `https://api.cloudbeds.com`
- URL: `https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/credit-note/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`

Get fiscal document preview of the type credit note.

## Headers

- `X-Property-ID` integer, required

## Request body

- GetCreditNotePreviewRequest
  - `sequenceId` integer, nullable
  - `invoiceId` integer, required
  - `reason` string, nullable
  - `userId` integer, nullable: Ignored. The document is attributed to the authenticated user.
  - `method` 'VOID' | 'ADJUSTMENT', required
  - `transactionIds` integer[]: Include transactions with the specified IDs (deprecated, use `includeTransactionIds` instead)
  - `folioIds` integer[]: Include all transactions from the specified folio IDs
  - `excludeTransactionIds` integer[]: Exclude transactions with the specified IDs
  - `includeTransactionIds` integer[]: Include transactions with the specified IDs
  - `packageBreakdown` boolean, nullable: Per-document override for package breakdown. Null means use property default.

## Response `200`

Successful file download

## Other responses

- `400`: The property reports to a fiscal journal that admits no unissued document, so nothing may be rendered before it is issued. No document was created or submitted.

---

[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)