Export folio transactions as PDF

post

https://api.cloudbeds.com/fiscal-document/v1/folios/export

Export folio list of transactions as PDF

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

folioIds

array of int64s

Include transactions from the specified folio IDs. If omitted, all transactions for the source are included. The same filter set is applied to each selected folio.

folioIds

sourceKind

string

enum

required

Kind of the source entity

Allowed:

sourceId

int64

required

source ID of folio

creditDebitView

boolean

Should transactions be separated into debit/credits

revenueCompact

boolean

Compact revenue transactions, valid only for sourceKind = RESERVATION

dateFrom

date | null

Filter transactions with transaction datetime from this point (inclusive). Required for sourceKind = HOUSE_ACCOUNT, optional for others.

dateTo

date | null

Filter transactions with transaction datetime up to this point (inclusive).

searchQuery

string | null

Case-insensitive substring match on transaction description.

descriptionFilters

array of strings | null

Composite identifiers used to filter by transaction type. Accepts the same values as POST /accounting/v1.0/folios/transactions descriptionFilters: typed item ids ("product_123", "tax_456", "addon_789", "fee_101", "custom_item_202", "bookable_resource_303"), room revenue groups ("rate", "roomRevenue_manual", "roomRevenue_cancellation", "roomRevenue_no_show", "accountsReceivable"), or payment method codes ("cash", "ebanking", "cards_visa", "cards_master", "pay_pal").

descriptionFilters

posted

boolean | null

Tri-state. true = only posted, false = only pending, omit = both.

includeVoided

boolean

Defaults to true

Include voided transactions and their full chain. Default true.

subSourceIds

array of int64s | null

Filter by sub-source IDs (booking room IDs for RESERVATION sources). Mirrors the same filter on POST /accounting/v1.0/folios/transactions.

subSourceIds

sort

array of objects | null

Optional ordering applied to the rendered transactions. Field names mirror POST /accounting/v1.0/folios/transactions: transaction_datetime, service_date, internal_code, description, notes, quantity, amount. When omitted the renderer uses its template default order.

sort

format

string

enum

Export file format

Allowed:

recipient

object

Headers

X-Property-ID

int64

required

≥ 1

Property id

Accept-Language

string

Desired language of exported PDF

Response

200Successful file download