Create a fiscal document of the type credit note

post

https://api.cloudbeds.com/fiscal-document/v1/fiscal-documents/credit-note

Create a fiscal document of the type credit note.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

sequenceId

int64 | null

≥ 1

invoiceId

int64

required

≥ 1

reason

string | null

note

string | null

userId

int64 | null

≥ 0

method

string

enum

required

Allowed:

transactionIds

array of int64s

deprecated

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

transactionIds

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

packageBreakdown

boolean | null

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

Headers

X-Property-ID

int64

required

≥ 1

Property id

Responses

409

The source's transactions are being reconciled, or pending transaction discrepancies were
found. The credit note was not created — retry the request.

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