Entities

Get entity settings

Retrieve all settings for this entity.

get/entities/{entity_id}/settings

Request

  • Base URL: https://api.sandbox.monite.com/v1
  • URL: https://api.sandbox.monite.com/v1/entities/{entity_id}/settings
  • Auth: HTTP bearer

Path parameters

entity_idstring required

A unique ID to specify the entity.

Headers

x-monite-versionstring required

Response

Successful Response

allow_purchase_order_autolinkingboolean

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

api_version'2024-05-25' | '2024-01-31' | '2023-09-01' | '2023-06-04' | '2023-04-12' | '2023-03-14' | '2023-03-01' | '2023-02-07' | '2022-11-16'
commercial_conditionsstring[]

Commercial conditions for receivables.

default_roleobject

A default role to provision upon new entity creation.

generate_paid_invoice_pdfboolean

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.

language'ab' | 'aa' | 'af' | 'ak' | 'sq' | 'am' | 'ar' | 'an' | 'hy' | 'av' | 'ae' | 'ay' | 'az' | 'bm' | 'ba' | 'eu' | 'be' | 'bn' | 'bi' | 'bs' | 'br' | 'bg' | 'my' | 'ca' | 'ch' | 'ce' | 'ny' | 'zh' | 'cu' | 'cv' | 'kw' | 'co' | 'cr' | 'hr' | 'cs' | 'da' | 'dv' | 'nl' | 'dz' | 'en' | 'eo' | 'et' | 'ee' | 'fo' | 'fj' | 'fi' | 'fr' | 'fy' | 'ff' | 'gd' | 'gl' | 'lg' | 'ka' | 'de' | 'el' | 'kl' | 'gn' | 'gu' | 'ht' | 'ha' | 'he' | 'hz' | 'hi' | 'ho' | 'hu' | 'io' | 'ig' | 'id' | 'ia' | 'ie' | 'iu' | 'ik' | 'ga' | 'it' | 'ja' | 'jv' | 'kn' | 'kr' | 'ks' | 'kk' | 'km' | 'ki' | 'rw' | 'ky' | 'kv' | 'kg' | 'ko' | 'kj' | 'ku' | 'lo' | 'la' | 'lv' | 'li' | 'ln' | 'lt' | 'lu' | 'lb' | 'mk' | 'mg' | 'ms' | 'ml' | 'mt' | 'gv' | 'mi' | 'mr' | 'mh' | 'mn' | 'na' | 'nv' | 'nd' | 'nr' | 'ng' | 'ne' | 'no' | 'nb' | 'nn' | 'ii' | 'oc' | 'oj' | 'om' | 'os' | 'pi' | 'ps' | 'fa' | 'pl' | 'pt' | 'pa' | 'qu' | 'ro' | 'rm' | 'rn' | 'ru' | 'se' | 'sm' | 'sg' | 'sa' | 'sc' | 'sr' | 'sn' | 'sd' | 'si' | 'sk' | 'sl' | 'so' | 'st' | 'es' | 'su' | 'sw' | 'ss' | 'sv' | 'tl' | 'ty' | 'tg' | 'ta' | 'tt' | 'te' | 'th' | 'bo' | 'ti' | 'to' | 'ts' | 'tn' | 'tr' | 'tk' | 'tw' | 'ug' | 'uk' | 'ur' | 'uz' | 've' | 'vi' | 'vo' | 'wa' | 'cy' | 'wo' | 'xh' | 'yi' | 'yo' | 'za' | 'zu'
payables_skip_approval_flowboolean

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

payment_priority'working_capital' | 'balanced' | 'bottom_line'
quote_signature_requiredboolean

Sets the default behavior of whether a signature is required to accept quotes.

receivable_edit_flow'compliant' | 'partially_compliant' | 'non_compliant'
vat_inclusive_discount_mode'exclusive' | 'inclusive'
vat_mode'exclusive' | 'inclusive'
websitestring

Changes

No recorded changes to this operation across all 1 revision of this API.