CLcloudbeds
Configs

Updates a config of a specific kind

Update document config.

put/fiscal-document/v1/configs/{documentKind}

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/fiscal-document/v1/configs/{documentKind}
  • 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: write:reservation

Path parameters

documentKind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING' required

Kind of fiscal document

The kind of the fiscal document.

Headers

X-Property-IDinteger required

Property id

Request body

triggerEventsDocumentTriggerEvent[]
showDetailedTaxFeeboolean required
chargeBreakdownboolean required
allowPendingTransactionsboolean
useGuestLangboolean required
dueDaysinteger
sequenceStartNumberinteger nullable
langstring nullable
prefixstring nullable
separatorstring nullable
suffixstring nullable
legalCompanyNamestring nullable
titleobject nullable
showLegalCompanyNameboolean required

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

showPropertyDetailsboolean nullable

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.

includeRoomNumberboolean required
useDocumentNumberboolean required
updateInvoiceOnLinkDocumentboolean
isCompactboolean required
useInvoiceTitleAndNumberingboolean

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

useInvoiceDocumentSettingsboolean

Flag to determine if invoice document settings should be used.

showCreditNotesAndReceiptsboolean

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

taxId1string nullable
taxId2string nullable
cpfstring nullable
companyCountrystring nullable

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

companyAddressstring nullable

Registered legal address street. Part of the company block.

companyStatestring nullable

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

companyCitystring nullable

Registered legal address city. Part of the company block.

companyPostCodestring nullable

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

customTextobject nullable
logoIdinteger nullable
dateDisplay'service_date' | 'transaction_date' | 'both'

Controls which date columns to show on the document

simplifiedEnabledboolean nullable

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

simplifiedThresholdnumber

Simplified-invoice monetary threshold in the property currency (INVOICE kind). Optional; required when enabled and the threshold is editable. Silently ignored rather than rejected where the country fixes the threshold itself (simplifiedThresholdEditable false) or does not support simplified invoices at all, because in those cases there is nothing to store. Must not exceed simplifiedThresholdMax when one is returned; a higher value is rejected with 400.

simplifiedThresholdAction'NOTICE_ONLY' | 'WARN_SWITCH'

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

Example request

{
  "title": {
    "en": "Invoice",
    "es": "Factura"
  }
}

Response

OK

propertyIdstring
documentKind'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING'

Kind of fiscal document

showDetailedTaxFeeboolean
showCreditNotesAndReceiptsboolean
chargeBreakdownboolean
useGuestLangboolean
allowPendingTransactionsboolean
dueDaysinteger
langstring
prefixstring
suffixstring
separatorstring
legalCompanyNamestring
titleobject
showLegalCompanyNameboolean
showPropertyDetailsboolean
includeRoomNumberboolean
useDocumentNumberboolean
isCompactboolean
taxId1string
taxId2string
cpfstring
companyCountrystring
companyAddressstring
companyStatestring
companyCitystring
companyPostCodestring
customTextobject
triggerEventsDocumentTriggerEvent[]
updateInvoiceOnLinkDocumentboolean
useInvoiceDocumentSettingsboolean
useInvoiceTitleAndNumberingboolean
dateDisplay'service_date' | 'transaction_date' | 'both'

Controls which date columns to show on the document

simplifiedSupportedboolean

Whether simplified invoices are supported for this property's country (INVOICE kind)

simplifiedEnabledboolean

Whether simplified invoices are enabled for this property (INVOICE kind)

simplifiedThresholdEditableboolean

Whether the property may choose the simplified threshold. false means the country fixes it in regulation, so the threshold returned below is that country-fixed value: render it read-only and do not send one on save.

simplifiedThresholdnumber nullable

Effective simplified-invoice threshold in the property currency (INVOICE kind): the country-fixed value where the country fixes one, otherwise the property-configured value. Null when not configured.

simplifiedThresholdMaxnumber nullable

Statutory ceiling for the simplified-invoice threshold in the property currency (INVOICE kind). The property may configure any amount up to this; a higher value is rejected on save. Null when the country has no legal limit (e.g. Italy) or does not support simplified invoices at all.

simplifiedThresholdAction'NOTICE_ONLY' | 'WARN_SWITCH' nullable

Behaviour when the total exceeds the simplified-invoice threshold (INVOICE kind)

Changes

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