Sign in

v5

latestOpenAPI 3.0.02026-08-044441026.8 MB
Earning Line Items

List earning line items

get/earning_line_items

Query parameters

pay_stub_idstring
payroll_idstring
'approved' | 'draft' | 'failed' | 'paid' | 'partially_paid' | 'processing'
OR
string[]
'correction' | 'historical' | 'off_cycle' | 'regular'
OR
string[]
payroll_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: payroll_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: payroll_period_start[gte]=2024-01-01&payroll_period_start[lt]=2024-12-31
payroll_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: payroll_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: payroll_period_end[gte]=2024-01-01&payroll_period_end[lt]=2024-12-31
payroll_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: payroll_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: payroll_pay_date[gte]=2024-01-01&payroll_pay_date[lt]=2024-12-31
pay_schedule_idstring
work_assignment_idstring
employee_idstring
contractor_idstring
business_entity_idstring
has_business_presetboolean
business_preset_idstring
'bonus_discretionary' | 'bonus_non_discretionary' | 'bonus_non_taxable' | 'commission' | 'commission_periodic' | 'commission_self_employed' | 'death_benefit' | 'gift_cash' | 'gratuity' | 'in_lieu_wages' | 'income_replacement_indemnity_non_taxable' | 'income_replacement_indemnity_taxable' | 'invoice_payment' | 'invoice_sales_tax' | 'leave_bereavement' | 'leave_citizenship' | 'leave_domestic_and_sexual_violence' | 'leave_general' | 'leave_jury_duty' | 'leave_maternity' | 'leave_organ_donor' | 'leave_parental' | 'leave_paternity' | 'leave_personal' | 'leave_sick' | 'leave_voting' | 'leave_wedding' | 'overtime' | 'parental_top_up_insurable' | 'parental_top_up_non_insurable' | 'pension' | 'retiring_allowance' | 'retiring_allowance_eligible' | 'retroactive_pay' | 'retroactive_pay_increase' | 'salary' | 'salary_continuance' | 'severance_pay' | 'statutory_holiday_pay' | 'supplemental_unemployment' | 'time_off_in_lieu' | 'time_off_in_lieu_overtime' | 'unpaid_leave' | 'vacation_accrual_adjustment' | 'vacation_pay' | 'vacation_pay_employee_terminated' | 'vacation_pay_no_time_taken' | 'vacation_pay_time_taken' | 'wage'
OR
string[]
'bonus_discretionary' | 'bonus_non_discretionary' | 'bonus_non_taxable' | 'commission' | 'commission_periodic' | 'commission_self_employed' | 'death_benefit' | 'gift_cash' | 'gratuity' | 'in_lieu_wages' | 'income_replacement_indemnity_non_taxable' | 'income_replacement_indemnity_taxable' | 'invoice_payment' | 'invoice_sales_tax' | 'leave_bereavement' | 'leave_citizenship' | 'leave_domestic_and_sexual_violence' | 'leave_general' | 'leave_jury_duty' | 'leave_maternity' | 'leave_organ_donor' | 'leave_parental' | 'leave_paternity' | 'leave_personal' | 'leave_sick' | 'leave_voting' | 'leave_wedding' | 'overtime' | 'parental_top_up_insurable' | 'parental_top_up_non_insurable' | 'pension' | 'retiring_allowance' | 'retiring_allowance_eligible' | 'retroactive_pay' | 'retroactive_pay_increase' | 'salary' | 'salary_continuance' | 'severance_pay' | 'statutory_holiday_pay' | 'supplemental_unemployment' | 'time_off_in_lieu' | 'time_off_in_lieu_overtime' | 'unpaid_leave' | 'vacation_accrual_adjustment' | 'vacation_pay' | 'vacation_pay_employee_terminated' | 'vacation_pay_no_time_taken' | 'vacation_pay_time_taken' | 'wage'
OR
string[]
external_refstring
earned_onobject

Only return line items with an earned_on date matching the filter.

Date filters support two formats: Exact Date Match: Provide a well-formatted date in YYYY-MM-DD format for an exact match. Example: earned_on=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: earned_on[gte]=2024-01-01&earned_on[lt]=2024-12-31
expandstring[]

Response

OK

objectstring

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