Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Fiscal Documents

Get available transactions for fiscal documents

Retrieves a paginated list of available transactions for a source based on the document type.

  • For INVOICE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled
  • For CREDIT_NOTE: Returns posted (paid) transactions, and pending transactions when feature.fiscal-document.pending-transactions is enabled
  • For PRO_FORMA_INVOICE: Returns both pending transactions and posted (paid) payments
  • Transactions already included in fiscal documents are excluded unless show_invoiced=true
  • Each transaction includes a status field (PENDING or POSTED)
get/fiscal-document/v1/fiscal-documents/transactions

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.

pageTokenstring

Token for fetching the next page, as per cursor-based pagination.

limitinteger

Number of results to return per page.

sourceIdinteger required

source ID.

sortstring
Example:createdAt:desc

Supported fields - createdAt, serviceDate, sourceId, transactionDate, internalCode

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

Kind of the source entity

Filter by source kind.

folioIdsinteger[]

Filter by folio IDs.

nestTaxesboolean

When true, tax transactions are nested inside their parent transaction's taxes field and removed from the top-level list.

showInvoicedboolean

When true, transactions already included in fiscal documents are not filtered out.

Headers

X-Property-IDinteger required

Property id

Response

OK

nextPageTokenstring

Token for fetching the next page of results