Get list of transactions for a given fiscal document id

get

https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/{id}/transactions

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

length ≥ 1

Unique ID of the fiscal document to download.

Query Params

pageToken

string

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

includeLinkedDocumentTransactions

boolean

Defaults to false

Include transactions from linked documents.

sort

string

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

limit

int32

1 to 100

Defaults to 20

Number of results to return per page.

folioIds

array of int64s

length ≥ 1

Filter by folio IDs.

folioIds

nestTaxes

boolean

Defaults to false

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.

currency

string

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

int64

required

≥ 1

Property id

Response

200OK