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
accountingobject or null
allow_purchase_order_autolinkingboolean or null
Automatically attempt to find a corresponding purchase order for all incoming payables.
api_versionenum or null
Default API version for partner.
commercial_conditionslist of strings or null
Commercial conditions for receivables.
currencyobject or null
Custom currency exchange rates.
default_rolemap from strings to any or null
A default role to provision upon new entity creation.
document_idsobject or null
document_renderingobject or null
Settings for rendering documents in PDF format.
generate_paid_invoice_pdfboolean or nullDefaults 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.

languageenum or null
mailobject or null
Settings for email and mailboxes.
payableobject or null
Settings for the payables module.
payables_ocr_auto_tagginglist of objects or null
Auto tagging settings for all incoming OCR payable documents.
payables_skip_approval_flowboolean or nullDefaults to false

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

payment_priorityenum or null
Payment preferences for entity to automate calculating suggested payment date based on payment terms and entity preferences.
Allowed values:
paymentsobject or null
Settings for the payments module.
quote_signature_requiredboolean or nullDefaults to false
Sets the default behavior of whether a signature is required to accept quotes.
receivableobject or null
Settings for the receivables module.
receivable_edit_flowenum or null
Allowed values:
reminderobject or null
unitslist of objects or null
Measurement units.
vat_inclusive_discount_modeenum or null

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:
vat_modeenum or null
Defines whether the prices of products in receivables will already include VAT or not.
Allowed values:
websitestring or null

Errors