Docs / Rule Field Reference

Reference

Rule fields that control payout calculations

Use this reference to review the decisions that make a payout rule explainable before a calculation run is created.

Details

What to know

Rule review standard

A rule should be narrow enough that a future reviewer can explain why it matched a row and how the allocation amount was produced.

  • Use effective dates for contract changes.
  • Name rules after the policy, contract, or use case they represent.
  • Simulate major changes before using the rule in a real close period.

Reference Tables

Fields and checks

Core rule fields

Review these fields before enabling or simulating a payout rule.

Field Purpose Review question
payee Recipient of the calculated allocation. Is this the correct partner, seller, creator, affiliate, or entity?
scope Limits which rows qualify by product, source, metadata, or period. Could this rule match rows it should not match?
rate_or_split Defines the percentage, tier, fixed amount, cap, floor, or split logic. Does the math match the contract or payout policy?
priority Controls rule order when more than one rule could match. Is the priority intentional and documented?
effective_dates Keeps prior periods tied to the correct historical logic. Do changes start and end in the expected periods?
status Indicates whether the rule is draft, active, inactive, or archived. Should this rule affect the next calculation run?

Feedback

Was this page helpful?

Send a note if a step is unclear, missing, or out of date.

Email Support

Apply this in a workspace

Start free, use sample data, then replace examples with your own revenue rows when the workflow is clear.