Sign in
Rule

Create a rule

Creates an automation rule with its constraints and effects. applicable_model is set once here and is immutable afterwards.

post/v1/erp/payouts/rules

Parameters

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

Request body

namestring
company_idstring uuid
enabledboolean
inheritableboolean
applicable_modelstring

Target bucket. Defaults to tradables. Only honored on create.

constraintsobject

Constraint tree as a flat map of dotted paths to values, expanded server-side into nested constraint attributes.

Response

The created 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

No recorded changes to this endpoint across all 1 revision of this API.