v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Get fiscal document preview of the type invoice

Get fiscal document preview of the type invoice.

post/fiscal-document/v1/fiscal-documents/invoice/preview

Headers

X-Property-IDinteger required

Property id

Request body

transactionIdToAmountobject nullable

Map of transaction ID to amount (in major currency units, e.g., 10.50 for $10.50) for partial transaction inclusion

transactionIdsinteger[] required

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

sourceIdinteger required
sequenceIdinteger nullable
sourceKind'GROUP_PROFILE' | 'RESERVATION' | 'HOUSE_ACCOUNT' | 'ACCOUNTS_RECEIVABLE_LEDGER' required

Kind of the source entity

userIdinteger nullable
folioIdsinteger[]

Include all transactions from the specified folio IDs

excludeTransactionIdsinteger[]

Exclude transactions with the specified IDs

includeTransactionIdsinteger[]

Include transactions with the specified IDs

simplifiedboolean
dueDatePropertyTimezonestring date

Response

Successful file download