Skip to main content
GET
/
settings
Get partner settings
curl --request GET \
  --url https://api.sandbox.monite.com/v1/settings \
  --header 'Authorization: Bearer <token>' \
  --header 'x-monite-version: <x-monite-version>'
{
  "api_version": "2024-05-25",
  "commercial_conditions": [
    "<string>"
  ],
  "currency": {
    "default": "AED",
    "exchange_rates": [
      {
        "base": "AED",
        "rate": 123,
        "to": "AED"
      }
    ]
  },
  "default_role": {},
  "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,
    "allow_credit_note_autolinking": false,
    "default_state": "new",
    "enable_line_items": true,
    "skip_approval_for_paid_invoice": false
  },
  "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"
  },
  "receivable": {
    "create_without_personal_info": true,
    "deduction_title": "<string>"
  },
  "units": [
    {
      "designation": "<string>",
      "name": "<string>"
    }
  ],
  "website": "https://example.com/"
}

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

Response

Successful Response

​
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

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

​
currency
object

Custom currency exchange rates.

​
default_role
object

A default role to provision upon new entity creation.

​
mail
object

Settings for outgoing email. Used by:

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

Settings for accounts payable.

​
payments
object

Settings for the payments module.

​
receivable
object

Settings for accounts receivable.

​
units
object[] | null

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

​
website
string | null

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.

Example:

"https://example.com/"