CLcloudbeds
Fiscal Documents

Get fiscal document preview of the type credit note

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
    • 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

sequenceIdinteger nullable
invoiceIdinteger required
reasonstring nullable
userIdinteger nullable

Ignored. The document is attributed to the authenticated user.

method'VOID' | 'ADJUSTMENT' required
transactionIdsinteger[]

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

folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

packageBreakdownboolean nullable

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

Response

Successful file download

Changes

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