> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.monite.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.monite.com/_mcp/server. # Update entity settings PATCH https://api.sandbox.monite.com/v1/entities/{entity_id}/settings Content-Type: application/json Change the specified fields with the provided values. Reference: https://docs.monite.com/api/entities/patch-entities-id-settings ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Servers - `https://api.sandbox.monite.com/v1` (sandbox, default) - `https://api.monite.com/v1` (eu_production) - `https://us.api.monite.com/v1` (na_production) ## Request ### Path parameters - `entity_id` (string, required) — A unique ID to specify the entity. ### Headers - `x-monite-version` (string, required) ### Body (application/json) This endpoint expects an object. - `accounting` (AccountingSettings, optional) - `allow_purchase_order_autolinking` (boolean, optional) — Automatically attempt to find a corresponding purchase order for all incoming payables. - `currency` (CurrencySettingsInput, optional) - `document_ids` (DocumentIDsSettingsRequest, optional) - `document_rendering` (DocumentRenderingSettingsInput, optional) — Settings for rendering documents in PDF format. - `generate_paid_invoice_pdf` (boolean, optional, default: false) — This setting affects how PDF is generated for paid accounts receivable invoices. If set to `true`, once an invoice is fully paid its PDF version is updated to display the amount paid and the payment-related features are removed. The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document, and the original PDF invoice is no longer available. This field is deprecated and will be replaced by `document_rendering.invoice.generate_paid_invoice_pdf`. - `language` (enum, optional) - Allowed values: `ab`, `aa`, `af`, `ak`, `sq`, `am`, `ar`, `an`, `hy`, `av`, `ae`, `ay`, `az`, `bm`, `ba`, `eu`, `be`, `bn`, `bi`, `bs`, `br`, `bg`, `my`, `ca`, `ch`, `ce`, `ny`, `zh`, `cu`, `cv`, `kw`, `co`, `cr`, `hr`, `cs`, `da`, `dv`, `nl`, `dz`, `en`, `eo`, `et`, `ee`, `fo`, `fj`, `fi`, `fr`, `fy`, `ff`, `gd`, `gl`, `lg`, `ka`, `de`, `el`, `kl`, `gn`, `gu`, `ht`, `ha`, `he`, `hz`, `hi`, `ho`, `hu`, `io`, `ig`, `id`, `ia`, `ie`, `iu`, `ik`, `ga`, `it`, `ja`, `jv`, `kn`, `kr`, `ks`, `kk`, `km`, `ki`, `rw`, `ky`, `kv`, `kg`, `ko`, `kj`, `ku`, `lo`, `la`, `lv`, `li`, `ln`, `lt`, `lu`, `lb`, `mk`, `mg`, `ms`, `ml`, `mt`, `gv`, `mi`, `mr`, `mh`, `mn`, `na`, `nv`, `nd`, `nr`, `ng`, `ne`, `no`, `nb`, `nn`, `ii`, `oc`, `oj`, `om`, `os`, `pi`, `ps`, `fa`, `pl`, `pt`, `pa`, `qu`, `ro`, `rm`, `rn`, `ru`, `se`, `sm`, `sg`, `sa`, `sc`, `sr`, `sn`, `sd`, `si`, `sk`, `sl`, `so`, `st`, `es`, `su`, `sw`, `ss`, `sv`, `tl`, `ty`, `tg`, `ta`, `tt`, `te`, `th`, `bo`, `ti`, `to`, `ts`, `tn`, `tr`, `tk`, `tw`, `ug`, `uk`, `ur`, `uz`, `ve`, `vi`, `vo`, `wa`, `cy`, `wo`, `xh`, `yi`, `yo`, `za`, `zu` - `mail` (EntityMailSettings, optional) — Email settings for the entity - `payables_ocr_auto_tagging` (list of OcrAutoTaggingSettingsRequest, optional) — Auto tagging settings for all incoming OCR payable documents. - `payables_skip_approval_flow` (boolean, optional, default: false) — If enabled, the approval policy will be skipped and the payable will be moved to `waiting_to_be_paid` status. - `payment_priority` (enum, optional) — Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences. - Allowed values: `working_capital`, `balanced`, `bottom_line` - `quote_signature_required` (boolean, optional, default: false) — Sets the default behavior of whether a signature is required to accept quotes. - `receivable_edit_flow` (enum, optional) - Allowed values: `compliant`, `partially_compliant`, `non_compliant` - `reminder` (RemindersSettings, optional) - `vat_inclusive_discount_mode` (enum, optional) — Defines whether the amount discounts (for percentage discounts it does not matter) on VAT inclusive invoices will be applied on amounts including VAT or excluding VAT. - Allowed values: `exclusive`, `inclusive` - `vat_mode` (enum, optional) — Defines whether the prices of products in receivables will already include VAT or not. - Allowed values: `exclusive`, `inclusive` ## Response ### 200 Successful Response - `accounting` (AccountingSettings, optional) - `allow_purchase_order_autolinking` (boolean, optional) — Automatically attempt to find a corresponding purchase order for all incoming payables. - `api_version` (enum, optional) — Default API version for partner. - Allowed values: `2024-05-25`, `2024-01-31`, `2023-09-01`, `2023-06-04`, `2023-04-12`, `2023-03-14`, `2023-03-01`, `2023-02-07`, `2022-11-16` - `commercial_conditions` (list of string, optional) — Commercial conditions for receivables. - `currency` (CurrencySettingsOutput, optional) — Custom currency exchange rates. - `default_role` (map from string to any, optional) — A default role to provision upon new entity creation. - `document_ids` (DocumentIDsSettings, optional) - `document_rendering` (DocumentRenderingSettingsOutput, optional) — Settings for rendering documents in PDF format. - `generate_paid_invoice_pdf` (boolean, optional, default: false) — This setting affects how PDF is generated for paid accounts receivable invoices. If set to `true`, once an invoice is fully paid its PDF version is updated to display the amount paid and the payment-related features are removed. The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document, and the original PDF invoice is no longer available. This field is deprecated and will be replaced by `document_rendering.invoice.generate_paid_invoice_pdf`. - `language` (enum, optional) - Allowed values: `ab`, `aa`, `af`, `ak`, `sq`, `am`, `ar`, `an`, `hy`, `av`, `ae`, `ay`, `az`, `bm`, `ba`, `eu`, `be`, `bn`, `bi`, `bs`, `br`, `bg`, `my`, `ca`, `ch`, `ce`, `ny`, `zh`, `cu`, `cv`, `kw`, `co`, `cr`, `hr`, `cs`, `da`, `dv`, `nl`, `dz`, `en`, `eo`, `et`, `ee`, `fo`, `fj`, `fi`, `fr`, `fy`, `ff`, `gd`, `gl`, `lg`, `ka`, `de`, `el`, `kl`, `gn`, `gu`, `ht`, `ha`, `he`, `hz`, `hi`, `ho`, `hu`, `io`, `ig`, `id`, `ia`, `ie`, `iu`, `ik`, `ga`, `it`, `ja`, `jv`, `kn`, `kr`, `ks`, `kk`, `km`, `ki`, `rw`, `ky`, `kv`, `kg`, `ko`, `kj`, `ku`, `lo`, `la`, `lv`, `li`, `ln`, `lt`, `lu`, `lb`, `mk`, `mg`, `ms`, `ml`, `mt`, `gv`, `mi`, `mr`, `mh`, `mn`, `na`, `nv`, `nd`, `nr`, `ng`, `ne`, `no`, `nb`, `nn`, `ii`, `oc`, `oj`, `om`, `os`, `pi`, `ps`, `fa`, `pl`, `pt`, `pa`, `qu`, `ro`, `rm`, `rn`, `ru`, `se`, `sm`, `sg`, `sa`, `sc`, `sr`, `sn`, `sd`, `si`, `sk`, `sl`, `so`, `st`, `es`, `su`, `sw`, `ss`, `sv`, `tl`, `ty`, `tg`, `ta`, `tt`, `te`, `th`, `bo`, `ti`, `to`, `ts`, `tn`, `tr`, `tk`, `tw`, `ug`, `uk`, `ur`, `uz`, `ve`, `vi`, `vo`, `wa`, `cy`, `wo`, `xh`, `yi`, `yo`, `za`, `zu` - `mail` (MailSettings, optional) — Settings for email and mailboxes. - `payable` (PayableSettings, optional) — Settings for the payables module. - `payables_ocr_auto_tagging` (list of OcrAutoTaggingSettingsRequest, optional) — Auto tagging settings for all incoming OCR payable documents. - `payables_skip_approval_flow` (boolean, optional, default: false) — If enabled, the approval policy will be skipped and the payable will be moved to `waiting_to_be_paid` status. - `payment_priority` (enum, optional) — Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences. - Allowed values: `working_capital`, `balanced`, `bottom_line` - `payments` (PaymentsSettings, optional) — Settings for the payments module. - `quote_signature_required` (boolean, optional, default: false) — Sets the default behavior of whether a signature is required to accept quotes. - `receivable` (ReceivableSettings, optional) — Settings for the receivables module. - `receivable_edit_flow` (enum, optional) - Allowed values: `compliant`, `partially_compliant`, `non_compliant` - `reminder` (RemindersSettings, optional) - `units` (list of Unit, optional) — Measurement units. - `vat_inclusive_discount_mode` (enum, optional) — Defines whether the amount discounts (for percentage discounts it does not matter) on VAT inclusive invoices will be applied on amounts including VAT or excluding VAT. - Allowed values: `exclusive`, `inclusive` - `vat_mode` (enum, optional) — Defines whether the prices of products in receivables will already include VAT or not. - Allowed values: `exclusive`, `inclusive` - `website` (string, optional) ## Errors ### 400 Patch Entities ID Settings Request Bad Request Error Bad Request - `error` (ErrorSchema, required) ### 422 Patch Entities ID Settings Request Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 500 Patch Entities ID Settings Request Internal Server Error Internal Server Error - `error` (ErrorSchema, required) ## Types ### AccountingSettings - `ledger_account_ids` (DefaultLedgerAccountIDs, optional) — Default ledger accounts that will be used for various objects pushed into an accounting system. Use `GET /ledger_accounts` to get the IDs of these ledger accounts. - `tax_ids` (DefaultAccountingTaxIDs, optional) — Default accounting tax IDs that will be used for various objects pushed into an accounting system. Use `GET /accounting_tax_rates` to get the IDs of these taxes. ### CurrencySettingsInput - `default` (enum, required) - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `SVC`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW` - `exchange_rates` (list of ExchangeRate, optional) ### DocumentIDsSettingsRequest - `document_type_prefix` (DocumentTypePrefix, optional) — Prefixes for each document_type. - `include_date` (boolean, optional, default: false) — Optionally add 4-digit of the current year. - `min_digits` (integer, optional, default: 5) — Minimal size of number in document ID Number will be left padded with zeros if less. - `next_number` (DocumentIDsSettingsNextNumber, optional) — Write-only field. Changes which number will be issued next. Can't be less than the last issued document number. - `prefix` (string, optional) — Optional prefix. Does not substitute document_type prefix. - `separator` (enum, optional) — Which character should separate each part of the document_id. - Allowed values: `/`, `-`, `|`, `.`, `` ### DocumentRenderingSettingsInput Rendering settings that control how different parts of the PDF documents are displayed. Includes common settings for all document types such as quotes, invoices, and credit notes and document type-specific settings that are defined in their respective objects. - `credit_note` (CreditNoteRenderingSettings, optional) — Credit note-specific rendering settings for PDF documents. - `display_entity_bank_account` (boolean, optional, default: true) — If set to `true`, the entity's bank account details will be displayed on the PDF documents. Defaults to `true`. - `display_line_items` (boolean, optional, default: true) — If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. - `invoice` (InvoiceRenderingSettings, optional) — Invoice-specific rendering settings for PDF documents. - `line_items` (LineItemsRenderingSettings, optional) — Settings for rendering line items in PDF documents. - `quote` (QuoteRenderingSettings, optional) — Quote-specific rendering settings for PDF documents. ### EntityMailSettings Email settings for entity - `reply_to` (list of string, optional) — Reply-to email addresses for outgoing entity emails. When set, recipients can reply directly to these addresses instead of the sender's email address. Used for invoices, reminders, and other automated emails. ### OcrAutoTaggingSettingsRequest - `enabled` (boolean, required) — A switch to temporarily disable a keyword without removing it from the list. - `keywords` (list of string, required) — A list of words that will be searched for assigning a tag in the recognized fields of the document after OCR processing. If at least one match is found, the tag will be assigned. Each keyword must be between 2 and 25 characters long. - `tag_id` (string, required) — Tag identifier that will be assigned to the payable document if one of the words listed in keywords is found during OCR. ### RemindersSettings - `enabled` (boolean, optional, default: true) ### CurrencySettingsOutput - `default` (enum, required) - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `SVC`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW` - `exchange_rates` (list of ExchangeRate, optional) ### DocumentIDsSettings - `document_type_prefix` (DocumentTypePrefix, optional) — Prefixes for each document_type. - `include_date` (boolean, optional, default: false) — Optionally add 4-digit of the current year. - `min_digits` (integer, optional, default: 5) — Minimal size of number in document ID Number will be left padded with zeros if less. - `prefix` (string, optional) — Optional prefix. Does not substitute document_type prefix. - `separator` (enum, optional) — Which character should separate each part of the document_id. - Allowed values: `/`, `-`, `|`, `.`, `` ### DocumentRenderingSettingsOutput Rendering settings that control how different parts of the PDF documents are displayed. Includes common settings for all document types such as quotes, invoices, and credit notes and document type-specific settings that are defined in their respective objects. - `credit_note` (CreditNoteRenderingSettings, optional) — Credit note-specific rendering settings for PDF documents. - `display_entity_bank_account` (boolean, optional, default: true) — If set to `true`, the entity's bank account details will be displayed on the PDF documents. Defaults to `true`. - `display_line_items` (boolean, optional, default: true) — If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. - `invoice` (InvoiceRenderingSettings, optional) — Invoice-specific rendering settings for PDF documents. - `line_items` (LineItemsRenderingSettings, optional) — Settings for rendering line items in PDF documents. - `quote` (QuoteRenderingSettings, optional) — Quote-specific rendering settings for PDF documents. ### MailSettings - `attach_documents_as_pdf` (boolean, optional, default: true) — Attach documents as PDF in emails. - `from_email_username` (string, optional) - `from_name` (string, optional) ### PayableSettings - `approve_page_url` (string, required) - `allow_cancel_duplicates_automatically` (boolean, optional) - `allow_counterpart_autocreation` (boolean, optional) - `allow_counterpart_autolinking` (boolean, optional) - `default_state` (string, optional) — A state each new payable will have upon creation - `enable_line_items` (boolean, optional, default: true) — Partners can set this to True or False to control line item detection in OCR flows. - `skip_approval_for_paid_invoice` (boolean, optional) ### PaymentsSettings - `payment_page_domain` (string, optional) - `payment_page_theme` (PaymentPageTheme, optional) - `support_email` (string, optional) — The support email address ### ReceivableSettings - `create_without_personal_info` (boolean, required) - `deduction_title` (string, optional) ### Unit - `designation` (string, required) - `name` (string, required) ### ErrorSchema - `message` (string, required) ### ValidationError - `loc` (list of ValidationErrorLocItem, required) - `msg` (string, required) - `type` (string, required) ### DefaultLedgerAccountIDs - `payments` (string, optional) — ID of the ledger account to which all payment records will be pushed. Changing this value affects only future data pushes and does not affect payment records that already exist in the accounting system. - `products` (string, optional) — ID of the ledger account to which products without a `ledger_account_id` specified will be pushed. Changing this value affects only future data pushes and does not affect products that already exist in the accounting system. ### DefaultAccountingTaxIDs - `deductions` (string, optional) — ID of the accounting tax ID with which all deductions will be pushed. ### ExchangeRate - `base` (enum, required) - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `SVC`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW` - `rate` (double, required) - `to` (enum, required) - Allowed values: `AED`, `AFN`, `ALL`, `AMD`, `ANG`, `AOA`, `ARS`, `AUD`, `AWG`, `AZN`, `BAM`, `BBD`, `BDT`, `BGN`, `BHD`, `BIF`, `BMD`, `BND`, `BOB`, `BRL`, `BSD`, `BTN`, `BWP`, `BYN`, `BZD`, `CAD`, `CDF`, `CHF`, `CLP`, `CNY`, `COP`, `CRC`, `CVE`, `CZK`, `DJF`, `DKK`, `DOP`, `DZD`, `EGP`, `ETB`, `EUR`, `FJD`, `FKP`, `GBP`, `GEL`, `GHS`, `GIP`, `GMD`, `GNF`, `GTQ`, `GYD`, `HKD`, `HNL`, `HTG`, `HUF`, `IDR`, `ILS`, `INR`, `IQD`, `ISK`, `JMD`, `JOD`, `JPY`, `KES`, `KGS`, `KHR`, `KMF`, `KRW`, `KWD`, `KYD`, `KZT`, `LAK`, `LBP`, `LKR`, `LRD`, `LSL`, `LYD`, `MAD`, `MDL`, `MGA`, `MKD`, `MMK`, `MNT`, `MOP`, `MUR`, `MVR`, `MWK`, `MXN`, `MYR`, `MZN`, `NAD`, `NGN`, `NIO`, `NOK`, `NPR`, `NZD`, `OMR`, `PAB`, `PEN`, `PGK`, `PHP`, `PKR`, `PLN`, `PYG`, `QAR`, `RON`, `RSD`, `RUB`, `RWF`, `SAR`, `SBD`, `SCR`, `SEK`, `SGD`, `SHP`, `SLE`, `SOS`, `SRD`, `SSP`, `SVC`, `SZL`, `THB`, `TJS`, `TMT`, `TND`, `TOP`, `TRY`, `TTD`, `TWD`, `TZS`, `UAH`, `UGX`, `USD`, `UYU`, `UZS`, `VND`, `VUV`, `WST`, `XAF`, `XCD`, `XOF`, `XPF`, `YER`, `ZAR`, `ZMW` ### DocumentTypePrefix - `credit_note` (string, optional, default: CN) - `delivery_note` (string, optional, default: DN) - `invoice` (string, optional, default: INV) - `purchase_order` (string, optional, default: PO) - `quote` (string, optional, default: Q) ### DocumentIDsSettingsNextNumber - `credit_note` (integer, optional) - `delivery_note` (integer, optional) - `invoice` (integer, optional) - `purchase_order` (integer, optional) - `quote` (integer, optional) ### CreditNoteRenderingSettings - `display_entity_bank_account` (boolean, optional, default: true) — If set to `true`, the entity's bank account details will be displayed on the credit note PDF. ### InvoiceRenderingSettings - `display_entity_bank_account` (boolean, optional, default: true) — If set to `true`, the entity's bank account details will be displayed on the invoice PDF. ### LineItemsRenderingSettings - `discount` (LineItemColumnSettings, optional) — Settings for the discount column in the line items table. - `measure_unit` (LineItemColumnSettings, optional) — Settings for the measure unit column in the line items table. - `name` (LineItemColumnSettings, optional) — Settings for the name column in the line items table. - `price` (LineItemNumericColumnSettings, optional) — Settings for the price column in the line items table. - `price_after_vat` (LineItemNumericColumnSettings, optional) — Settings for the price after VAT column in the line items table. - `quantity` (LineItemColumnSettings, optional) — Settings for the quantity column in the line items table. - `total_price` (LineItemNumericColumnSettings, optional) — Settings for the total price column in the line items table. - `total_price_after_vat` (LineItemNumericColumnSettings, optional) — Settings for the total price after VAT column in the line items table. - `vat_amount` (LineItemNumericColumnSettings, optional) — Settings for the VAT amount column in the line items table. - `vat_rate` (LineItemNumericColumnSettings, optional) — Settings for the VAT rate column in the line items table. ### QuoteRenderingSettings - `display_entity_bank_account` (boolean, optional, default: true) — If set to `true`, the entity's bank account details will be displayed on the quote PDF. - `display_signature` (boolean, optional, default: false) — If set to `true`, the signature field will be displayed on the quote PDF. ### PaymentPageTheme - `background_color` (string, optional) - `border_radius` (string, optional) - `button` (ButtonTheme2, optional) - `card` (CardTheme2, optional) - `font_color` (string, optional) - `font_family` (string, optional) - `font_link_href` (string, optional) - `logo_src` (string, optional) ### ValidationErrorLocItem ### LineItemColumnSettings - `display` (boolean, optional, default: true) - `label` (string, optional) — Line item table column header to override Monite's default. If not set, the Monite's default will be used. ### LineItemNumericColumnSettings Extended settings for numeric columns in line items. - `display` (boolean, optional, default: true) - `label` (string, optional) — Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` (integer, optional) — Number of decimal places to display for numeric values in this column. ### ButtonTheme2 - `primary_color` (string, optional) - `primary_hover_color` (string, optional) - `secondary_color` (string, optional) - `secondary_hover_color` (string, optional) ### CardTheme2 - `background_color` (string, optional) ## Examples **Request** ```json {} ``` **Response** ```json { "accounting": { "ledger_account_ids": { "payments": "payments", "products": "products" }, "tax_ids": { "deductions": "deductions" } }, "allow_purchase_order_autolinking": true, "api_version": "2024-05-25", "commercial_conditions": [ "commercial_conditions" ], "currency": { "default": "AED", "exchange_rates": [ { "base": "AED", "rate": 0.98, "to": "AED" } ] }, "default_role": { "key": "value" }, "document_ids": { "document_type_prefix": { "credit_note": "credit_note", "delivery_note": "delivery_note", "invoice": "invoice", "purchase_order": "purchase_order", "quote": "quote" }, "include_date": true, "min_digits": 1, "prefix": "prefix", "separator": "/" }, "document_rendering": { "credit_note": { "display_entity_bank_account": true }, "display_entity_bank_account": true, "display_line_items": true, "invoice": { "display_entity_bank_account": true }, "line_items": { "discount": { "display": true, "label": "label" }, "measure_unit": { "display": true, "label": "label" }, "name": { "display": true, "label": "label" }, "price": { "display": true, "label": "label", "precision": 1 }, "price_after_vat": { "display": true, "label": "label", "precision": 1 }, "quantity": { "display": true, "label": "label" }, "total_price": { "display": true, "label": "label", "precision": 1 }, "total_price_after_vat": { "display": true, "label": "label", "precision": 1 }, "vat_amount": { "display": true, "label": "label", "precision": 1 }, "vat_rate": { "display": true, "label": "label", "precision": 1 } }, "quote": { "display_entity_bank_account": true, "display_signature": true } }, "generate_paid_invoice_pdf": true, "language": "ab", "mail": { "attach_documents_as_pdf": true, "from_email_username": "from_email_username", "from_name": "from_name" }, "payable": { "approve_page_url": "https://monite.com", "allow_cancel_duplicates_automatically": true, "allow_counterpart_autocreation": true, "allow_counterpart_autolinking": true, "default_state": "default_state", "enable_line_items": true, "skip_approval_for_paid_invoice": true }, "payables_ocr_auto_tagging": [ { "enabled": true, "keywords": [ "keywords" ], "tag_id": "tag_id" } ], "payables_skip_approval_flow": true, "payment_priority": "working_capital", "payments": { "payment_page_domain": "payment_page_domain", "payment_page_theme": { "background_color": "background_color", "border_radius": "border_radius", "button": { "primary_color": "primary_color", "primary_hover_color": "primary_hover_color", "secondary_color": "secondary_color", "secondary_hover_color": "secondary_hover_color" }, "card": { "background_color": "background_color" }, "font_color": "font_color", "font_family": "font_family", "font_link_href": "font_link_href", "logo_src": "logo_src" }, "support_email": "support_email" }, "quote_signature_required": true, "receivable": { "create_without_personal_info": true, "deduction_title": "deduction_title" }, "receivable_edit_flow": "compliant", "reminder": { "enabled": true }, "units": [ { "designation": "kg", "name": "Kilogram" } ], "vat_inclusive_discount_mode": "exclusive", "vat_mode": "exclusive", "website": "website" } ``` **SDK Code** ```python import requests url = "https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings" payload = {} headers = { "x-monite-version": "2024-01-31", "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.patch(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings'; const options = { method: 'PATCH', headers: { 'x-monite-version': '2024-01-31', Authorization: 'Bearer ', 'Content-Type': 'application/json' }, body: '{}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("x-monite-version", "2024-01-31") req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["x-monite-version"] = '2024-01-31' request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.patch("https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings") .header("x-monite-version", "2024-01-31") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'x-monite-version' => '2024-01-31', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings"); var request = new RestRequest(Method.PATCH); request.AddHeader("x-monite-version", "2024-01-31"); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-monite-version": "2024-01-31", "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = [] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "PATCH" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```