CLcloudbeds
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

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/transactions/summary
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://api.cloudbeds.com/auth/oauth/authorize
      Token URL: https://api.cloudbeds.com/auth/oauth/token scopes: read:reservation

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.

transactionIdToDisplayAmountobject nullable

Map of transaction ID to amount in the invoice currency (major units, as in displayAmount) for partial transaction inclusion, recorded on the document exactly as given. Takes precedence over transactionIdToAmount for the same transaction. When the invoice currency is the property currency it behaves like transactionIdToAmount.

currencystring

Invoice currency to express the totals in. When provided, totals are converted from the property currency using the property's configured exchange rates. Defaults to the property currency when omitted.

Response

OK

chargesAndAdjustmentsstring
paidstring
refundedstring
totalstring
currencystring

Currency the totals are expressed in. For an existing document, the currency it was issued in; for a selection, the requested invoice currency (converted at the property's configured rates), otherwise the property currency.

propertyCurrencystring

The property's base currency code.

propertyCurrencyTotalstring

The total in the property's base currency, shown as a reference alongside the total when the totals are expressed in another currency.

exchangeRatestring

The property's configured rate from its base currency into the currency the totals are expressed in (1 base unit = exchangeRate units), the rate an invoice issued now is locked at. Absent when the totals are in the property currency or no rate is configured.

transactionCountinteger

Number of transactions the current selection resolves to. Lets the caller warn before submitting a selection that would be rejected for exceeding maxTransactions.

maxTransactionsinteger

Maximum number of transactions allowed on a single fiscal document.

replacedReceiptsstring[]

For an invoice selection on a property whose invoice replaces the receipts that already declared its charges: the receipts issuing it would void, by number (or id while one is still waiting for its number), in issue order. Absent when nothing would be replaced.

receiptReplacementConflictstring

Why an invoice over this selection could not replace the receipts behind it — a receipt still being signed, or a covered charge not taken in full. The same message the create request refuses with, so a client can block issuing before submit. Absent when it can.

Changes

No recorded changes to this operation across all 1 revision of this API.