Get entity settings (v2023-09-01) — Monite Documentation

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

This setting affects how PDF is generated for paid accounts receivable invoices. If set to true, once an invoice is fully paid its PDF version is updated to display the amount paid and the payment-related features are removed.

The PDF file gets regenerated at the moment when an invoice becomes paid. It is not issued as a separate document, and the original PDF invoice is no longer available.

accountingobjectOptional

payables_skip_approval_flowbooleanOptionalDefaults to false

If enabled, the approval policy will be skipped and the payable will be moved to waiting_to_be_paid status.

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

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 "delivery_note": "delivery_note", 24 "invoice": "invoice", 25 "purchase_order": "purchase_order", 26 "quote": "quote" 27 }, 28 "include_date": true, 29 "min_digits": 1, 30 "prefix": "prefix", 31 "separator": "/" 32 }, 33 "payables_ocr_auto_tagging": [ 34 { 35 "enabled": true, 36 "keywords": [ 37 "keywords" 38 ], 39 "tag_id": "tag_id" 40 } 41 ], 42 "quote_signature_required": true, 43 "generate_paid_invoice_pdf": true, 44 "accounting": { 45 "ledger_account_ids": { 46 "payments": "payments", 47 "products": "products" 48 } 49 }, 50 "payables_skip_approval_flow": true, 51 "payable": { 52 "approve_page_url": "https://monite.com", 53 "allow_cancel_duplicates_automatically": true, 54 "allow_counterpart_autocreation": true, 55 "allow_counterpart_autolinking": true, 56 "default_state": "default_state", 57 "skip_approval_for_paid_invoice": true, 58 "enable_line_items": true 59 }, 60 "receivable": { 61 "create_without_personal_info": true, 62 "deduction_title": "deduction_title" 63 }, 64 "mail": { 65 "attach_documents_as_pdf": true, 66 "from_email_username": "from_email_username", 67 "from_name": "from_name" 68 }, 69 "commercial_conditions": [ 70 "commercial_conditions" 71 ], 72 "units": [ 73 { 74 "designation": "kg", 75 "name": "Kilogram" 76 } 77 ], 78 "website": "website", 79 "default_role": { 80 "key": "value" 81 }, 82 "payments": { 83 "payment_page_domain": "payment_page_domain", 84 "payment_page_theme": { 85 "background_color": "background_color", 86 "border_radius": "border_radius", 87 "button": { 88 "primary_color": "primary_color", 89 "primary_hover_color": "primary_hover_color", 90 "secondary_color": "secondary_color", 91 "secondary_hover_color": "secondary_hover_color" 92 }, 93 "card": { 94 "background_color": "background_color" 95 }, 96 "font_color": "font_color", 97 "font_family": "font_family", 98 "font_link_href": "font_link_href", 99 "logo_src": "logo_src" 100 }, 101 "support_email": "support_email" 102 }, 103 "api_version": "2024-05-25" 104 }

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	"delivery_note": "delivery_note",
24	"invoice": "invoice",
25	"purchase_order": "purchase_order",
26	"quote": "quote"
27	},
28	"include_date": true,
29	"min_digits": 1,
30	"prefix": "prefix",
31	"separator": "/"
32	},
33	"payables_ocr_auto_tagging": [
34	{
35	"enabled": true,
36	"keywords": [
37	"keywords"
38	],
39	"tag_id": "tag_id"
40	}
41	],
42	"quote_signature_required": true,
43	"generate_paid_invoice_pdf": true,
44	"accounting": {
45	"ledger_account_ids": {
46	"payments": "payments",
47	"products": "products"
48	}
49	},
50	"payables_skip_approval_flow": true,
51	"payable": {
52	"approve_page_url": "https://monite.com",
53	"allow_cancel_duplicates_automatically": true,
54	"allow_counterpart_autocreation": true,
55	"allow_counterpart_autolinking": true,
56	"default_state": "default_state",
57	"skip_approval_for_paid_invoice": true,
58	"enable_line_items": true
59	},
60	"receivable": {
61	"create_without_personal_info": true,
62	"deduction_title": "deduction_title"
63	},
64	"mail": {
65	"attach_documents_as_pdf": true,
66	"from_email_username": "from_email_username",
67	"from_name": "from_name"
68	},
69	"commercial_conditions": [
70	"commercial_conditions"
71	],
72	"units": [
73	{
74	"designation": "kg",
75	"name": "Kilogram"
76	}
77	],
78	"website": "website",
79	"default_role": {
80	"key": "value"
81	},
82	"payments": {
83	"payment_page_domain": "payment_page_domain",
84	"payment_page_theme": {
85	"background_color": "background_color",
86	"border_radius": "border_radius",
87	"button": {
88	"primary_color": "primary_color",
89	"primary_hover_color": "primary_hover_color",
90	"secondary_color": "secondary_color",
91	"secondary_hover_color": "secondary_hover_color"
92	},
93	"card": {
94	"background_color": "background_color"
95	},
96	"font_color": "font_color",
97	"font_family": "font_family",
98	"font_link_href": "font_link_href",
99	"logo_src": "logo_src"
100	},
101	"support_email": "support_email"
102	},
103	"api_version": "2024-05-25"
104	}