--- title: "Get entity settings" method: GET path: "/entities/{entity_id}/settings" tags: ["Entities"] --- # Get entity settings `GET /entities/{entity_id}/settings` ## Request - Base URL: `https://api.sandbox.monite.com/v1` - URL: `https://api.sandbox.monite.com/v1/entities/{entity_id}/settings` - Auth: HTTP bearer Retrieve all settings for this entity. ## Path parameters - `entity_id` string, required ## Headers - `x-monite-version` string, required ## Response `200` Successful Response - MergedSettingsResponse - `accounting` AccountingSettings - `ledger_account_ids` DefaultLedgerAccountIDs - `payments` string, uuid: 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, uuid: 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. - `tax_ids` DefaultAccountingTaxIDs - `deductions` string, uuid: ID of the accounting tax ID with which all deductions will be pushed. - `allow_purchase_order_autolinking` boolean: Automatically attempt to find a corresponding purchase order for all incoming payables. - `api_version` '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` string[]: Commercial conditions for receivables. - `currency` CurrencySettingsOutput - `default` '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', required - `exchange_rates` ExchangeRate[] - `base` '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', required - `rate` number, double, required - `to` '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', required - `default_role` object: A default role to provision upon new entity creation. - `document_ids` DocumentIDsSettings - `document_type_prefix` DocumentTypePrefix - `credit_note` string - `delivery_note` string - `invoice` string - `purchase_order` string - `quote` string - `include_date` boolean: Optionally add 4-digit of the current year. - `min_digits` integer: Minimal size of number in document ID Number will be left padded with zeros if less. - `prefix` string: Optional prefix. Does not substitute document_type prefix. - `separator` '/' | '-' | '|' | '.' | '' - `document_rendering` 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 - `display_entity_bank_account` boolean: If set to `true`, the entity's bank account details will be displayed on the credit note PDF. - `display_entity_bank_account` boolean: If set to `true`, the entity's bank account details will be displayed on the PDF documents. Defaults to `true`. - `display_line_items` boolean: If set to `true`, the line items table will be displayed on the quote PDF. Defaults to `true`. - `invoice` InvoiceRenderingSettings - `display_entity_bank_account` boolean: If set to `true`, the entity's bank account details will be displayed on the invoice PDF. - `line_items` LineItemsRenderingSettings - `discount` LineItemColumnSettings - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `measure_unit` LineItemColumnSettings - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `name` LineItemColumnSettings - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `price` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `price_after_vat` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `quantity` LineItemColumnSettings - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `total_price` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `total_price_after_vat` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `vat_amount` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `vat_rate` LineItemNumericColumnSettings: Extended settings for numeric columns in line items. - `display` boolean - `label` string: Line item table column header to override Monite's default. If not set, the Monite's default will be used. - `precision` integer: Number of decimal places to display for numeric values in this column. - `quote` QuoteRenderingSettings - `display_entity_bank_account` boolean: If set to `true`, the entity's bank account details will be displayed on the quote PDF. - `display_signature` boolean: If set to `true`, the signature field will be displayed on the quote PDF. - `generate_paid_invoice_pdf` boolean: 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` '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 - `attach_documents_as_pdf` boolean: Attach documents as PDF in emails. - `from_email_username` string - `from_name` string - `payable` PayableSettings - `allow_cancel_duplicates_automatically` boolean - `allow_counterpart_autocreation` boolean - `allow_counterpart_autolinking` boolean - `approve_page_url` string, uri, required - `default_state` string: A state each new payable will have upon creation - `enable_line_items` boolean: Partners can set this to True or False to control line item detection in OCR flows. - `skip_approval_for_paid_invoice` boolean - `payables_ocr_auto_tagging` OcrAutoTaggingSettingsRequest[]: Auto tagging settings for all incoming OCR payable documents. - `enabled` boolean, required: A switch to temporarily disable a keyword without removing it from the list. - `keywords` 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, uuid, required: Tag identifier that will be assigned to the payable document if one of the words listed in keywords is found during OCR. - `payables_skip_approval_flow` boolean: If enabled, the approval policy will be skipped and the payable will be moved to `waiting_to_be_paid` status. - `payment_priority` 'working_capital' | 'balanced' | 'bottom_line' - `payments` PaymentsSettings - `payment_page_domain` string - `payment_page_theme` PaymentPageTheme - `background_color` string - `border_radius` string - `button` ButtonTheme2 - `primary_color` string - `primary_hover_color` string - `secondary_color` string - `secondary_hover_color` string - `card` CardTheme2 - `background_color` string - `font_color` string - `font_family` string - `font_link_href` string, uri - `logo_src` string, uri - `support_email` string, email: The support email address - `quote_signature_required` boolean: Sets the default behavior of whether a signature is required to accept quotes. - `receivable` ReceivableSettings - `create_without_personal_info` boolean, required - `deduction_title` string - `receivable_edit_flow` 'compliant' | 'partially_compliant' | 'non_compliant' - `reminder` RemindersSettings - `enabled` boolean - `units` Unit[]: Measurement units. - `designation` string, required - `name` string, required - `vat_inclusive_discount_mode` 'exclusive' | 'inclusive' - `vat_mode` 'exclusive' | 'inclusive' - `website` string ## Other responses - `400`: Bad Request - `422`: Validation Error - `500`: Internal Server Error --- [API](https://skmtc.dev/monite/apis/monite-3.md) - [All operations](https://skmtc.dev/monite/apis/monite-3/llms.txt) - [OpenAPI document](https://skmtc.dev/monite/apis/monite-3/revisions/c13be6f83ce9?raw)