---
title: "List rules"
method: GET
path: "/v1/erp/payouts/rules"
tags: ["Rule"]
---

# List rules

`GET /v1/erp/payouts/rules`

Returns a paginated list of the company's automation rules, each embedding its
`attribute_change_effects`, `custom_column_change_effects`, and
`reviewer_assigner_effects`. Override rules are excluded.

Rules are partitioned by `applicable_model` (defaults to `tradables`). Filter by `kind`
(`approval` rules have reviewer effects; `categorization` rules do not),
`business_partner_id`, `inheritable`, and `applicable_model`.

## Query parameters

- `_start` integer
- `_end` integer
- `_order` 'asc' | 'desc'
- `_field` string
- `kind` 'approval' | 'categorization'
- `business_partner_id` string, uuid
- `inheritable` boolean
- `applicable_model` string

## Headers

- `company-id` string, uuid, required

## Response `200`

Paginated list of rules (default 25 per page).

- Rule[]
  - `id` string, uuid, required
  - `name` string
  - `user_id` string — The user that created the rule.
  - `company_id` string, uuid, required
  - `constraints` object, nullable — The JSON constraint tree that determines which records the rule matches.
  - `enabled` boolean
  - `inheritable` boolean — Whether child companies in the corporate group inherit this rule.
  - `applicable_model` string — Target model bucket the rule applies to. Defaults to `tradables` (payables). Set once at creation and immutable thereafter.
  - `hidden` boolean
  - `overrides_rule_id` string, uuid, nullable
  - `inherit_override` boolean
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `attribute_change_effects` object[]
    - `id` string, uuid
    - `target_attribute` string
    - `target_value` string
  - `custom_column_change_effects` object[]
    - `id` string, uuid
    - `target_custom_column_id` string, uuid
    - `target_value` string
  - `reviewer_assigner_effects` object[] — Approval effects that assign reviewers. Present only for approval rules.
    - `id` string, uuid
    - `reviewer_user_id` string
    - `reviewer_order` integer
  - `related_partners` object[] — Business partners referenced by the rule's constraints. Included only in the `show` response (via the `related_partners` method).

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/cardda/apis/banking-api.md) · [All operations](https://skmtc.dev/cardda/apis/banking-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cardda/banking-api/revisions/ff1aeb3fda8b/schema)