v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Get totals of selected available transactions for fiscal documents (deprecated)

Deprecated: Use POST /fiscal-document/v1/fiscal-documents/transactions/summary instead. Get totals of selected available transactions for fiscal documents based on the document type.

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

Query parameters

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

Kind of fiscal document

Document type for which transactions are related (deprecated, use documentKind instead).

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

Kind of fiscal document

Document type for which transactions are related.

sourceIdinteger required

source ID.

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

Kind of the source entity

Filter by source kind.

folioIdsinteger[]

Filter by folio IDs.

excludeTransactionIdsinteger[]

transaction IDs to exclude.

includeTransactionIdsinteger[]

transaction IDs to include.

Headers

X-Property-IDinteger required

Property id

Response

OK

chargesAndAdjustmentsstring
paidstring
refundedstring
totalstring