Update entity settings

PATCH

/entities/:entity_id/settings

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 based 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.

accountingobjectOptional

Response

Successful Response

accountingobjectOptional

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 based 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

PATCH

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

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

Get an entity of this user

Up Next

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

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