GetSettings
[POST] .../v1/firm/getsettings
Returns settings enterprise. Use this method to read firm-level settings after selecting a company or before editing configuration values. The request requires firm_id as a Equal filter and the response returns setting id, key, translated name, data type, value and last_update. The caller must have firm select permission; missing body, invalid firm_id, denied access, missing settings and storage errors are returned as HTTP 200 ErrorResult business errors.
Request Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| filters | Array of Filter | Optional | Optional filters by fields available for this API method. |
Filterable Fields
| Field | Type | Description |
|---|---|---|
| firm_id | int | Firm ID. |
Request Example
{
"filters": [
{
"field": "firm_id",
"operator": "Equal",
"value": "2"
}
]
}Response Parameters
| Name | Type | Description |
|---|---|---|
| ok | Boolean | Indicates whether the request completed successfully. |
| result | Array of FirmSetting | Result object. |
Response Example
{
"ok": true,
"result": [
{
"id": 41,
"key": "rounding_enabled",
"name": "Rounding enabled",
"value": "true",
"name_var": "ROUNDING_ENABLED",
"dataType": "bool",
"last_update": 1712345600
}
]
}