API Reference

Export folio transactions as PDF

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

Export folio list of transactions as PDF

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
folioIds
array of int64s

Include transactions from the specified folio IDs. If omitted, all transactions for the source are included.

folioIds
string
enum
required

Kind of the source entity

Allowed:
int64
required

source ID of folio

boolean

Should transactions be separated into debit/credits

boolean

Compact revenue transactions, valid only for sourceKind = RESERVATION

date | null

Minimum date filter (inclusive). Required for sourceKind = HOUSE_ACCOUNT, optional for others.

date | null

Maximum date filter (inclusive), optional.

string
enum

Export file format

Allowed:
recipient
object
Headers
int64
required
≥ 1

Property id

string

Desired language of exported PDF

Response

Updated 3 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/octet-stream

Updated 3 months ago

Did this page help you?