Update entity settings — Monite Documentation

Change the specified fields with the provided values.

Path parameters

entity_idstringRequired

A unique ID to specify the entity.

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

Request

This endpoint expects an object.

languageenumOptional

currencyobjectOptional

reminderobjectOptional

vat_mode"exclusive" or "inclusive"Optional

Allowed values: exclusiveinclusive

Defines whether the prices of products in receivables will already include VAT or not.

payment_priorityenumOptional

Allowed values: working_capitalbalancedbottom_line

Payment preferences for entity to automate calculating suggested payment date basing on payment terms and entity preferences

allow_purchase_order_autolinkingbooleanOptional

Automatically attempt to find a corresponding purchase order for all incoming payables.

receivable_edit_flowenumOptional

Allowed values: compliantpartially_compliantnon_compliant

document_idsobjectOptional

payables_ocr_auto_tagginglist of objectsOptional

Auto tagging settings for all incoming OCR payable documents.

quote_signature_requiredbooleanOptional

Sets the default behavior of whether a signature is required to accept quotes

generate_paid_invoice_pdfbooleanOptional

If enabled, the paid invoice’s PDF will be in a new layout set by the user

Response

Successful Response

accountingobjectOptional

Settings for the accounting module.

allow_purchase_order_autolinkingbooleanOptional

Automatically attempt to find a corresponding purchase order for all incoming payables.

api_versionenumOptional

Default API version for partner.

commercial_conditionslist of stringsOptional

Commercial conditions for receivables.

currencyobjectOptional

Custom currency exchange rates.

default_rolemap from strings to anyOptional

A default role to provision upon new entity creation.

document_idsobjectOptional

einvoicingobjectOptional

Settings for the e-invoicing module.

generate_paid_invoice_pdfbooleanOptional

If enabled, the paid invoice’s PDF will be in a new layout set by the user

languageenumOptional

mailobjectOptional

Settings for email and mailboxes.

payableobjectOptional

Settings for the payables module.

payables_ocr_auto_tagginglist of objectsOptional

Auto tagging settings for all incoming OCR payable documents.

payment_priorityenumOptional

Allowed values: working_capitalbalancedbottom_line

Payment preferences for entity to automate calculating suggested payment date basing on payment terms and entity preferences

paymentsobjectOptional

Settings for the payments module.

quote_signature_requiredbooleanOptional

Sets the default behavior of whether a signature is required to accept quotes

receivableobjectOptional

Settings for the receivables module.

receivable_edit_flowenumOptional

Allowed values: compliantpartially_compliantnon_compliant

reminderobjectOptional

unitslist of objectsOptional

Measurement units.

vat_mode"exclusive" or "inclusive"Optional

Allowed values: exclusiveinclusive

Defines whether the prices of products in receivables will already include VAT or not.

websitestringOptional

Errors

1 curl -X PATCH https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings \ 2 -H "x-monite-version: 2024-01-31" \ 3 -H "Authorization: Bearer <token>" \ 4 -H "Content-Type: application/json" \ 5 -d '{}'

1 { 2 "accounting": { 3 "provider": "provider", 4 "token": "token" 5 }, 6 "allow_purchase_order_autolinking": true, 7 "api_version": "2024-01-31", 8 "commercial_conditions": [ 9 "commercial_conditions" 10 ], 11 "currency": { 12 "default": "AED", 13 "exchange_rates": [ 14 { 15 "base": "AED", 16 "rate": 0.98, 17 "to": "AED" 18 } 19 ] 20 }, 21 "default_role": { 22 "key": "value" 23 }, 24 "document_ids": { 25 "include_date": true, 26 "prefix": "prefix", 27 "separator": "/", 28 "document_type_prefix": { 29 "quote": "quote", 30 "invoice": "invoice", 31 "credit_note": "credit_note", 32 "purchase_order": "purchase_order" 33 }, 34 "min_digits": 1 35 }, 36 "einvoicing": { 37 "client_id": "client_id", 38 "client_secret": "client_secret", 39 "provider": "avalara" 40 }, 41 "generate_paid_invoice_pdf": true, 42 "language": "ab", 43 "mail": { 44 "attach_documents_as_pdf": true, 45 "from_email_username": "from_email_username", 46 "from_name": "from_name" 47 }, 48 "payable": { 49 "approve_page_url": "https://monite.com", 50 "allow_cancel_duplicates_automatically": true, 51 "allow_counterpart_autocreation": true, 52 "allow_counterpart_autolinking": true, 53 "default_state": "new", 54 "enable_line_items": true 55 }, 56 "payables_ocr_auto_tagging": [ 57 { 58 "tag_id": "tag_id", 59 "keywords": [ 60 "keywords" 61 ], 62 "enabled": true 63 } 64 ], 65 "payment_priority": "working_capital", 66 "payments": { 67 "payment_page_domain": "payment_page_domain", 68 "payment_page_theme": { 69 "background_color": "background_color", 70 "border_radius": "border_radius", 71 "font_color": "font_color", 72 "font_family": "font_family", 73 "font_link_href": "font_link_href", 74 "logo_src": "logo_src" 75 }, 76 "support_email": "support_email" 77 }, 78 "quote_signature_required": true, 79 "receivable": { 80 "create_without_personal_info": true, 81 "deduction_title": "deduction_title" 82 }, 83 "receivable_edit_flow": "compliant", 84 "reminder": { 85 "enabled": true 86 }, 87 "units": [ 88 { 89 "designation": "kg", 90 "name": "Kilogram" 91 } 92 ], 93 "vat_mode": "exclusive", 94 "website": "website" 95 }

1	curl -X PATCH https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings \
2	-H "x-monite-version: 2024-01-31" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{}'

1	{
2	"accounting": {
3	"provider": "provider",
4	"token": "token"
5	},
6	"allow_purchase_order_autolinking": true,
7	"api_version": "2024-01-31",
8	"commercial_conditions": [
9	"commercial_conditions"
10	],
11	"currency": {
12	"default": "AED",
13	"exchange_rates": [
14	{
15	"base": "AED",
16	"rate": 0.98,
17	"to": "AED"
18	}
19	]
20	},
21	"default_role": {
22	"key": "value"
23	},
24	"document_ids": {
25	"include_date": true,
26	"prefix": "prefix",
27	"separator": "/",
28	"document_type_prefix": {
29	"quote": "quote",
30	"invoice": "invoice",
31	"credit_note": "credit_note",
32	"purchase_order": "purchase_order"
33	},
34	"min_digits": 1
35	},
36	"einvoicing": {
37	"client_id": "client_id",
38	"client_secret": "client_secret",
39	"provider": "avalara"
40	},
41	"generate_paid_invoice_pdf": true,
42	"language": "ab",
43	"mail": {
44	"attach_documents_as_pdf": true,
45	"from_email_username": "from_email_username",
46	"from_name": "from_name"
47	},
48	"payable": {
49	"approve_page_url": "https://monite.com",
50	"allow_cancel_duplicates_automatically": true,
51	"allow_counterpart_autocreation": true,
52	"allow_counterpart_autolinking": true,
53	"default_state": "new",
54	"enable_line_items": true
55	},
56	"payables_ocr_auto_tagging": [
57	{
58	"tag_id": "tag_id",
59	"keywords": [
60	"keywords"
61	],
62	"enabled": true
63	}
64	],
65	"payment_priority": "working_capital",
66	"payments": {
67	"payment_page_domain": "payment_page_domain",
68	"payment_page_theme": {
69	"background_color": "background_color",
70	"border_radius": "border_radius",
71	"font_color": "font_color",
72	"font_family": "font_family",
73	"font_link_href": "font_link_href",
74	"logo_src": "logo_src"
75	},
76	"support_email": "support_email"
77	},
78	"quote_signature_required": true,
79	"receivable": {
80	"create_without_personal_info": true,
81	"deduction_title": "deduction_title"
82	},
83	"receivable_edit_flow": "compliant",
84	"reminder": {
85	"enabled": true
86	},
87	"units": [
88	{
89	"designation": "kg",
90	"name": "Kilogram"
91	}
92	],
93	"vat_mode": "exclusive",
94	"website": "website"
95	}