Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Pay Stubs

List pay stubs

Pay Stubs are sorted by the employees last_name, and contractors business_name, by default.

get/pay_stubs

Query parameters

payroll_idstring
business_entity_idstring

Only return pay stubs under the specified business entity.

pay_schedule_idstring

Only return pay stubs on the specified pay schedule.

work_assignment_idstring
sort'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'

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).

next_pay_stubs'exclude' | 'only'

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.

employee_idstring
contractor_idstring
type'contractor' | 'employee'
'approved' | 'draft' | 'failed' | 'paid' | 'partially_paid' | 'processing'
OR
string[]
'correction' | 'historical' | 'off_cycle' | 'regular'
OR
string[]
has_accounting_codeboolean
payrolls.period_startobject

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_endobject

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_dateobject

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_refstring
has_work_assignment_tag_idstring
has_work_assignment_tag_group_idstring
expandstring[]

Response

OK

objectstring

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