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
- 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.
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 to the employee's bank directly if you automate that step. A payout can be cancelled as long as it hasn't been processed by the bank yet.
FAQ
Can I trigger more than one payout per period?
Yes - advance, correction, final; each one only pays out what hasn't been paid yet.
Can I cancel a payout after the bank has processed it?
No - cancellation only works while it hasn't been processed yet.
Where do I find the payment file if I miss the webhook?
Download it any time via the payout's document endpoint, or see Outputs for the webhook subscription.
Can I pay out a single employee, or only everyone at once?
Either - payout selection is per employee; pick one, several, or everyone with an open amount.
Can I pay an employee an advance? How much?
Yes, as an advance payout - up to whatever their currently open/calculated amount is. There's no separate advance-specific limit beyond that.
When does an employee show up as "paid out"?
Once their open amount for the period reaches zero, i.e. everything owed has been paid.
Do I see payslips per payout, or one per period?
One payslip per employee per period, regardless of how many payouts happened within it - see Outputs.
API Endpoints
| What | Call |
|---|---|
| List payouts of a period | GET .../payrunperiods/{payrunPeriodId}/payouts |
| Create a payout | POST .../payrunperiods/{payrunPeriodId}/payouts |
| Cancel a payout | POST .../payouts/{payoutId} |
| Download a payout's payment file | GET .../payouts/{payoutId}/document |