A payout pays out an employee's current balance for the open payrun period - at any time, not just once at period end.
When to trigger one
- Advance payment - pay part of the salary early, e.g. mid-month, up to the employee's currently open/calculated amount - there's no separate advance-specific limit
- Correction - a case change updated the result; pay out the difference
- Final payment - the regular, complete payout for the period
- Multiple payouts can happen within the same open period - each one only pays out what hasn't been paid yet
- Selecting who gets paid: per employee - pick one, several, or everyone with an open amount
What you get back
- Creating a payout returns a payment file (
pain.001, the standard Swiss/European bank payment format) - ready to hand to your bank, or the employee's bank directly if you automate that step. Missed the webhook? Download it any time via the payout's document endpoint, or see Webhooks - A payout can be canceled as long as it hasn't been processed by the bank yet
- "Paid out" status: once an employee's open amount for the period reaches zero
- Payslips: one per employee per period, regardless of how many payouts happened - see Outputs
API Endpoints
| What | Call |
|---|---|
| List payouts of a period | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts |
| Create a payout | POST /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts |
| Cancel a payout | POST /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId} |
| Download a payout's payment file | GET /tenants/{orgId}/payrolls/{payrollId}/payrunperiods/{payrunPeriodId}/payouts/{payoutId}/document |