> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.monite.com/v-2024-05-25/api/entities/get-entities-id-settings/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.monite.com/_mcp/server. # Get entity settings GET https://api.sandbox.monite.com/v1/entities/{entity_id}/settings Entity settings include configuration options for accounts payable, accounts receivable, accounting integration, and other functionality. Both partner tokens and entity user tokens can be used for authentication. Entity users must have a role with the `entity.read` permission. Related endpoints: * [Get next document numbers](https://docs.monite.com/api/entities/get-entities-id-settings-next-document-numbers) * [Get partner settings](https://docs.monite.com/api/partner-settings/get-settings) Reference: https://docs.monite.com/api/entities/get-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) ## 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. - `currency` (CurrencySettingsOutput, optional) - `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 accounts receivable invoices that are paid, partially paid, or have credit notes applied. If this setting is `true`: * The totals block in the PDF invoice will include a list of all payments made and credit notes issued. * Once an invoice becomes fully paid, the payment link and QR code are removed. The PDF invoice gets regenerated at the moment when an invoice payment is recorded or a credit note is issued. This PDF is not issued as a separate document, and the original PDF invoice is no longer available. - `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) — [Invoice compliance mode](https://docs.monite.com/accounts-receivable/regulatory-compliance/invoice-compliance) for accounts receivable. Possible values: * `compliant` - invoices cannot be edited once issued. * `non_compliant` - issued invoices can still be edited. * `partially_compliant` - deprecated mode, should not be used. - 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` ## Errors ### 400 Get Entities ID Settings Request Bad Request Error Bad Request - `error` (ErrorSchema, required) ### 401 Get Entities ID Settings Request Unauthorized Error The `Authorization` header is missing or contains an invalid or expired access token. See [Authentication](https://docs.monite.com/api/concepts/authentication) to learn how to authenticate API calls. - `any` ### 422 Get Entities ID Settings Request Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 429 Get Entities ID Settings Request Too Many Requests Error API rate limit has been exceeded. Check the response headers for the rate limit information. - `any` ## 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. ### 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. ### 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) ### 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) ### 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`, PDF quotes will include a block for the counterpart's signature. Before a quote is accepted, this block serves as a placeholder. After a counterpart accepts a quote with a digital signature, the PDF version of that quote is updated to include their signature and signing details. ### 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. ## Examples **Response** ```json { "accounting": { "ledger_account_ids": { "payments": "payments", "products": "products" }, "tax_ids": { "deductions": "deductions" } }, "allow_purchase_order_autolinking": true, "currency": { "default": "AED", "exchange_rates": [ { "base": "AED", "rate": 0.98, "to": "AED" } ] }, "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": { "reply_to": [ "reply_to" ] }, "payables_ocr_auto_tagging": [ { "enabled": true, "keywords": [ "keywords" ], "tag_id": "tag_id" } ], "payables_skip_approval_flow": true, "payment_priority": "working_capital", "quote_signature_required": true, "receivable_edit_flow": "compliant", "reminder": { "enabled": true }, "vat_inclusive_discount_mode": "exclusive", "vat_mode": "exclusive" } ``` **SDK Code** ```python import requests url = "https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings" headers = { "x-monite-version": "2024-05-25", "Authorization": "Bearer " } response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings'; const options = { method: 'GET', headers: {'x-monite-version': '2024-05-25', Authorization: 'Bearer '} }; 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" "net/http" "io" ) func main() { url := "https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("x-monite-version", "2024-05-25") req.Header.Add("Authorization", "Bearer ") 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::Get.new(url) request["x-monite-version"] = '2024-05-25' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings") .header("x-monite-version", "2024-05-25") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings', [ 'headers' => [ 'Authorization' => 'Bearer ', 'x-monite-version' => '2024-05-25', ], ]); 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.GET); request.AddHeader("x-monite-version", "2024-05-25"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "x-monite-version": "2024-05-25", "Authorization": "Bearer " ] 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 = "GET" request.allHTTPHeaderFields = headers 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() ```