> This page is for version v2024-05-25 (default). > For other versions, use one of these documentation indexes: > - v2024-05-25 (default): https://docs.monite.com/v-2024-05-25/llms.txt > - v2024-01-31: https://docs.monite.com/v2024-01-31/llms.txt > - v2023-09-01: https://docs.monite.com/v2023-09-01/llms.txt > 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 partner settings PATCH https://api.sandbox.monite.com/v1/settings Content-Type: application/json Partner-level settings apply to all entities of that partner. See also: * [Update entity settings](https://docs.monite.com/api/entities/patch-entities-id-settings) Reference: https://docs.monite.com/api/partner-settings/patch-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 ### Headers - `x-monite-version` (string, required) ### Body (application/json) This endpoint expects an object. - `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) — Unused. To specify the terms and conditions for invoices and quotes, use the `commercial_condition_description` field in those documents. - `currency` (CurrencySettingsInput, optional) — Custom currency exchange rates. - `default_role` (map from string to any, optional) — A default role to provision upon new entity creation. - `mail` (MailSettings, optional) — Settings for outgoing email. Used by: * accounts receivable emails, for example, emails sent by `POST /recevables/{receivable_id}/send`, * accounts payable approval notifications. - `payable` (PayableSettings, optional) — Settings for accounts payable. - `payments` (PaymentsSettingsInput, optional) — Settings for the payments module. - `receivable` (ReceivableSettings, optional) — Settings for accounts receivable. - `units` (list of Unit, optional) — Unused. To manage the [measure units](https://docs.monite.com/accounts-receivable/products#manage-measure-units) for your entities, use the `/measure_units` endpoints. - `website` (string, optional) — The URL of the partner's website. Must be an HTTPS URL. Required if the partner's entities use [payment links](https://docs.monite.com/payments/payment-links). The "Powered by" badge in the payment page footer will link to this website. ## Response ### 200 Successful Response - `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) — Unused. To specify the terms and conditions for invoices and quotes, use the `commercial_condition_description` field in those documents. - `currency` (CurrencySettingsOutput, optional) — Custom currency exchange rates. - `default_role` (map from string to any, optional) — A default role to provision upon new entity creation. - `mail` (MailSettings, optional) — Settings for outgoing email. Used by: * accounts receivable emails, for example, emails sent by `POST /recevables/{receivable_id}/send`, * accounts payable approval notifications. - `payable` (PayableSettings, optional) — Settings for accounts payable. - `payments` (PaymentsSettingsOutput, optional) — Settings for the payments module. - `receivable` (ReceivableSettings, optional) — Settings for accounts receivable. - `units` (list of Unit, optional) — Unused. To manage the [measure units](https://docs.monite.com/accounts-receivable/products#manage-measure-units) for your entities, use the `/measure_units` endpoints. - `website` (string, optional) — The URL of the partner's website. Must be an HTTPS URL. Required if the partner's entities use [payment links](https://docs.monite.com/payments/payment-links). The "Powered by" badge in the payment page footer will link to this website. ## Errors ### 400 Patch Settings Request Bad Request Error Missing `X-Monite-Version` request header. - `error` (ErrorSchema, required) ### 401 Patch 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` ### 403 Patch Settings Request Forbidden Error The specified access token does not have permissions to perform this operation. - `any` ### 404 Patch Settings Request Not Found Error Invalid API version. - `any` ### 422 Patch Settings Request Unprocessable Entity Error Validation Error - `detail` (list of ValidationError, optional) ### 429 Patch Settings Request Too Many Requests Error API rate limit has been exceeded. Check the response headers for the rate limit information. - `any` ## Types ### 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) ### MailSettings - `attach_documents_as_pdf` (boolean, optional, default: true) — This setting affects accounts receivable emails. If it is `true`, emails sent by [`POST /receivables/{receivable_id}/send`](https://docs.monite.com/api/receivables/post-receivables-id-send) will include the PDF version of the specified invoice, quote, or credit note as an attachment. When emailing [e-invoices](https://docs.monite.com/e-invoicing/send), e-invoice XML will also be attached to the email. If it is `false`, PDFs and e-invoice XML is not attached to outgoing emails. - `from_email_username` (string, optional) — The local part of the sender email address (the part before the @domain). If `null`, defaults to `noreply`. For example, to send emails from `Acme Inc. ` use "invoicing" as the `from_email_username` value. To customize the domain name for outgoing emails, [set up a mailbox](https://docs.monite.com/advanced/mailboxes#manage-mailboxes) for the entity. - `from_name` (string, optional) — The sender name in outgoing emails. For example, to send emails from `Acme Inc. ` use "Acme Inc." as the `from_name` value. If `null`, the sender address will be just an email address without a name. ### PayableSettings - `approve_page_url` (string, required) — The URL included in approval notification emails and UI buttons, directing approvers to complete the invoice approval workflow. Useful for linking to your custom approval portal. - `allow_cancel_duplicates_automatically` (boolean, optional) — When enabled, Monite will automatically detect and cancel payables identified as duplicates during ingestion—reducing manual review overhead. - `allow_counterpart_autocreation` (boolean, optional) — Enables creation of a new counterpart record (supplier) when incoming payable data doesn't match any existing counterpart. - `allow_counterpart_autolinking` (boolean, optional) — Automatically links incoming payables to existing counterpart records using matching logic (e.g., tax ID, IBAN, name/address). - `allow_credit_note_autolinking` (boolean, optional) — If true, Monite will attempt to automatically attach credit notes to the corresponding payables when processing them. - `default_state` (string, optional) — The initial status assigned to newly created payables (e.g., `draft`, `new`). Determines whether they require approval or review. - `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) — When set to true, payables that are already marked as paid bypass the approval workflow entirely. ### PaymentsSettingsInput - `payment_page_domain` (string, optional) - `payment_page_theme` (PaymentPageTheme, optional) — See [Payment page customization](https://docs.monite.com/payments/payment-page-customization). - `support_email` (string, optional) — Required if the partner has UK entities that want to accept Bacs Direct Debit payments. This email address will be included in Bacs debit notification emails sent to the payers, as the contact email address where the payers can send payments-related inquiries. ### ReceivableSettings - `create_without_personal_info` (boolean, required) — Unused. - `deduction_title` (string, optional) — The title for the section in PDF invoices that contains [special deductions or incentives](https://docs.monite.com/accounts-receivable/special-deductions). If `null`, the title defaults to "Incentives" (localized). Custom title is not automatically localized. ### Unit - `designation` (string, required) - `name` (string, required) ### 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) ### PaymentsSettingsOutput - `payment_page_domain` (string, optional) - `payment_page_theme` (PaymentPageTheme, optional) — See [Payment page customization](https://docs.monite.com/payments/payment-page-customization). - `support_email` (string, optional) — Required if the partner has UK entities that want to accept Bacs Direct Debit payments. This email address will be included in Bacs debit notification emails sent to the payers, as the contact email address where the payers can send payments-related inquiries. ### ErrorSchema - `message` (string, required) ### ValidationError - `loc` (list of ValidationErrorLocItem, required) - `msg` (string, required) - `type` (string, required) ### 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` ### PaymentPageTheme - `background_color` (string, optional) - `border_radius` (string, optional) - `button` (ButtonTheme, optional) - `card` (CardTheme, optional) - `font_color` (string, optional) - `font_family` (string, optional) - `font_link_href` (string, optional) - `logo_src` (string, optional) ### ValidationErrorLocItem ### ButtonTheme - `primary_color` (string, optional) - `primary_hover_color` (string, optional) — Unused. - `secondary_color` (string, optional) — Unused. - `secondary_hover_color` (string, optional) — Unused. ### CardTheme - `background_color` (string, optional) ## Examples **Request** ```json {} ``` **Response** ```json { "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" }, "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, "allow_credit_note_autolinking": true, "default_state": "default_state", "enable_line_items": true, "skip_approval_for_paid_invoice": true }, "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" }, "receivable": { "create_without_personal_info": true, "deduction_title": "deduction_title" }, "units": [ { "designation": "kg", "name": "Kilogram" } ], "website": "website" } ``` **SDK Code** ```python import requests url = "https://api.sandbox.monite.com/v1/settings" payload = {} headers = { "x-monite-version": "2024-05-25", "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/settings'; const options = { method: 'PATCH', headers: { 'x-monite-version': '2024-05-25', 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/settings" payload := strings.NewReader("{}") req, _ := http.NewRequest("PATCH", url, payload) req.Header.Add("x-monite-version", "2024-05-25") 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/settings") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["x-monite-version"] = '2024-05-25' 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/settings") .header("x-monite-version", "2024-05-25") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{}") .asString(); ``` ```php request('PATCH', 'https://api.sandbox.monite.com/v1/settings', [ 'body' => '{}', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', 'x-monite-version' => '2024-05-25', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.sandbox.monite.com/v1/settings"); var request = new RestRequest(Method.PATCH); request.AddHeader("x-monite-version", "2024-05-25"); 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-05-25", "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/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() ```