Accounting Rules

An accounting rule is a standing instruction to the Snapbooks automation: “when this happens, do this”. A company writes rules for its own books, and an accounting firm (regnskapsbyrå) writes rules for the companies it keeps the books for, optionally narrowed to an industry. Snapbot carries out a rule when a document arrives, when a bank transaction arrives, or on a schedule.

Rules are written with Snapbot, in the app’s chat or through the save_accounting_rule tool on the MCP server. The API does not create or edit rules. It lists and reads them, and it switches a rule on or off.

Versions

Rules are versioned. Editing a rule retires the live row (it gets a deleted_at and is_deleted: true) and inserts a new row with the same sequence_number. Each version has its own id, so a run of a rule can point to the version it carried out. The list returns live versions by default. GET /api/v2/accounting-rules/{id} returns any version, live or retired.

Who can read a rule

Endpoints

List Accounting Rules

GET /api/v2/accounting-rules

Returns a paginated list of the rules the caller may read, ordered by owner, then rule number, then version.

Query Parameters

Example Request

GET /api/v2/accounting-rules?client_account_id=456&scope=PROVIDER&with=industries
Authorization: Bearer <token>

Response

{
  "data": [
    {
      "id": 812,
      "client_account_id": 456,
      "sequence_number": 3,
      "scope": "PROVIDER",
      "industry_codes_lv": ["86"],
      "name": "Helfo settlements",
      "is_active": true,
      "trigger": "BANK_TRANSACTION_RECEIVED",
      "condition": "Incoming payments from Helfo",
      "schedule": null,
      "instruction": "Post the payment against account 3110 with no VAT.",
      "created_at": "2026-11-02T09:14:00Z",
      "created_by_id": 789,
      "updated_at": null,
      "updated_by_id": null,
      "deleted_at": null,
      "deleted_by_id": null,
      "is_deleted": false,
      "industries": [
        { "code": "86", "name": "Helsetjenester" }
      ]
    }
  ],
  "meta": {
    "page": 1,
    "pages": 1,
    "per_page": 100,
    "records": 1
  }
}

Get Accounting Rule

GET /api/v2/accounting-rules/{id}

Returns one version of a rule, live or retired.

Path Parameters

Query Parameters

Response

A single rule object. A scheduled rule has a schedule and no condition:

{
  "id": 915,
  "client_account_id": 123,
  "sequence_number": 1,
  "scope": "CLIENT",
  "industry_codes_lv": [],
  "name": "Monthly accruals",
  "is_active": true,
  "trigger": "SCHEDULE",
  "condition": null,
  "schedule": "0 7 1 * *",
  "instruction": "Accrue last month's rent and reverse it on the first of the next month.",
  "created_at": "2026-11-10T12:00:00Z",
  "created_by_id": 789,
  "updated_at": null,
  "updated_by_id": null,
  "deleted_at": null,
  "deleted_by_id": null,
  "is_deleted": false
}

Switch a Rule On or Off

PATCH /api/v2/accounting-rules/{id}

Switches the live version of a rule on or off in place, without creating a new version. The body must contain is_active and nothing else. Any other field, or a value that is not a JSON boolean, is rejected with accounting_rule.unsupported_update. Sending the state the rule already has changes nothing, including updated_at and updated_by_id.

Who may switch a rule:

• A PROVIDER rule: active members of the owning firm.
• A CLIENT rule: the company’s users with an owner (CA or AA) or bookkeeper (BK) role, and staff of accounting firms with contract access to it.

Request Body

Example Request

{
  "is_active": false
}

Response

The updated rule object.

The Accounting Rule Object

Scope Values

Trigger Values

Which Rule Wins

When several rules match the same document or bank transaction, the most specific level with a match wins: the company’s own CLIENT rules first, then the firm’s PROVIDER rules by longest matching industry code, then the firm’s rules without industry codes.

Error Responses

See Error Handling for the error envelope.

Related Resources

• MCP server - get_accounting_rules and save_accounting_rule, the tools that read and write rules
• Worker Tasks - each run of a rule is an ACCOUNTING_RULE worker task
• Contracts - the accounting contracts that decide which companies a firm’s rules cover
• Client Accounts - rule owners