Skip to main content
GET
/
entities
/
{entity_id}
/
settings
Get entity settings
curl --request GET \
  --url https://api.sandbox.monite.com/v1/entities/{entity_id}/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "accounting": {
    "ledger_account_ids": {
      "payments": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "products": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "tax_ids": {
      "deductions": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  },
  "allow_purchase_order_autolinking": true,
  "api_version": "2024-05-25",
  "commercial_conditions": [
    "<string>"
  ],
  "currency": {
    "default": "AED",
    "exchange_rates": [
      {
        "base": "AED",
        "rate": 123,
        "to": "AED"
      }
    ]
  },
  "default_role": {},
  "document_ids": {
    "document_type_prefix": {
      "credit_note": "CN",
      "delivery_note": "DN",
      "invoice": "INV",
      "purchase_order": "PO",
      "quote": "Q"
    },
    "include_date": false,
    "min_digits": 5,
    "prefix": "<string>",
    "separator": "-"
  },
  "document_rendering": {
    "credit_note": {
      "display_entity_bank_account": true
    },
    "display_entity_bank_account": true,
    "display_line_items": true,
    "invoice": {
      "display_entity_bank_account": true
    },
    "line_items": {
      "discount": {
        "display": true,
        "label": "<string>"
      },
      "measure_unit": {
        "display": true,
        "label": "<string>"
      },
      "name": {
        "display": true,
        "label": "<string>"
      },
      "price": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "price_after_vat": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "quantity": {
        "display": true,
        "label": "<string>"
      },
      "total_price": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "total_price_after_vat": {
        "display": true,
        "label": "<string>",
        "precision": 3
      },
      "vat_amount": {
        "display": false
      },
      "vat_rate": {
        "display": true,
        "label": "<string>",
        "precision": 3
      }
    },
    "quote": {
      "display_entity_bank_account": true,
      "display_signature": false
    }
  },
  "generate_paid_invoice_pdf": false,
  "language": "ab",
  "mail": {
    "attach_documents_as_pdf": true,
    "from_email_username": "<string>",
    "from_name": "<string>"
  },
  "payable": {
    "approve_page_url": "<string>",
    "allow_cancel_duplicates_automatically": false,
    "allow_counterpart_autocreation": false,
    "allow_counterpart_autolinking": false,
    "default_state": "new",
    "enable_line_items": true,
    "skip_approval_for_paid_invoice": false
  },
  "payables_ocr_auto_tagging": [
    {
      "enabled": true,
      "keywords": [
        "<string>"
      ],
      "tag_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "payables_skip_approval_flow": false,
  "payment_priority": "working_capital",
  "payments": {
    "payment_page_domain": "<string>",
    "payment_page_theme": {
      "background_color": "<string>",
      "border_radius": "<string>",
      "button": {
        "primary_color": "<string>",
        "primary_hover_color": "<string>",
        "secondary_color": "<string>",
        "secondary_hover_color": "<string>"
      },
      "card": {
        "background_color": "<string>"
      },
      "font_color": "<string>",
      "font_family": "<string>",
      "font_link_href": "<string>",
      "logo_src": "<string>"
    },
    "support_email": "jsmith@example.com"
  },
  "quote_signature_required": false,
  "receivable": {
    "create_without_personal_info": true,
    "deduction_title": "<string>"
  },
  "receivable_edit_flow": "compliant",
  "reminder": {
    "enabled": true
  },
  "units": [
    {
      "designation": "<string>",
      "name": "<string>"
    }
  ],
  "vat_inclusive_discount_mode": "exclusive",
  "vat_mode": "exclusive",
  "website": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-monite-version
string<date>
required

Path Parameters

​
entity_id
string<uuid>
required

A unique ID to specify the entity.

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

Response

Successful Response

​
accounting
object
​
allow_purchase_order_autolinking
boolean | null
default:true

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

​
api_version
enum<string> | null

Default API version for partner.

Available options:
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_conditions
string[] | null

Commercial conditions for receivables.

​
currency
object

Custom currency exchange rates.

​
default_role
object

A default role to provision upon new entity creation.

​
document_ids
object
​
document_rendering
object

Settings for rendering documents in PDF format.

​
generate_paid_invoice_pdf
boolean
default: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.

​
language
enum<string> | null
Available options:
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
​
mail
object

Settings for email and mailboxes.

​
payable
object

Settings for the payables module.

​
payables_ocr_auto_tagging
object[] | null

Auto tagging settings for all incoming OCR payable documents.

​
payables_skip_approval_flow
boolean
default:false

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

​
payment_priority
enum<string> | null
default:working_capital

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

Available options:
working_capital,
balanced,
bottom_line
​
payments
object

Settings for the payments module.

​
quote_signature_required
boolean
default:false

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

​
receivable
object

Settings for the receivables module.

​
receivable_edit_flow
enum<string> | null
default:compliant
Available options:
compliant,
partially_compliant,
non_compliant
​
reminder
object
​
units
object[] | null

Measurement units.

​
vat_inclusive_discount_mode
enum<string>
default:exclusive

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.

Available options:
exclusive,
inclusive
​
vat_mode
enum<string> | null
default:exclusive

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

Available options:
exclusive,
inclusive
​
website
string | null