CLcloudbeds
Fiscal Documents

Get available transactions for fiscal documents

Retrieves a paginated list of available transactions for a source based on the document type.

  • For INVOICE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled
  • For CREDIT_NOTE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled
  • For PRO_FORMA_INVOICE: Returns both pending transactions and posted (paid) payments
  • Transactions already included in fiscal documents are excluded unless show_invoiced=true
  • Each transaction includes a status field (PENDING or POSTED)
get/fiscal-document/v1/fiscal-documents/transactions

Request

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

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

Kind of fiscal document

Document type for which transactions are related (deprecated, use documentKind instead).

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

Kind of fiscal document

Document type for which transactions are related.

pageTokenstring

Token for fetching the next page, as per cursor-based pagination.

limitinteger

Number of results to return per page.

sourceIdinteger required

source ID.

sortstring
Example:createdAt:desc

Supported fields - createdAt, serviceDate, sourceId, transactionDate, internalCode

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

Kind of the source entity

Filter by source kind.

folioIdsinteger[]

Filter by folio IDs.

nestTaxesboolean

When true, VAT tax transactions are nested inside their parent transaction's taxes field and removed from the top-level list. Only taxes whose configuration is classified as VAT are nested; everything else (city and municipal taxes, fees, custom item taxes not classified as VAT) stays in the top-level list with no link back to its parent, so the parent-child relationship for those has to be read from the same endpoint called without nestTaxes. A VAT tax is only ever returned together with its parent transaction: where the parent is not in the response, the tax is omitted entirely rather than returned at the top level.

showInvoicedboolean

When true, transactions already included in fiscal documents are not filtered out.

currencystring

Invoice currency to convert every transaction into. Each transaction's amount is converted to this currency using the property's current exchange rate and returned in the display* fields; the original amount and currency are also returned. When omitted, no conversion is applied.

Headers

X-Property-IDinteger required

Property id

Response

OK

nextPageTokenstring

Token for fetching the next page of results

Changes

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