Export one payroll run, per employee
One row per employee, matching the batch outcome — including failures. Rows come from the batch lines, which exist whether or not a payout was created, so an employee whose line failed validation appears with the reason rather than vanishing from the report. Those are exactly the people who were not paid and whom somebody has to chase.
One row per employee, matching the batch outcome — including failures.
Rows come from the batch lines, which exist whether or not a payout was created, so an employee whose line failed validation appears with the reason rather than vanishing from the report. Those are exactly the people who were not paid and whom somebody has to chase.
Authorization
OAuth2PasswordBearer In: header
Cookie Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
A report on one payroll run.
A run, not a period: payroll is reported per run because that is the thing a business signs off, and a date range spanning two runs would merge two sets of employees into one file.
Response Body
application/json
application/json
curl -X POST "https://example.com/api/b/v1/reports/payroll/export" \ -H "Content-Type: application/json" \ -d '{ "run_id": "7c2e9d10-3a4b-4c5d-8e6f-0a1b2c3d4e5f" }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "string", "format": "string", "status": "string", "filename": "string", "row_count": 0, "byte_size": 0, "error": "string", "expires_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z"}Export the audit trail POST
Every audited action in the period, for an auditor to hold. **Attempts as well as successes.** `succeeded` is a column, not a filter: a trail that records only what worked answers "what did we do" and not "what was attempted", and an investigation starts from the second. **Oldest first**, unlike the activity screen. Somebody reading an export is reconstructing a sequence; the newest-first order that suits a dashboard makes that read backwards. Actors are named, not just identified — the file is joined to the user rather than leaving an auditor to resolve UUIDs from a second export. System and API-key actions keep their place, with no name.
Reports requested GET
Next Page