Scripting on Payouts
Payout Calculation Scripts
Custom scripts can be applied during payout batch calculation to implement agency-specific fee rules, hold conditions, or distribution logic beyond the standard configuration.
When they run: During the Build Payouts action on a Payout Batch
Purpose: Apply custom fee calculations, conditional holds, distribution overrides
Common uses:
- Apply a tiered fee structure based on designation amount
- Hold designations from specific employers pending employer confirmation
- Override fee calculation for specific fund types
- Apply agency-specific minimum distribution thresholds
Configure payout calculation scripts in the GivingCampaign’s Integration tab or via a custom PayoutBatch extension.
Script context:
| Variable | Contents |
|---|---|
payoutBatch |
The Payout Batch being calculated |
fund |
The fund being evaluated |
organization |
The agency organization |
account |
The DonorPoint account |
campaignYear |
The campaign year in scope |
Scheduled Scripts for Payouts
Time-based automation for the payout lifecycle:
- Nightly payout file generation — generate agency remittance files in required formats
- Agency notification — email agencies their payout summary after batch commit
- GL posting — post payout records to an accounting system
Configure in Integration → Scheduled Scripts.
→ Full context reference: Scripting Contexts