--- title: "Updates a config of a specific kind" method: PUT path: "/fiscal-document/v1/configs/{documentKind}" tags: ["Configs"] --- # Updates a config of a specific kind `PUT /fiscal-document/v1/configs/{documentKind}` ## Request - Base URL: `https://api.cloudbeds.com` - URL: `https://api.cloudbeds.com/fiscal-document/v1/configs/{documentKind}` - Auth: one of: - HTTP bearer - OAuth 2 - Authorization code: `https://api.cloudbeds.com/auth/oauth/authorize` - Token URL: `https://api.cloudbeds.com/auth/oauth/token` scopes: `write:reservation` Update document config. ## 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 ## Headers - `X-Property-ID` integer, required ## Request body - ConfigsUpdateRequest - `triggerEvents` DocumentTriggerEvent[] - `showDetailedTaxFee` boolean, required - `chargeBreakdown` boolean, required - `allowPendingTransactions` boolean - `useGuestLang` boolean, required - `dueDays` integer - `sequenceStartNumber` integer, nullable - `lang` string, nullable - `prefix` string, nullable - `separator` string, nullable - `suffix` string, nullable - `legalCompanyName` string, nullable - `title` object, nullable - `showLegalCompanyName` boolean, required: Show the company block (legal company name, tax IDs, registered legal address). - `showPropertyDetails` boolean, 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. - `includeRoomNumber` boolean, required - `useDocumentNumber` boolean, required - `updateInvoiceOnLinkDocument` boolean - `isCompact` boolean, required - `useInvoiceTitleAndNumbering` boolean: Flag to determine if invoice title, sequenceStartNumber, prefix and suffix should be used. - `useInvoiceDocumentSettings` boolean: Flag to determine if invoice document settings should be used. - `showCreditNotesAndReceipts` boolean: Flag to determine if linked credit notes and receipts should be rendered in Invoice. - `taxId1` string, nullable - `taxId2` string, nullable - `cpf` string, nullable - `companyCountry` string, nullable: Registered legal address country (ISO code). Part of the company block. - `companyAddress` string, nullable: Registered legal address street. Part of the company block. - `companyState` string, nullable: Registered legal address state/province. Part of the company block. - `companyCity` string, nullable: Registered legal address city. Part of the company block. - `companyPostCode` string, nullable: Registered legal address post code. Part of the company block. - `customText` object, nullable - `logoId` integer, nullable - `dateDisplay` 'service_date' | 'transaction_date' | 'both': Controls which date columns to show on the document - `lineGroupingSettings` LineGroupingSettings: New grouped line/POS rendering configuration. When absent on write the legacy boolean fields are used. - `defaultLineGrouping` 'NONE' | 'TRANSACTION' | 'RATE_PLAN_SHOW_ADDONS' | 'RATE_PLAN_HIDE_ADDONS', required - `allowedLineGroupings` LineGrouping[], required - `defaultPosGrouping` 'NONE' | 'CHECK_NUMBER', required - `allowedPosGroupings` PosGrouping[], required - `defaultGroupByRoom` boolean, required - `defaultGroupByBusinessDate` boolean, required - `vatDisplay` 'PER_LINE' | 'SUMMARY_ONLY', required - `simplifiedEnabled` boolean, nullable: 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. 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. ## Response `200` OK - ConfigsResponse - `propertyId` string - `documentKind` 'INVOICE' | 'CREDIT_NOTE' | 'RECEIPT' | 'RECTIFY_INVOICE' | 'PRO_FORMA_INVOICE' | 'REFUND_RECEIPT' | 'INVOICE_RECEIPT' | 'ADVANCE_INVOICE' | 'SETTLEMENT_INVOICE' | 'TAX_WITHHOLDING': Kind of fiscal document - `showDetailedTaxFee` boolean - `showCreditNotesAndReceipts` boolean - `chargeBreakdown` boolean - `useGuestLang` boolean - `allowPendingTransactions` boolean - `dueDays` integer - `lang` string - `prefix` string - `suffix` string - `separator` string - `legalCompanyName` string - `title` object - `showLegalCompanyName` boolean - `showPropertyDetails` boolean - `includeRoomNumber` boolean - `useDocumentNumber` boolean - `isCompact` boolean - `taxId1` string - `taxId2` string - `cpf` string - `companyCountry` string - `companyAddress` string - `companyState` string - `companyCity` string - `companyPostCode` string - `customText` object - `triggerEvents` DocumentTriggerEvent[] - `updateInvoiceOnLinkDocument` boolean - `useInvoiceDocumentSettings` boolean - `useInvoiceTitleAndNumbering` boolean - `dateDisplay` 'service_date' | 'transaction_date' | 'both': Controls which date columns to show on the document - `lineGroupingSettings` LineGroupingSettings: New grouped line/POS rendering configuration. When absent on write the legacy boolean fields are used. - `defaultLineGrouping` 'NONE' | 'TRANSACTION' | 'RATE_PLAN_SHOW_ADDONS' | 'RATE_PLAN_HIDE_ADDONS', required - `allowedLineGroupings` LineGrouping[], required - `defaultPosGrouping` 'NONE' | 'CHECK_NUMBER', required - `allowedPosGroupings` PosGrouping[], required - `defaultGroupByRoom` boolean, required - `defaultGroupByBusinessDate` boolean, required - `vatDisplay` 'PER_LINE' | 'SUMMARY_ONLY', required - `simplifiedSupported` boolean: Whether simplified invoices are supported for this property's country (INVOICE kind) - `simplifiedEnabled` boolean: Whether simplified invoices are enabled for this property (INVOICE kind) - `simplifiedThresholdEditable` boolean: 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. - `simplifiedThreshold` number, 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. - `simplifiedThresholdMax` number, 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) --- [API](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api.md) - [All operations](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cloudbeds/apis/fiscal-document-service-api/revisions/9c2a47775e5e?raw)