Fiscal Documents

Get list of transactions for a given fiscal document id

Retrieves a paginated list of available transactions for fiscal document id.

get/fiscal-document/v1/fiscal-documents/{id}/transactions

Request

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

Path parameters

idstring required

Unique ID of the fiscal document to download.

Query parameters

pageTokenstring

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

includeLinkedDocumentTransactionsboolean

Include transactions from linked documents.

sortstring
Example:createdAt:desc

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

limitinteger

Number of results to return per page.

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 part of the document, the tax is omitted from the response entirely rather than returned at the top level.

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, only a document issued in another currency is converted (see displayDocumentFiscalizedAmount).

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.