Payment Batches
Group and submit payroll payments to the banking or payment processor.
List payment batches
Returns all payment batches for the tenant, including their processing status. Use to track disbursement progress across payroll runs.
Create payment batch for run
Creates a new payment batch grouping employee net-pay disbursements for a specific payroll run. A single run may have multiple batches (e.g. separated by bank or department). Batches must be submitted to the payment processor via the /submit action.
Submit payment batch
Submits a payment batch to the configured payment processor or bank integration. The batch transitions to 'submitted' status and disbursement begins asynchronously.
Mark payment batch as complete
Marks a submitted payment batch as fully completed and disbursed. Use after receiving confirmation from the bank or payment processor that all transactions settled.
Reconcile payment transaction
Marks an individual payment transaction within a batch as reconciled, linking it to a bank statement or payment processor confirmation. Use during month-end reconciliation.