> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pazy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Company Configurations API

> Update one or more organization configuration settings

## Authentication

All requests require an API key in the request headers.

**Headers:**

```
Authorization: Api-Key YOUR_API_KEY
Content-Type: application/json
```

## Request

**Content-Type:** `application/json`

Update one or more settings by sending their `key` and new `value`. The available keys, their input `type`, and the allowed `options` are returned by the [Company Configurations API](/apis/company-configurations).

### Body Parameters

| Parameter          | Type   | Required | Description                                                                                                                  |
| ------------------ | ------ | -------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `settings`         | array  | Yes      | List of settings to update. Must contain at least one item                                                                   |
| `settings[].key`   | string | Yes      | Identifier of the setting to update (from the [Company Configurations API](/apis/company-configurations))                    |
| `settings[].value` | object | Yes      | New value, wrapped in an object: `{ "value": <newValue> }`. The inner value type must match the setting's `type` (see below) |

### Value Format

The `value` must be an object whose inner `value` field matches the setting type:

| Setting `type` | Inner value type                                     | Example                                      |
| -------------- | ---------------------------------------------------- | -------------------------------------------- |
| `TOGGLE`       | boolean                                              | `{ "value": true }`                          |
| `NUMBER`       | number                                               | `{ "value": 30 }`                            |
| `SELECT`       | string (one of the setting's `options`)              | `{ "value": "MULTI" }`                       |
| `TEXT`         | string                                               | `{ "value": "Custom text" }`                 |
| `MULTISELECT`  | array of strings (each from the setting's `options`) | `{ "value": ["cost-centre", "department"] }` |

## Code Examples

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PATCH https://api.pazy.io/v1.0/company/configurations \
    -H "Authorization: Api-Key YOUR_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
      "settings": [
        { "key": "IS_ROUND_OFF_ENABLED", "value": { "value": true } },
        { "key": "LINE_ITEM_PARSING_MODE", "value": { "value": "MULTI" } }
      ]
    }'
  ```

  ```javascript JavaScript (Fetch API) theme={null}
  const response = await fetch('https://api.pazy.io/v1.0/company/configurations', {
    method: 'PATCH',
    headers: {
      'Authorization': 'Api-Key YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      settings: [
        { key: 'IS_ROUND_OFF_ENABLED', value: { value: true } },
        { key: 'LINE_ITEM_PARSING_MODE', value: { value: 'MULTI' } }
      ]
    })
  });

  const result = await response.json();
  ```

  ```python Python (requests) theme={null}
  import requests

  url = "https://api.pazy.io/v1.0/company/configurations"
  headers = {
      "Authorization": "Api-Key YOUR_API_KEY",
      "Content-Type": "application/json"
  }
  payload = {
      "settings": [
          { "key": "IS_ROUND_OFF_ENABLED", "value": { "value": True } },
          { "key": "LINE_ITEM_PARSING_MODE", "value": { "value": "MULTI" } }
      ]
  }

  response = requests.patch(url, headers=headers, json=payload)
  result = response.json()
  ```
</CodeGroup>

## Success Response

**HTTP Status:** `200 OK`

Valid settings are applied even if some entries in the request fail validation. Settings that fail validation are skipped and reported in `misConfigurations` — always inspect this array to confirm every setting was applied.

**Response Fields:**

| Field                                      | Type    | Description                                            |
| ------------------------------------------ | ------- | ------------------------------------------------------ |
| `ok`                                       | boolean | Indicates whether the request was processed            |
| `data`                                     | object  | Contains the update result                             |
| `data.context`                             | object  | Update result metadata                                 |
| `data.context.patchedCount`                | number  | Number of settings that were successfully updated      |
| `data.context.misConfigurations`           | array   | Settings that failed validation and were skipped       |
| `data.context.misConfigurations[].key`     | string  | Key of the skipped setting                             |
| `data.context.misConfigurations[].value`   | object  | The rejected value                                     |
| `data.context.misConfigurations[].message` | string  | Reason the value was rejected                          |
| `data.context.misConfigurations[].options` | array   | Allowed option values for the setting, when applicable |

### Response Example

```json theme={null}
{
  "ok": true,
  "data": {
    "context": {
      "patchedCount": 2,
      "misConfigurations": []
    }
  }
}
```

### Response Example (with a skipped setting)

```json theme={null}
{
  "ok": true,
  "data": {
    "context": {
      "patchedCount": 1,
      "misConfigurations": [
        {
          "key": "LINE_ITEM_PARSING_MODE",
          "value": { "value": "INVALID_OPTION" },
          "message": "Value should be one of this options",
          "options": ["MULTI", "TAX_BASED", "SINGLE"]
        }
      ]
    }
  }
}
```

## Error Responses

### Setting Not Editable / Update Rejected

When a requested setting is read-only, or a value-specific rule fails (for example, an invalid active-currency change), the update is rejected as a whole. This is returned with an HTTP `200 OK` status, `ok: false`, and an `errorData` object — no settings are updated in this case.

**HTTP Status:** `200 OK`

```json theme={null}
{
  "ok": false,
  "errorData": {
    "isError": true,
    "error": "Key not editable"
  }
}
```

### Validation Error

Returned when the request body is malformed — for example, `settings` is missing or empty, or an item is missing `key` or `value`.

**HTTP Status:** `400 Bad Request`

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed: /body: must have required property 'settings'"
  }
}
```

### Access Denied

**HTTP Status:** `403 Forbidden`

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "Access denied: Resource can be updated only by admins and bookkeepers"
  }
}
```

### Authentication Errors

**HTTP Status:** `401 Unauthorized`

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}
```

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}
```

### Permission Errors

**HTTP Status:** `403 Forbidden`

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}
```

### Internal Error

**HTTP Status:** `500 Internal Server Error`

```json theme={null}
{
  "ok": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}
```

## Best Practices

* Always wrap the new value in an object: `{ "value": <newValue> }` — sending a bare value will fail validation
* Fetch the [Company Configurations API](/apis/company-configurations) first to get valid `key` values, the expected `type`, and the allowed `options`
* Check `data.context.misConfigurations` after each call — valid settings are still applied even when other entries are skipped, so a `200 OK` with `ok: true` does not guarantee every setting changed
* Treat a `200 OK` response with `ok: false` and an `errorData` object as a full rejection — no settings were updated
* Access is limited to users with organization update permission and an admin or bookkeeper role