CLcloudbeds
Fiscal Documents

Create a fiscal document of the type pro forma invoice

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
post/fiscal-document/v1/fiscal-documents/pro-forma-invoice

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/pro-forma-invoice
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
      Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: write:reservation

Headers

X-Property-IDinteger required

Property id

Request body

transactionIdsinteger[] required

List of pending transaction IDs to include in the pro forma invoice (deprecated, use includeTransactionIds instead)

transactionIdToAmountobject nullable

Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion

paymentIdsinteger[]

List of payment IDs associated with the pending transactions

sourceIdinteger required
sequenceIdinteger nullable
sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

Kind of the source entity

userIdinteger nullable

Ignored. The document is attributed to the authenticated user.

invoiceDatestring date

Date for the pro forma invoice (defaults to current date if not provided)

folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

emailsstring[] nullable

Optional list of email addresses to send the document to once it is ready

subjectstring nullable

Optional per-send override for the email subject. When omitted or blank, the subject is resolved from the property's email template, falling back to the service default. Supports the same [Placeholder] tokens as template subjects.

packageBreakdownboolean nullable

Per-document override for package breakdown. Null means use property default.

Response

OK

idstring
kind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

status'COMPLETED' | 'VOIDED' | 'PAID' | 'PENDING_INTEGRATION' | 'PARTIALLY_PAID' | 'COMPLETED_INTEGRATION' | 'FAILED_INTEGRATION' | 'CORRECTION_NEEDED' | 'CANCELED' | 'CANCEL_REQUESTED' | 'OPEN' | 'REQUESTED' | 'VOID_REQUESTED' | 'FAILED' | 'MANUALLY_RECONCILED' | 'REJECTED' | 'ACCEPTED' | 'PENDING_TRANSACTION' | 'ALLOCATED' | 'APPLIED'

Status of the fiscal document

linkedTostring

Example response

{
  "governmentIntegration": {
    "folioFiscal": "9B3E26F4-1234-4A5B-8C9D-ABCDEF012345",
    "ext": {
      "ar-arca-doc-type": "6",
      "arca-cae-expiry": "2026-10-02"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.