Get partner settings

GET

/settings

Retrieve all settings for this partner.

Headers

Auth

AuthorizationstringRequired

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

x-monite-versionstringRequired

Response

Successful Response

currencyobjectOptional

Custom currency exchange rates.

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/settings \
2      -H "x-monite-version: 2024-05-25" \
3      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "currency": {
3     "default": "AED",
4     "exchange_rates": [
5       {
6         "base": "AED",
7         "to": "AED",
8         "rate": 0.98
9       }
10     ]
11   },
12   "payable": {
13     "approve_page_url": "https://monite.com",
14     "allow_cancel_duplicates_automatically": true,
15     "allow_counterpart_autocreation": true,
16     "allow_counterpart_autolinking": true,
17     "allow_credit_note_autolinking": true,
18     "default_state": "default_state",
19     "skip_approval_for_paid_invoice": true,
20     "enable_line_items": true
21   },
22   "receivable": {
23     "create_without_personal_info": true,
24     "deduction_title": "deduction_title"
25   },
26   "mail": {
27     "attach_documents_as_pdf": true,
28     "from_email_username": "from_email_username",
29     "from_name": "from_name"
30   },
31   "commercial_conditions": [
32     "commercial_conditions"
33   ],
34   "units": [
35     {
36       "designation": "kg",
37       "name": "Kilogram"
38     }
39   ],
40   "website": "website",
41   "default_role": {
42     "key": "value"
43   },
44   "payments": {
45     "payment_page_domain": "payment_page_domain",
46     "payment_page_theme": {
47       "background_color": "background_color",
48       "border_radius": "border_radius",
49       "button": {
50         "primary_color": "primary_color",
51         "primary_hover_color": "primary_hover_color",
52         "secondary_color": "secondary_color",
53         "secondary_hover_color": "secondary_hover_color"
54       },
55       "card": {
56         "background_color": "background_color"
57       },
58       "font_color": "font_color",
59       "font_family": "font_family",
60       "font_link_href": "font_link_href",
61       "logo_src": "logo_src"
62     },
63     "support_email": "support_email"
64   },
65   "api_version": "2024-05-25"
66 }

Update partner settings

Up Next

1	curl https://api.sandbox.monite.com/v1/settings \
2	-H "x-monite-version: 2024-05-25" \
3	-H "Authorization: Bearer <token>"

1	{
2	"currency": {
3	"default": "AED",
4	"exchange_rates": [
5	{
6	"base": "AED",
7	"to": "AED",
8	"rate": 0.98
9	}
10	]
11	},
12	"payable": {
13	"approve_page_url": "https://monite.com",
14	"allow_cancel_duplicates_automatically": true,
15	"allow_counterpart_autocreation": true,
16	"allow_counterpart_autolinking": true,
17	"allow_credit_note_autolinking": true,
18	"default_state": "default_state",
19	"skip_approval_for_paid_invoice": true,
20	"enable_line_items": true
21	},
22	"receivable": {
23	"create_without_personal_info": true,
24	"deduction_title": "deduction_title"
25	},
26	"mail": {
27	"attach_documents_as_pdf": true,
28	"from_email_username": "from_email_username",
29	"from_name": "from_name"
30	},
31	"commercial_conditions": [
32	"commercial_conditions"
33	],
34	"units": [
35	{
36	"designation": "kg",
37	"name": "Kilogram"
38	}
39	],
40	"website": "website",
41	"default_role": {
42	"key": "value"
43	},
44	"payments": {
45	"payment_page_domain": "payment_page_domain",
46	"payment_page_theme": {
47	"background_color": "background_color",
48	"border_radius": "border_radius",
49	"button": {
50	"primary_color": "primary_color",
51	"primary_hover_color": "primary_hover_color",
52	"secondary_color": "secondary_color",
53	"secondary_hover_color": "secondary_hover_color"
54	},
55	"card": {
56	"background_color": "background_color"
57	},
58	"font_color": "font_color",
59	"font_family": "font_family",
60	"font_link_href": "font_link_href",
61	"logo_src": "logo_src"
62	},
63	"support_email": "support_email"
64	},
65	"api_version": "2024-05-25"
66	}