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

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

Errors

GET

1 curl https://api.sandbox.monite.com/v1/entities/ea837e28-509b-4b6a-a600-d54b6aa0b1f5/settings \
2      -H "x-monite-version: 2024-05-25" \
3      -H "Authorization: Bearer <token>"

1 {
2   "language": "ab",
3   "currency": {
4     "default": "AED",
5     "exchange_rates": [
6       {
7         "base": "AED",
8         "rate": 0.98,
9         "to": "AED"
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     "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   "payables_ocr_auto_tagging": [
33     {
34       "tag_id": "tag_id",
35       "keywords": [
36         "keywords"
37       ],
38       "enabled": true
39     }
40   ],
41   "quote_signature_required": true,
42   "generate_paid_invoice_pdf": true,
43   "accounting": {
44     "ledger_account_ids": {
45       "payments": "payments"
46     }
47   }
48 }

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-05-25" \
3	-H "Authorization: Bearer <token>"

1	{
2	"language": "ab",
3	"currency": {
4	"default": "AED",
5	"exchange_rates": [
6	{
7	"base": "AED",
8	"rate": 0.98,
9	"to": "AED"
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	"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	"payables_ocr_auto_tagging": [
33	{
34	"tag_id": "tag_id",
35	"keywords": [
36	"keywords"
37	],
38	"enabled": true
39	}
40	],
41	"quote_signature_required": true,
42	"generate_paid_invoice_pdf": true,
43	"accounting": {
44	"ledger_account_ids": {
45	"payments": "payments"
46	}
47	}
48	}