Manage entity settings

Overview

Monite's entity settings are a way to customize the behavior of certain functionality for your entities. The entity settings API provides functionality for managing and configuring settings specific to entities within the Monite platform. They allow you to personalize and customize certain aspects of your entities' integration.

Some of these customizations include enabling payment and overdue reminders, customizing document number formatting, setting default currencies and currency exchange rates, and other entity-specific configurations.

Roles and permissions

To get or update entity settings using an entity user token, this entity user must have a role with the read and update permissions for the entity resource.

If using a partner-level token, no special permissions are needed.

Get entity settings

To retrieve settings for an entity, make a GET request to the /entities/{entity_id}/settings endpoint as shown:

curl -X GET 'https://api.sandbox.monite.com/v1/entities/5b031d0c...44df31ebf0db/settings' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer ACCESS_TOKEN' 

A successful request returns the current settings for the entity provided.

{
  ...
  "currency": {},
  "default_role": {},
  "document_ids": {
    "include_date": false,
    "prefix": "string",
    "separator": "-",
    "min_digits": 5,
    "document_type_prefix": {
      "quote": "Q",
      "invoice": "INV",
      "credit_note": "CN",
      "purchase_order": "PO"
    },
  },
  ...
  "language": "en",
  "payment_priority": "working_capital",
  ...
  "receivable_edit_flow": "compliant",
  "reminder": {
    "enabled": true
  },
  ...
}

Update entity settings

To update the details of an entity, make a PATCH request to the /entities/{entity_id}/settings endpoint.

The following snippet shows an example of the payload for the PATCH /entities/:id/settings endpoint that enables payment reminders for entity invoices and updates the document ID format for invoices and quotes.

curl -X PATCH 'https://api.sandbox.monite.com/v1/entities/5b031d0c...44df31ebf0db/settings' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'Authorization: Bearer ACCESS_TOKEN' \
     -H 'Content-Type: application/json' \
     -d '{
       "reminder": {
         "enabled": true
       },
       "language": "fr", 
       "document_ids": {
         "include_date": true,
         "min_digits": 4,
         "document_type_prefix": {
           "invoice": "IN"
         }
       }
     }'

The successful request returns the complete entity settings object with the updated fields.

The language field on the entity settings object determines the language of the entity's PDFs.

📘

The payload to update entity settings only accepts the currency, language, reminder, payment_priority, receivable_edit_flow, and document_ids fields. Other fields in the Entity settings response object can only be updated using the endpoint to update partner settings—PATCH /settings .