CLcloudbeds
Fiscal Documents

Get fiscal document preview of the type invoice

Get fiscal document preview of the type invoice.

post/fiscal-document/v1/fiscal-documents/invoice/preview

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/invoice/preview
  • 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: read:reservation

Headers

X-Property-IDinteger required

Property id

Request body

transactionIdToAmountobject nullable

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

transactionIdToDisplayAmountobject nullable

Map of transaction ID to amount in the invoice currency (major units, as in displayAmount) for partial transaction inclusion, recorded on the document exactly as given. Takes precedence over transactionIdToAmount for the same transaction. When the invoice currency is the property currency it behaves like transactionIdToAmount.

transactionIdsinteger[] required

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

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.

currencystring nullable

Invoice currency. Selected transactions are converted into this currency at creation using the property's current exchange rate, which is locked on the issued document, and the converted amounts are fiscalized. Defaults to the property currency when omitted.

folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

simplifiedboolean
packageBreakdownboolean nullable

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

dueDatePropertyTimezonestring date

Response

Successful file download

Changes

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