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

allow_purchase_order_autolinkingbooleanOptionalDefaults to false

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

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

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

accountingobjectOptionalDeprecated

Settings for the accounting module.

Errors

GET

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

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

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: 2024-01-31" \
3	-H "Authorization: Bearer <token>"

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