Payouts Process Control
Verified logic for versions 10.8.3-p44 to 24.2.2.7.u only.
1. Payout Clean (payout_clear)
This operation prepares the system for new calculations by:
Clearing existing Payout Results for the current company and accounting date.
Clearing started and finished dates for previous Calculate jobs for the accounting date.
2. Payout Calculate (payout_calculate)
This is the main job in the Payouts process.
It processes each Payouts agreement and well combination to generate the following values in Payout Results screen:
Beginning Balance to Recover: Sets the amount of the Ending Balance to Recover from the previous accounting date.
Gross Revenue: Sum of Line Amount in Accounting Results for the meter/well, for Accounting Date of same month as of Payouts accounting date.
Gross Deductions: Sum of Fee in Accounting Results for the meter/well, for Accounting Date of same month as of Payouts accounting date.
Gross Taxes: Sum of Tax in Accounting Results for the meter/well, for Accounting Date of same month as of Payouts accounting date.
This “category“ is something in the Cost Center/JIB Billing Codes/Payout Category that determines if something is from the category Intangible, Tangible, Equipment, Operating or Other. But I’m not sure how to identify exactly yet how this get’s grouped in the application.
Intangible Cost Recoveries: The sum of JIB Financial Results amounts + Direct Cost Results amounts + JIB Unbilled Charges amounts where category is Intangible, take the total and multiply by the Penalty rate set in Payouts Agreement -> Penalty Rates.
Tangible Completion Cost Recoveries: The sum of JIB Financial Results amounts + Direct Cost Results amounts + JIB Unbilled Charges amounts where category is Tangible, take the total and multiply by the Penalty rate set in Payouts Agreement -> Penalty Rates.
Equipment Cost Recoveries: The sum of JIB Financial Results amounts + Direct Cost Results amounts + JIB Unbilled Charges amounts where category is Equipment, take the total and multiply by the Penalty rate set in Payouts Agreement -> Penalty Rates.
Operating Expenditures Recoveries: The sum of JIB Financial Results amounts + Direct Cost Results amounts + JIB Unbilled Charges amounts where category is Operating, take the total and multiply by the Penalty rate set in Payouts Agreement -> Penalty Rates.
Other Expenditures Recoveries: The sum of JIB Financial Results amounts + Direct Cost Results amounts + JIB Unbilled Charges amounts where category is Other, take the total and multiply by the Penalty rate set in Payouts Agreement -> Penalty Rates.
Total Expenditures to Recover: Sum of the above recoveries amounts.
Net Revenue: Gross Revenue + Gross Deductions - Gross Taxes * Royalty Rate (Defined in Payout Agreements)
Ending Balance to Recover: Beginning Balance to Recover + Total Expenditures to Recover - Net Revenue.
3. Payout Finalize (payout_finalize)
This operation:
Marks all calculated results as finalized for the specified company code and accounting month
This effectively locks the results from further modifications