List global consensus rules with tenant account resolution

GEThttps://app.speybooks.com/api/v1/categorisation-rules/global

Returns the shared platform default rules, resolved to your own chart of accounts. Each entry carries indicators of how widely the default is used so you can judge its reliability before relying on it. These defaults are read-only here; to override one, create your own rule, which takes precedence.

Response

200Global consensus rules resolved against this tenant's chart of accounts.

Show response fields

rulesarray<object>

Show child attributes

businessTypestringnullable

confidencenumber

distinctTenantsinteger

fieldstring

namestring

normalisedKeystring

operatorstring

resolvedAccountobject

Show child attributes

codestring

namestring

stdCategorystring

usageCountinteger

totalinteger

RequestGET/v1/categorisation-rules/globalcurl

curl https://api.speybooks.com/v1/categorisation-rules/global \
  -H "Authorization: Bearer sk_test_..."

Response200

{
  "success": true,
  "data": {
    "rules": [
      {
        "normalisedKey": "TESCO",
        "name": "Tesco",
        "field": "description",
        "operator": "contains",
        "stdCategory": "office_expenses",
        "confidence": 0.92,
        "distinctTenants": 47,
        "usageCount": 1243,
        "businessType": null,
        "resolvedAccount": {
          "code": "7400",
          "name": "Office Expenses"
        }
      }
    ],
    "total": 156
  }
}