Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Get totals of selected available transactions for fiscal documents

Get totals of selected available transactions for fiscal documents based on the document type. Supports partial transaction amounts via transactionIdToAmount.

post/fiscal-document/v1/fiscal-documents/transactions/summary

Headers

X-Property-IDinteger required

Property id

Request body

documentKind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

sourceIdinteger required

Source ID.

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

Kind of the source entity

folioIdsinteger[]

Filter by folio IDs.

excludeTransactionIdsinteger[]

Transaction IDs to exclude.

includeTransactionIdsinteger[]

Transaction IDs to include.

transactionIdToAmountobject nullable

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

Response

OK

chargesAndAdjustmentsstring
paidstring
refundedstring
totalstring