API referenceReports
Reports requested
Authorization
OAuth2PasswordBearer AuthorizationBearer <token>
In: header
Query Parameters
kind?|
collections, payouts or payroll. Omit for all three.
limit?Limit
Range
1 <= value <= 200Default
50Cookie Parameters
Response Body
application/json
application/json
curl -X GET "https://example.com/api/b/v1/reports/exports"{ "exports": [ { "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 one payroll run, per employee POST
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.
What we notify about GET
Absent means on. An event with no row is enabled on both channels — a business that has never opened this screen should still hear that a payout failed, so the useful default cannot require a row to exist.