Skip to main content
Company Configurations API
curl --request GET \
  --url https://api.pazy.io/v1.0/company/configurations

​
Authentication

All requests require an API key in the request headers. Headers: 
Authorization: Api-Key YOUR_API_KEY
This endpoint takes no query, path, or body parameters.

​
Code Examples

curl -X GET https://api.pazy.io/v1.0/company/configurations \
  -H "Authorization: Api-Key YOUR_API_KEY"

​
Success Response

HTTP Status: 200 OK The response contains the full list of configurable settings available for the organization. Each entry describes a single setting along with its current value, input type, and (where applicable) the allowed options. Settings that are not relevant to the organization (for example, integration-specific settings when that integration is not connected) are omitted. Response Fields:
FieldTypeDescription
okbooleanIndicates whether the request was successful
dataobjectContains the configurations response data
data.configurationsarrayList of configuration settings
data.configurations[].keystringUnique identifier of the setting. Use this as the key when updating via the Update Company Configurations API
data.configurations[].labelstringHuman-readable name of the setting
data.configurations[].valueboolean, string, number, or arrayCurrent value of the setting. The type depends on the setting type
data.configurations[].typestringInput type of the setting. Possible values: TOGGLE, SELECT, MULTISELECT, TEXT, NUMBER
data.configurations[].infoobjectHelp text describing the setting
data.configurations[].info.headerstringSummary line for the setting
data.configurations[].info.pointsarrayOptional list of additional explanatory points
data.configurations[].optionsarrayAllowed options. Present for SELECT and MULTISELECT settings
data.configurations[].options[].labelstringDisplay label for the option
data.configurations[].options[].descriptionstringOptional description of the option
data.configurations[].options[].valuestringValue of the option (used when updating the setting)
data.configurations[].isEditablebooleanWhether the setting can be updated. Settings with false are read-only
data.contextobjectResponse metadata
data.context.countnumberTotal number of configuration settings returned
data.context.accountingPlatformstring or nullName of the connected accounting platform (e.g., TALLY, ZOHO). null if no accounting integration is connected

​
Setting Type Values

Valuevalue typeDescription
TOGGLEbooleanOn / off switch
SELECTstringSingle choice from options
MULTISELECTarrayMultiple choices from options
TEXTstringFree-text value
NUMBERnumberNumeric value
The value returned here is the unwrapped value (e.g., "value": true). When updating a setting via the Update Company Configurations API, the value must be wrapped in an object — "value": { "value": true }.

​
Response Example

{
  "ok": true,
  "data": {
    "configurations": [
      {
        "label": "Rounding Off",
        "key": "IS_ROUND_OFF_ENABLED",
        "value": false,
        "info": {
          "header": "Enable to round off the Net Payable Amount",
          "points": []
        },
        "type": "TOGGLE",
        "isEditable": true
      },
      {
        "label": "Line Item Parsing",
        "key": "LINE_ITEM_PARSING_MODE",
        "value": "MULTI",
        "info": {
          "header": "Choose How To Parse Invoice Entries.",
          "points": [
            "Multi Line Item for detailed, multi-line entries.",
            "Single Line Item for simple, one-line entries."
          ]
        },
        "type": "SELECT",
        "options": [
          {
            "label": "Multi Line Items",
            "description": "Each line item will be parsed from the invoice.",
            "value": "MULTI"
          },
          {
            "label": "Tax Based Line Items",
            "description": "Group line items by tax rates.",
            "value": "TAX_BASED"
          },
          {
            "label": "Single Line Item",
            "description": "Multi-line items will be grouped into a single line item.",
            "value": "SINGLE"
          }
        ],
        "isEditable": true
      }
    ],
    "context": {
      "count": 2,
      "accountingPlatform": "TALLY"
    }
  }
}

​
Error Responses

​
Access Denied

HTTP Status: 403 Forbidden 
{
  "ok": false,
  "error": {
    "code": "ACCESS_DENIED",
    "message": "Access denied: Resource can be viewed only by admins and bookkeepers"
  }
}

​
Authentication Errors

HTTP Status: 401 Unauthorized 
{
  "ok": false,
  "error": {
    "code": "MISSING_CREDENTIALS",
    "message": "Missing Credentials"
  }
}

{
  "ok": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "Invalid API Key"
  }
}

​
Permission Errors

HTTP Status: 403 Forbidden 
{
  "ok": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "Permission check failed - PERMISSION_CHECK_FAILED"
  }
}

​
Internal Error

HTTP Status: 500 Internal Server Error 
{
  "ok": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal error"
  }
}

​
Best Practices

  • Read the current configuration here first, then update settings with the Update Company Configurations API using the key values returned above
  • Skip settings where isEditable is false — they cannot be updated
  • For SELECT and MULTISELECT settings, only send values that appear in the setting’s options
  • Access is limited to users with organization read permission and an admin or bookkeeper role