Daily use
Commission ledger
Read the append-only commission earnings ledger and participant balances, follow money from Pending to Settled, and see how corrections add linked entries.
updated: applies-to: 1.1.2.0
Bitta Commission keeps its results in append-only ledgers: an earning, once written, is never edited or deleted, and every movement of money between buckets is its own entry. This page shows you how to read Commission Earnings, follow a correction chain, and read a participant's position on Commission Balances.
Before you start
- Commission Earnings is read-only for everyone who can open it.
- Commission Balances requires finance-wide access. Without it the page refuses to open with BAA-FINANCE-SCOPE. See Permission sets.
- Earnings exist once a calculation run or period close has written them. See Calculate commission.
Read the earnings ledger
- Search for Commission Earnings in Tell Me and open it. Each line is one earning entry.
- Read the columns:
| Field | What it shows |
|---|---|
| Participant, Plan, Plan Version, Component, Period | Who earned it, under which frozen plan version, component and period. |
| Business Date | The business date of the source that produced the earning. |
| Commission Model | The model that priced it. |
| Final Earning Amount | The amount written by this entry. |
| Participant Currency Code | The currency the participant is paid in. |
| Prior Recognized Entitlement, Current Cumulative Entitlement | The running entitlement before and after this entry. |
| Delta Amount | The difference this entry adds. A return delta is negative. |
| Correction Sequence No. | Zero for an original earning; each later correction in the same chain counts up. |
- To see one sale's full history, select a line and choose Original and Return Earnings. The list filters to the same participant, component and correction root.
- Open a line to see the Commission Earning card with the calculation details and trace. See Explain any earning.
The other actions on the list:
- Source Evidence opens the accepted invoice or credit memo evidence.
- Correction Links shows the immutable original-to-delta links for the correction root.
- Trace Nodes opens the calculation trace; Calculation Run opens the run with its stage control totals.
- Release Pending Eligibility moves pending commission to eligible where its payment policy condition is met as of the work date: matured hold days, customer payments applied to the invoice, or a closed invoice. It is safe to run repeatedly. See Eligibility rules.
Earnings written by a period close, such as bonuses and rankings, also appear on Commission Period Earnings, with True-Up Chain for later adjustments. See Advanced models.
Follow the money on Commission Balances
- Search for Commission Balances in Tell Me and open it. Each line is one movement with a From Bucket, a To Bucket and a Signed Amount in the Participant Currency Code.
- Filter on Participant ID and the bucket fields to read one participant's position.
| Bucket | Meaning |
|---|---|
| Pending | Earned, waiting for the eligibility condition. |
| Eligible | Available to the next settlement. |
| Held | Kept out of payment, for example by a dispute hold. |
| Payable | Selected into a frozen settlement. |
| Settled | Paid. |
| Recoverable | A negative position to recover from future pay. |
| Written Off | A recoverable amount that was written off. |
| Forfeited | Pending commission that will not be paid. |
The normal path of an earning is Pending -> Eligible -> Payable -> Settled:
- Each eligibility entry writes a matching balance movement, for example Pending to Eligible when the payment condition is met.
- Freezing a settlement moves the selected amount from Eligible to Payable. See Settle commission.
- Recording the payment moves it from Payable to Settled.
- A recovery moves Eligible to Recoverable, and a write-off moves Recoverable to Written Off. See Commission clawbacks.
NOTE
Apply missing forfeitures writes the Pending-to-Forfeited movement for every forfeited eligibility entry that does not have one yet, so the Pending position matches the eligibility ledger.
Append-only by design
Earning, balance and trace entries reject every change, deletion and rename:
- "Earning entries are append-only and cannot be changed."
- "Balance entries are append-only and cannot be changed."
A correction therefore never edits the original. A linked return or a correction-request delta is appended as a new earning in the original's correction chain and linked to it on Commission Correction Links. A manual correction enters the pipeline as a new Manual Adjustment source fact. See Commission returns.
Reading the ledger from other tools
The commissionEarnings and commissionBalances API endpoints expose these ledgers to reporting tools. Both endpoints refuse inserts, changes and deletions. See API reference.
If the ledger does not look right
- An earning is missing. Check that the source fact is accepted and that a calculation run completed for it.
- The amount is wrong. Walk the trace first. If an input was wrong, use a governed correction, not an edit.
- Pending does not match eligibility. Run Apply missing forfeitures on Commission Balances.
- Balances do not match the G/L. See G/L reconciliation.
What's next
Handle credit memos and adjustments: Commission returns.