---
title: "Override an inherited rule"
method: PATCH
path: "/v1/erp/payouts/rules/{id}/override"
tags: ["Rule"]
---

# Override an inherited rule

`PATCH /v1/erp/payouts/rules/{id}/override`

## Request

- Base URL: `https://api.cardda.com`
- URL: `https://api.cardda.com/v1/erp/payouts/rules/{id}/override`
- Auth: HTTP bearer

Creates or updates the current company's override of an inherited (corporate-group) rule
identified by `{id}`. Returns the inherited rule with its updated `override` block.

Pass `inherit_override` to control whether the override itself propagates to child
companies. Include the standard rule fields (`name`, `enabled`, effects, `constraints`)
to define the overriding behavior.

## Parameters

- `#/paths/~1v1~1erp~1payouts~1rules/get/parameters/0` (unresolved $ref)
- `#/paths/~1v1~1erp~1payouts~1rules~1%7Bid%7D/get/parameters/1` (unresolved $ref)

## Request body

- object
  - `name` string
  - `enabled` boolean
  - `inherit_override` boolean: Whether the override propagates to child companies.
  - `constraints` object
  - `attribute_change_effects` object[]
  - `custom_column_change_effects` object[]
  - `reviewer_assigner_effects` object[]

## Response `200`

The inherited rule with the updated override.

- InheritedRule: An inherited (corporate-group) rule as seen by a child company, augmented with the translated constraints, related partners, and the company-specific override (if any).
  - `id` string, uuid
  - `name` string
  - `company_id` string, uuid: The company that owns the inherited (parent) rule.
  - `enabled` boolean
  - `inheritable` boolean
  - `applicable_model` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `attribute_change_effects` object[]
  - `custom_column_change_effects` object[]
  - `reviewer_assigner_effects` object[]
  - `company` object
    - `id` string, uuid
    - `identifier` string
    - `name` string
  - `translated_constraints` object, nullable: The parent rule's constraints translated into the current company's context.
  - `related_partners` object[]
    - `id` string, uuid
    - `name` string
    - `partner_id` string, uuid
  - `override` object, nullable: The current company's override of this inherited rule, or null when there is none.
    - `id` string, uuid
    - `inherit_override` boolean
    - `company_id` string, uuid
    - `new_rule` object, nullable: The overriding rule's payload, present only when the override is enabled.

## Other responses

- `401`: Unauthorized
- `404`: Inherited rule not found

---

[API](https://skmtc.dev/cardda/apis/erp-api.md) - [All operations](https://skmtc.dev/cardda/apis/erp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cardda/apis/erp-api/revisions/0730ed26bc3c?raw)
