Download the bank upload file
The salary upload file for the run, in the layout of the payment method's bank. Held employees and employees with incomplete bank details are left out - GET /payroll-runs/{id}/disbursement-summary lists who and why.
format=csv is the generic layout most banks accept; format=txt is the fixed-width variant some corporate portals require.
Path parameters
id requiredstring | Payroll run id. |
Query parameters
format enum: csv, txt | File format. Defaults to csv. |
payment_method_id integer | Render only the employees paid through this method. |
Responses
200The requested file. The content type followsformat-text/csv,text/plain,application/pdf, or the Office XML type forxlsx.401The key is missing, unknown, or the HMAC signature did not verify. ErrorResponse404No such resource, or it belongs to an organization this key cannot reach. ErrorResponse409The resource is in a state that forbids the change - a locked or paid run, a duplicateexternal_id, or a settlement already approved. ErrorResponse