List payroll line rows
Crew module
GET/payroll-linespayrollLines.list
A payroll line, derived from approved timesheets. Returns a cursor page of payroll line rows the caller may see. The default order is `id` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability data.restricted.read.payroll.
- OAuth scopes: data.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of PayrollLine
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payroll line. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| payroll_run_id | string (uuid) | Yes | Identifier of the payroll run. |
| earning_code_id | string (uuid) | Yes | Identifier of the earning code. |
| hours | number | Yes | Hours. |
| amount_minor | integer | Masked | null | Yes | |
| membership_id | string (uuid) | Yes | Identifier of the membership of the person paid. |
| rate_minor | integer | Masked | null | Yes | |
| role_code | RoleCode | null | Yes | |
| cost_center_id | string (uuid) | null | Yes | Identifier of the cost center charged. |
{
"data": [
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"payroll_run_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"earning_code_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"hours": 8,
"amount_minor": 41600,
"membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"rate_minor": 5200,
"role_code": "5000.50.01",
"cost_center_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/payroll-lines" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.payrollLines.listAll()) {
console.log(row);
}for row in xos.payroll_lines.list_all():
print(row)xos payroll-lines list --all