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

accountingobjectOptional
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 based 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

Errors