List rules

get

https://api.cardda.com/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

_start

integer

≥ 0

If all the transactions where in an array, this would represent the index of the first item returned in the response

_end

integer

≥ 0

If all the transactions where in an array, this would represent the index of the last item returned in the response

_order

string

enum

The order method, which can be ascending or descending

Allowed:

_field

string

The field used to sort, the example illustrates a response that would be sorted by the creation date

kind

string

enum

Filter to approval rules (with reviewer effects) or categorization rules.

Allowed:

business_partner_id

uuid

Filter to rules that target the given business partner.

inheritable

boolean

Filter by whether the rule is inheritable by child companies.

applicable_model

string

Defaults to tradables

Target model bucket. Defaults to tradables.

Headers

company-id

uuid

required

UUID of the company on whose behalf the request is made. Required for every Pay endpoint.
See The company-id header for details on how to obtain
a value for this header and the error responses to expect when it is missing or invalid.

If the deprecated company_id query parameter is also sent, both values must match;
the API returns 422 Unprocessable Entity when they disagree.

Responses

401

Unauthorized

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Paginated list of rules (default 25 per page).