CommonEntities

Get entity settings

Retrieve all settings for this entity.

Path parameters

entity_idstringRequired

A unique ID to specify the entity.

Headers

AuthorizationstringRequired

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

x-monite-versionstringRequired

Response

Successful Response

languageenumOptional
currencyobjectOptional
reminderobjectOptional
vat_modeenumOptional

Defines whether the prices of products in receivables will already include VAT or not.

Allowed values:
vat_inclusive_discount_modeenumOptional

Defines whether the amount discounts (for percentage discounts it does not matter) on VAT inclusive invoices will be applied on amounts including VAT or excluding VAT.

Allowed values:
payment_priorityenumOptional

Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences.

Allowed values:
allow_purchase_order_autolinkingbooleanOptional

Automatically attempt to find a corresponding purchase order for all incoming payables.

receivable_edit_flowenumOptional
Allowed values:
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.

This field is deprecated and will be replaced by document_rendering.invoice.generate_paid_invoice_pdf.

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.

document_renderingobjectOptional

Settings for rendering documents in PDF format.

Errors