Get folio list of transactions exported as PDF

post

https://api.cloudbeds.com/fiscal-document/v1/folio-export/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

groupBy

string

enum

Field to group the rendered transactions by. As groupBy, each group is followed by a subtotal row, a single group included, and the final row is the grand total. Groups keep the order in which they first appear under the requested sort, and transaction_date groups by the posting date. As subGroupBy, rows are ordered by this field inside each group (ignored without groupBy). Both are ignored for properties without the feature.accounting.folio-export-grouping flag. The plain names mirror the groupBy of POST /accounting/v1.0/folios/transactions and group as that folio table does: every pending row goes into one leading group. The *_legacy names group as the legacy folio screens do: pending rows stay in their groups, room_name_legacy puts a reservation payment under N/A unless the reservation has exactly one assigned room, description_filter_legacy groups by transaction type (so "Room rate - Queen" and "Room rate - King" both fall under "rate"), and transaction_datetime_legacy groups by the posting time to the second, as the group profile folio does. Whether pending rows are lifted follows groupBy.

subGroupBy

string

enum

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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/octet-stream

200Successful file download