Sign in
Rule

Get a rule

Returns a single rule with its effects and its related_partners (business partners referenced by the rule's constraints).

get/v1/erp/payouts/rules/{id}

Path parameters

idstring uuid required

The ID of the resource

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 — unresolved $ref

Response

The rule.

idstring uuid required
namestring
user_idstring

The user that created the rule.

company_idstring uuid required
constraintsobject nullable

The JSON constraint tree that determines which records the rule matches.

enabledboolean
inheritableboolean

Whether child companies in the corporate group inherit this rule.

applicable_modelstring

Target model bucket the rule applies to. Defaults to tradables (payables). Set once at creation and immutable thereafter.

hiddenboolean
overrides_rule_idstring uuid nullable
inherit_overrideboolean
created_atstring date-time
updated_atstring date-time
related_partnersobject[]

Business partners referenced by the rule's constraints. Included only in the show response (via the related_partners method).

Example response

{
  "applicable_model": "tradables"
}

Changes