Get partner settings | Monite Documentation

curl https://api.sandbox.monite.com/v1/settings \
     -H "x-monite-version: 2023-09-01" \
     -H "Authorization: Bearer <token>"

{
  "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,
    "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",
  "accounting": {
    "provider": "codat",
    "token": "token"
  }
}

Retrieve all settings for this partner.

Authentication

AuthorizationBearer

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

Response

Successful Response

api_versionenum

Default API version for partner.

commercial_conditionslist of strings

Commercial conditions for receivables.

currencyobject

Custom currency exchange rates.

default_rolemap from strings to any

A default role to provision upon new entity creation.

mailobject

Settings for email and mailboxes.

payableobject

Settings for the payables module.

paymentsobject

Settings for the payments module.

receivableobject

Settings for the receivables module.

unitslist of objects

Measurement units.

websitestring

accountingobjectDeprecated

Settings for the accounting module.

Errors

400

Get Settings Request Bad Request Error

422

Get Settings Request Unprocessable Entity Error

500

Get Settings Request Internal Server Error

Authentication

Headers

Response

Errors