Get totals of selected available transactions for fiscal documents

post

https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/transactions/summary

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

documentKind

string

enum

Document type for which transactions are related.

sourceId

int64

required

≥ 1

Source ID.

sourceKind

string

enum

required

Filter by source kind.

Allowed:

folioIds

array of int64s

length ≥ 1

Filter by folio IDs.

folioIds

excludeTransactionIds

array of int64s

length ≥ 1

Transaction IDs to exclude.

excludeTransactionIds

includeTransactionIds

array of int64s

length ≥ 1

Transaction IDs to include.

includeTransactionIds

transactionIdToAmount

object | null

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

currency

string

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.

Headers

X-Property-ID

int64

required

≥ 1

Property id

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK