Update partner settings

PATCH

/settings

PATCH

/v1/settings

curl -X PATCH https://api.sandbox.monite.com/v1/settings \
     -H "x-monite-version: 2024-05-25" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "api_version": "2024-05-25",
  "commercial_conditions": [
    "commercial_conditions"
  ],
  "currency": {
    "default": "AED",
    "exchange_rates": [
      {
        "base": "AED",
        "rate": 0.98,
        "to": "AED"
      }
    ]
  },
  "default_role": {
    "key": "value"
  },
  "mail": {
    "attach_documents_as_pdf": true,
    "from_email_username": "from_email_username",
    "from_name": "from_name"
  },
  "payable": {
    "approve_page_url": "https://monite.com",
    "allow_cancel_duplicates_automatically": true,
    "allow_counterpart_autocreation": true,
    "allow_counterpart_autolinking": true,
    "allow_credit_note_autolinking": true,
    "default_state": "default_state",
    "enable_line_items": true,
    "skip_approval_for_paid_invoice": true
  },
  "payments": {
    "payment_page_domain": "payment_page_domain",
    "payment_page_theme": {
      "background_color": "background_color",
      "border_radius": "border_radius",
      "button": {
        "primary_color": "primary_color",
        "primary_hover_color": "primary_hover_color",
        "secondary_color": "secondary_color",
        "secondary_hover_color": "secondary_hover_color"
      },
      "card": {
        "background_color": "background_color"
      },
      "font_color": "font_color",
      "font_family": "font_family",
      "font_link_href": "font_link_href",
      "logo_src": "logo_src"
    },
    "support_email": "support_email"
  },
  "receivable": {
    "create_without_personal_info": true,
    "deduction_title": "deduction_title"
  },
  "units": [
    {
      "designation": "kg",
      "name": "Kilogram"
    }
  ],
  "website": "website"
}

Partner-level settings apply to all entities of that partner.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

api_versionenumOptional

Default API version for partner.

commercial_conditionslist of stringsOptional

Unused. To specify the terms and conditions for invoices and quotes, use the commercial_condition_description field in those documents.

currencyobjectOptional

Custom currency exchange rates.

default_rolemap from strings to anyOptional

A default role to provision upon new entity creation.

mailobjectOptional

Settings for outgoing email. Used by:

accounts receivable emails, for example, emails sent by POST /recevables/{receivable_id}/send,
accounts payable approval notifications.

Settings for outgoing email. Used by: * accounts receivable emails, for example, emails sent by `POST /recevables/{receivable_id}/send`, * accounts payable approval notifications.

payableobjectOptional

Settings for accounts payable.

paymentsobjectOptional

Settings for the payments module.

receivableobjectOptional

Settings for accounts receivable.

unitslist of objectsOptional

Unused. To manage the measure units for your entities, use the /measure_units endpoints.

Unused. To manage the [measure units](https://docs.monite.com/accounts-receivable/products#manage-measure-units) for your entities, use the `/measure_units` endpoints.

websitestringOptional

The URL of the partner’s website. Must be an HTTPS URL. Required if the partner’s entities use payment links. The “Powered by” badge in the payment page footer will link to this website.

The URL of the partner's website. Must be an HTTPS URL. Required if the partner's entities use [payment links](https://docs.monite.com/payments/payment-links). The "Powered by" badge in the payment page footer will link to this website.

Response

Successful Response