Finance settings
INFO
Every response arrives in the shared envelope — code, message, messages, status_code, time — with the payload in data. The tables below describe what is inside data.
GET /finance-settings/get
Get the tenant's finance settings (created with defaults on first access).
Request body
No request body.
Response
| Field | Type | Description |
|---|---|---|
_id | string | |
account_id | string | |
apply_in_main | boolean | |
service_cost_type | string | One of: fixed, priced |
multi_currency | boolean | |
expense_approval_enabled | boolean | |
expense_approval_limit | number | |
discount_below_min_price_policy | string | One of: strict, warning, override |
expense_approval_currency | object | |
expense_approval_currency._id | string | |
expense_approval_currency.name | string | |
expense_approval_currency.symbol | string | |
expense_approval_currency.value | number |
json
{
"code": 0,
"message": "Success",
"status_code": 200,
"data": {
"_id": "string",
"account_id": "string",
"apply_in_main": false,
"service_cost_type": "fixed",
"multi_currency": false,
"expense_approval_enabled": false,
"expense_approval_limit": 0,
"discount_below_min_price_policy": "strict",
"expense_approval_currency": {
"_id": "string",
"name": "string",
"symbol": "string",
"value": 0
}
},
"time": "2025-05-01T12:00:00Z"
}PUT /finance-settings/set
Update the tenant's finance settings (partial patch). Setting expense_approval_currency_id denormalizes the currency; multi_currency cannot be disabled while more than one currency exists.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
apply_in_main | boolean | No | Apply finance rules in the main organization |
service_cost_type | string | No | Service cost calculation type. One of: fixed, priced |
multi_currency | boolean | No | Enable multi-currency. Cannot be turned off while more than one currency exists. |
expense_approval_enabled | boolean | No | Require owner approval for expenses above the limit |
expense_approval_limit | number | No | Approval threshold amount (in the approval currency) |
expense_approval_currency_id | string | No | Currency ObjectId the approval limit is denominated in |
discount_below_min_price_policy | string | No | Policy when a sale discount drops below the product minimum price. One of: strict, warning, override |
json
{
"apply_in_main": false,
"service_cost_type": "fixed",
"multi_currency": false,
"expense_approval_enabled": false,
"expense_approval_limit": 0,
"expense_approval_currency_id": "string",
"discount_below_min_price_policy": "strict"
}Response
Same response shape as GET /finance-settings/get.
This page is generated from the OpenAPI spec.