Updates a config of a specific kind

put

https://api.cloudbeds.com/fiscal-document/v1/configs/{documentKind}

Update document config.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

documentKind

string

enum

required

The kind of the fiscal document.

Body Params

triggerEvents

array of objects

triggerEvents

Allowed:

showDetailedTaxFee

boolean

required

chargeBreakdown

boolean

required

allowPendingTransactions

boolean

useGuestLang

boolean

required

dueDays

int32

Defaults to 0

sequenceStartNumber

int64 | null

≥ 1

Defaults to null

lang

string | null

prefix

string | null

separator

string | null

suffix

string | null

legalCompanyName

string | null

title

object | null

showLegalCompanyName

boolean

required

Defaults to false

Show the company block (legal company name, tax IDs, registered legal address).

showPropertyDetails

boolean | null

Show the property block. Keep optional (never required): when omitted the stored value is
preserved (a brand-new config defaults to true). At least one of the two blocks must show.

includeRoomNumber

boolean

required

Defaults to false

useDocumentNumber

boolean

required

updateInvoiceOnLinkDocument

boolean

Defaults to false

isCompact

boolean

required

Defaults to false

useInvoiceTitleAndNumbering

boolean

Defaults to false

Flag to determine if invoice title, sequenceStartNumber, prefix and suffix should be used.

useInvoiceDocumentSettings

boolean

Defaults to false

Flag to determine if invoice document settings should be used.

showCreditNotesAndReceipts

boolean

Defaults to false

Flag to determine if linked credit notes and receipts should be rendered in Invoice.

taxId1

string | null

taxId2

string | null

cpf

string | null

companyCountry

string | null

Registered legal address country (ISO code). Part of the company block.

companyAddress

string | null

Registered legal address street. Part of the company block.

companyState

string | null

Registered legal address state/province. Part of the company block.

companyCity

string | null

Registered legal address city. Part of the company block.

companyPostCode

string | null

Registered legal address post code. Part of the company block.

customText

object | null

logoId

int64 | null

dateDisplay

string

enum

Defaults to transaction_date

Controls which date columns to show on the document

Allowed:

simplifiedEnabled

boolean | null

Whether simplified invoices are enabled for this property (INVOICE kind). When true,
simplifiedThreshold (unless the country enforces one) and simplifiedThresholdAction are
required.

simplifiedThreshold

number

Simplified-invoice monetary threshold in the property currency (INVOICE kind). Optional;
required when enabled and the threshold is editable. Ignored for countries with a
backend-enforced threshold or countries that don't support simplified invoices.

simplifiedThresholdAction

string

enum

Behaviour when a transaction total exceeds the simplified-invoice threshold (INVOICE
kind). Optional; required when enabled.

Allowed:

Headers

X-Property-ID

int64

required

≥ 1

Property id

Response

200OK