Skip to main content

​
What is the Incentive object?

The Incentive object stores calculated payout records for sales performance.
It is designed as a calculation-driven object rather than a manual-entry object.As of February 11, 2026, the list page supports viewing and filtering, while operational actions (calculation, approvals, payout batching) are mainly API-driven.

​
Current scope

You are correct: the current UI does not yet provide:
  • an incentive plan creation screen
  • a run-calculation button
At this stage, these actions are executed through API endpoints:
  • Create plan: POST /api/v1/incentives/plans
  • Run calculation: POST /api/v1/incentives/calculate
Notes:
  • You need an authenticated session and workspace code.
  • The Incentive page in Process is currently focused on viewing and filtering generated records.

​
Why there is no Create button

Incentive records need to be reproducible and auditable by period and plan.
To keep calculation logic consistent, records are generated from a run process instead of manual one-by-one creation.That is why the Incentive screen does not show a standard New button like other objects.

​
Order-based vs Payment-based

An incentive plan can calculate from one of two base events:
  • Order-based: calculates from confirmed orders
  • Payment-based: calculates from received payments
This choice changes both timing and eligible source records.
Set this rule first before your team starts monthly operations.

​
Monthly workflow

  1. Create an incentive plan
    Define rate type, rate value, minimum amount, cap, and effective period.
  2. Run calculation for a month
    Example period: 2026-02.
  3. Review and approve draft incentives
    Validate owners, source records, and amounts.
  4. Create a payout batch
    Collect approved incentives into a monthly batch.
  5. Approve batch and mark paid
    Finalize payout status for finance operations.

​
Status lifecycle

Incentive status moves through:
  • draft: created by calculation
  • approved: approved for payout
  • paid: payout completed
  • reversed: adjusted/cancelled with reversal record
The normal path is draft -> approved -> paid.

​
Permissions

Typical operational scope:
  • Rep: view own incentives
  • Manager: view and approve team incentives
  • Finance/Admin: full control including plan and payout batch actions
Define approval responsibility and payout ownership before go-live.