Skip to main content
GET
List pay stubs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

payroll_id
string
business_entity_id
string

Only return pay stubs under the specified business entity.

pay_schedule_id
string

Only return pay stubs on the specified pay schedule.

work_assignment_id
string
sort
enum<string>

Sort order is specified using the format sort=field[:direction][,field[:direction],...] where field is the name of the field to sort by and direction is the optional sort direction (asc or desc).

These sort fields are deprecated and will be removed. Use the replacement instead:

  • payee.default, replaced by work_assignment.payee.default
  • payee.first_name, replaced by work_assignment.payee.first_name
  • payee.last_name, replaced by work_assignment.payee.last_name
Available options:
payee.default,
payee.first_name,
payee.last_name,
payroll.pay_date,
work_assignment.payee.default,
work_assignment.payee.first_name,
work_assignment.payee.last_name
next_pay_stubs
enum<string>

Filter paystubs to either include only (only), or exclude (exclude), the upcoming pay stubs.

An upcoming pay stub is defined as: - Any pay stub that belongs to the first Regular payroll in the pay schedule with a payroll status of either draft or approved. - Additionally, all pay stubs from draft or approved Off Cycle payrolls within the pay schedule are considered upcoming pay stubs.

Available options:
exclude,
only
employee_id
string
contractor_id
string
type
enum<string>
Available options:
contractor,
employee
payroll_status
Available options:
approved,
draft,
failed,
paid,
partially_paid,
processing
payroll_type
Available options:
correction,
historical,
off_cycle,
regular
has_accounting_code
boolean
payrolls.period_start
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payrolls.period_start=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payrolls.period_start[gte]=2024-01-01&payrolls.period_start[lt]=2024-12-31
payrolls.period_end
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payrolls.period_end=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payrolls.period_end[gte]=2024-01-01&payrolls.period_end[lt]=2024-12-31
payrolls.pay_date
object

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: payrolls.pay_date=2024-01-01 Use an array-like syntax to specify a range with one or more comparison operators:

  • gt (greater than)
  • gte (greater than or equal to)
  • lte (less than or equal to)
  • lt (less than) Example: payrolls.pay_date[gte]=2024-01-01&payrolls.pay_date[lt]=2024-12-31
external_ref
string
has_work_assignment_tag_id
string
has_work_assignment_tag_group_id
string
requires_work_assignment_tag_id
string
requires_work_assignment_tag_group_id
string
expand
enum<string>[]
Available options:
allowance_line_items,
deduction_line_items,
earning_line_items,
employee_benefit_line_items,
employer_benefit_line_items,
employer_statutory_withholding_line_items,
payroll,
reimbursement_line_items,
statutory_withholding_line_items,
work_assignment

Response

200 - application/json

OK

object
string
read-only

The type of the object in Nmbr ("list").

data
object[]