---
title: "Create a fiscal document of the type pro forma invoice"
method: POST
path: "/fiscal-document/v1/fiscal-documents/pro-forma-invoice/preview"
tags: ["Fiscal Documents"]
---

# Create a fiscal document of the type pro forma invoice

`POST /fiscal-document/v1/fiscal-documents/pro-forma-invoice/preview`

Create a fiscal document of the type pro forma invoice.

**Pro Forma Invoice Characteristics:**
- Contains pending transactions that are subject to change
- Includes payment information
- Transactions are NOT locked (unlike regular invoices)
- Can be converted to regular invoices later when transactions are posted
- Has its own sequence numbering and settings

## Headers

- `X-Property-ID` integer, required

## Request body

- ProFormaInvoicePreviewRequest
  - `transactionIds` integer[], required — List of pending transaction IDs to include in the pro forma invoice (deprecated, use `includeTransactionIds` instead)
  - `transactionIdToAmount` object, nullable — Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion
  - `paymentIds` integer[] — List of payment IDs associated with the pending transactions
  - `sourceId` integer, required
  - `sequenceId` integer, nullable
  - `sourceKind` 'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER', required — Kind of the source entity
  - `userId` integer, nullable
  - `recipient` RecipientRequest, required
    - `type` 'GUEST' | 'CONTACT' | 'GROUP' | 'COMPANY' | 'GROUP_PROFILE' | 'GROUP_PROFILE_CONTACT', required — Type of the recipient.
    - `id` integer, required — ID of the recipient, references guestId, contactId, groupId, etc. depending on type.
    - `taxDocumentSource` 'GUEST_TAX_ID' | 'GUEST_DOCUMENT_NUMBER' — Source of the tax document number.
  - `invoiceDate` string, date — Date for the pro forma invoice (defaults to current date if not provided)
  - `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

## Response `200`

Successful file download

---

[API](https://skmtc.net/cloudbeds/apis/cloudbeds-api.md) · [All operations](https://skmtc.net/cloudbeds/apis/cloudbeds-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cloudbeds/cloudbeds-api/revisions/2faa857793e8/schema)