Get a payroll line
Crew module
GET/payroll-lines/{id}payrollLines.get
A payroll line, derived from approved timesheets. Returns one payroll line with its `ETag`. A payroll line the caller may not see returns 404.
- Requires the capability data.restricted.read.payroll.
- OAuth scopes: data.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the payroll line. |
| 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_]*)*$ |
Response 200: 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. |
{
"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"
}Code samples
curl -X GET "$XOS_BASE_URL/payroll-lines/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.payrollLines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.payroll_lines.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos payroll-lines get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f