CLcloudbeds
Configs

Get PDF document preview

Build and return PDF document

get/fiscal-document/v1/configs/preview

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/configs/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

Query parameters

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

Kind of fiscal document

sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER'

Kind of the source entity

recipientType'COMPANY' | 'PERSON' | 'MANUAL'
includeVatboolean

Include VAT tax breakdown section in preview

includePaymentsboolean

Include payment transactions section in preview

includeRoomNumberboolean

Include room number column in reservation previews

previewWatermarkboolean

Show preview watermark on the document

Headers

X-Property-IDinteger required

Property id

Response

Successful file download

Changes

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