Get fiscal document preview of the type invoice

post

https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/invoice/preview

Get fiscal document preview of the type invoice.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

transactionIdToAmount

object | null

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

transactionIds

array of int64s

required

deprecated

Include transactions with the specified IDs (deprecated, use includeTransactionIds instead)

transactionIds*

sourceId

int64

required

≥ 1

sequenceId

int64 | null

≥ 1

sourceKind

string

enum

required

Kind of the source entity

Allowed:

userId

int64 | null

≥ 0

currency

string | null

Invoice currency. Selected transactions are converted into this currency at creation using the property's current exchange rate, which is locked on the issued document, and the converted amounts are fiscalized. Defaults to the property currency when omitted.

recipient

object

manualRecipient

object

folioIds

array of int64s

Include all transactions from the specified folio IDs

folioIds

excludeTransactionIds

array of int64s

Exclude transactions with the specified IDs

excludeTransactionIds

includeTransactionIds

array of int64s

Include transactions with the specified IDs

includeTransactionIds

simplified

boolean

Defaults to false

packageBreakdown

boolean | null

Per-document override for package breakdown. Null means use property default.

dueDatePropertyTimezone

date

Headers

X-Property-ID

int64

required

≥ 1

Property id

Responses

400

The property reports to a fiscal journal that admits no unissued document, so nothing
may be rendered before it is issued. No document was created or submitted.

Language

Credentials

Loading…

Response

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

application/octet-stream

200Successful file download