Get entity settings

GET

/entities/:entity_id/settings

Retrieve all settings for this entity.

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

Response

Successful Response

languageenumOptional

currencyobjectOptional

Custom currency exchange rates.

reminderobjectOptional

vat_modeenumOptional

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_requiredbooleanOptionalDefaults to false

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

generate_paid_invoice_pdfbooleanOptionalDefaults to false

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

accountingobjectOptional

payableobjectOptional

Settings for the payables module.

receivableobjectOptional

Settings for the receivables module.

mailobjectOptional

Settings for email and mailboxes.

commercial_conditionslist of stringsOptional

Commercial conditions for receivables.

unitslist of objectsOptional

Measurement units.

websitestringOptional

default_rolemap from strings to anyOptional

A default role to provision upon new entity creation.

paymentsobjectOptional

Settings for the payments module.

api_versionenumOptional

Default API version for partner.

Errors

GET

1 curl 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>"

200Retrieved

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

Update entity settings

Up Next

1	curl 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>"

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