CAcardda
Rule

List inherited rules

Returns the paginated corporate-group (inherited) rules visible to the current company, each augmented with its translated_constraints, related_partners, and the current company's override (if any). Filter by kind and applicable_model.

get/v1/erp/payouts/rules/inherited

Request

  • Base URL
    https://api.cardda.com
  • URL
    https://api.cardda.com/v1/erp/payouts/rules/inherited
  • Auth
    HTTP bearer

Query parameters

kind'approval' | 'categorization'

Filter to approval or categorization rules.

applicable_modelstring

Target model bucket. Defaults to tradables.

Parameters

#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/1 (unresolved $ref)
#/paths/~1v1~1erp~1payouts~1rules/get/parameters/2 (unresolved $ref)

Response

Paginated list of inherited rules.

idstring uuid
namestring
company_idstring uuid

The company that owns the inherited (parent) rule.

enabledboolean
inheritableboolean
applicable_modelstring
created_atstring date-time
updated_atstring date-time
attribute_change_effectsobject[]
custom_column_change_effectsobject[]
reviewer_assigner_effectsobject[]
translated_constraintsobject nullable

The parent rule's constraints translated into the current company's context.

Changes

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