v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Export

Export folio transactions as PDF

Export folio list of transactions as PDF

post/fiscal-document/v1/folios/export

Headers

X-Property-IDinteger required

Property id

Accept-Languagestring

Desired language of exported PDF

Request body

folioIdsinteger[]

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

sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

Kind of the source entity

sourceIdinteger required

source ID of folio

creditDebitViewboolean

Should transactions be separated into debit/credits

revenueCompactboolean

Compact revenue transactions, valid only for sourceKind = RESERVATION

dateFromstring date nullable

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

dateTostring date nullable

Maximum date filter (inclusive), optional.

format'PDF' | 'XLSX'

Export file format

Example request

{
  "folioIds": [
    3774744,
    7763263217
  ]
}

Response

Successful file download