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.

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

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

dateTo

date | null

Maximum date filter (inclusive), optional.

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

Bearer

JWT

Loading…

Response

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

application/octet-stream

200Successful file download