List payroll line rows

Módulo Crew

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.

Requiere la capacidad data.restricted.read.payroll.
Alcances de OAuth: data.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

payrollLines.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: 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).Restricciones: 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.

Respuesta 200: una página de PayrollLine

payrollLines.list: PayrollLine
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the payroll line.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
payroll_run_id	string (uuid)	Sí	Identifier of the payroll run.
earning_code_id	string (uuid)	Sí	Identifier of the earning code.
hours	number	Sí	Hours.
amount_minor	integer \| Masked \| null	Sí
membership_id	string (uuid)	Sí	Identifier of the membership of the person paid.
rate_minor	integer \| Masked \| null	Sí
role_code	RoleCode \| null	Sí
cost_center_id	string (uuid) \| null	Sí	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
}

Ejemplos de código

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