Docs / Statement and Export Field Reference

Reference

Statement and export fields to review before handoff

Use this reference when checking statement output or payout-ready exports after a calculation run has been reviewed.

Details

What to know

Export boundary

An Allocora export is evidence and handoff data. It does not initiate bank transfer, payout processor, tax, or KYC activity by itself.

  • Use exports for finance review or downstream payout preparation.
  • Keep payment execution status in the downstream tool that moves money.
  • Retain the calculation run and statement as evidence for disputes.

Choose the journal basis explicitly

A locked standalone run can produce either a gross-accrual journal or a payable-ready journal only while it is the effective locked and terminal reporting leaf. A completed, approved, or locked replacement makes the prior run ineligible; pending, running, or failed descendants do not. Replacement and adjustment runs remain blocked until journal output can emit posting deltas; use an Adjustment Delta export to review those changes.

  • Gross accrual debits the configured expense account and credits the configured gross liability account.
  • Payable ready separates current-period royalty expense, payable liability, threshold and reserve balances, and signed recoupment or clawback components. Incoming retained amounts debit their recorded historical accounts; closing balances credit the accounts frozen with the calculation. When no account was configured at that time, the journal uses the account configured now. A carry-only period creates no new royalty expense.
  • When aggregate settlement changes the three-decimal liability, payable ready emits a separate settlement-rounding expense line so debit and credit remain explicit and balanced.
  • Payable ready is available only when component economics reconcile gross to net payable plus signed adjustments.
  • Allocora hashes the locked run, exact settlement snapshot, reviewed mapping, and complete payee external-ID map at preview. Creation rejects stale inputs, and queued generation uses the reviewed snapshots. Download the journal for your accounting workflow.

Reference Tables

Fields and checks

Statement fields

These fields help a payee or reviewer understand the calculated obligation.

Field Purpose Review note
statement_id Identifies the generated statement. Use it when answering payee questions.
period Shows the close period covered by the statement. Confirm the period before sharing.
payee_name Names the recipient of the calculated obligation. Match it to the intended payee record.
gross_basis Shows the revenue basis used before allocation. Compare against source revenue totals.
adjustments Shows corrections, refunds, or deltas. Review sign and explanation.
gross_allocated Shows the payee allocation before Contract Economics V1 adjustments. Use this to compare against rule allocation math.
net_payable Shows the canonical three-decimal amount after recoupment, reserves, clawbacks, and threshold holds. Use it to explain the obligation before currency-minor-unit settlement.
settled_payout Shows the payment-ready amount at the currency exponent from the locked settlement snapshot. Use this exact amount for downstream payment and reconciliation.
settlement_delta / status / reason Shows the difference from canonical net payable and whether the line is included, excluded, or zero. Use the reason to explain holds, minimum thresholds, zero rows, or a residual-minor-unit award.
carried_balance (shown as Total Closing Balance) Shows the remaining opening-balance, advance, expense, configured-clawback, and refund-clawback components. Review threshold and reserve closing balances separately from these recoupment and refund balances.
calculated_total Shows the final obligation Allocora calculated. This is not proof of payment movement.

Export fields

These fields help downstream accounting or payout workflows consume reviewed output.

Field Purpose Review note
payee_external_id Connects the export row to a downstream payee or vendor record. Confirm it is stable before handoff.
currency Prevents accidental mixed-currency payout batches. Export one currency workflow intentionally.
amount_due Carries the included settled payout amount at the currency exponent from the locked settlement snapshot. Use this exact value downstream; zero and excluded lines are omitted from payment-ready files.
payment_reference Carries a deterministic Allocora run/payee reference for external payment preparation. Use it as handoff context, not as proof that money moved.
memo Explains the run, period, and payee context for downstream payout or AP review. Keep it with the payment-ready file for audit context.
opening_balance_start / opening_balance_recouped / opening_balance_end Explain the opening-balance component carried into, applied in, and left after the period. A later period starts from the prior canonical locked end value.
advance_balance_start / advance_recouped / advance_balance_end Explain the advance component carried into, applied in, and left after the period. A payee profile/version change does not reset this component.
expense_balance_start / expense_recouped / expense_balance_end Explain the expense component carried into, applied in, and left after the period. Review the closing value before statement delivery.
configured_clawback_balance_start / configured_clawback_applied / configured_clawback_balance_end Explain the configured clawback component without combining it with refund carry. Use the end value as the next canonical period opening.
opening_refund_clawback_carry / refund_clawback_applied / new_refund_clawback_carry / closing_refund_clawback_carry Explain refund carry received, consumed, created, and left by the period. Review this separately from configured clawback terms.
reserve_held / threshold_held Show current-period holds that reduce net payable. Held means new retention in this period. Opening, Released, and Closing show the separate threshold and reserve balances.
threshold_opening / threshold_released / threshold_closing Show retained threshold amounts entering, leaving, and remaining after this period. A released amount becomes payable once; older statements preserve their historical balances.
reserve_opening / reserve_released / reserve_closing / reserve_to_threshold Show reserve balances and any reserve-to-threshold reclassification. Review these separately from new reserve_held and Total Closing Balance.
net_payable_amount / carried_balance Summarize what is payable now and the component Total Closing Balance. These are calculation evidence fields, not payment execution status.
settlement_snapshot_id / snapshot_hash / policy_version Bind close evidence to the immutable settlement decision and amount set. Keep these references with the package manifest; a stale reference must be regenerated rather than recomputed silently.
calculation_run_id Links the export row back to source evidence. Retain for audit and dispute review.
statement_url_or_id Connects payout handoff to payee-facing explanation. Share only after review approval.

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.