Skip to main content
GET
List earning line items

Authorizations

Authorization
string
header
required

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

Query Parameters

pay_stub_id
string
payroll_id
string
payroll_status
Available options:
approved,
draft,
failed,
paid,
partially_paid,
processing
payroll_type
Available options:
correction,
historical,
off_cycle,
regular
payroll_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: 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_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: 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_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: 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_id
string
work_assignment_id
string
employee_id
string
contractor_id
string
business_entity_id
string
has_business_preset
boolean
business_preset_id
string
include_types
Available options:
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
exclude_types
Available options:
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
external_ref
string
earned_on
object

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
expand
enum<string>[]
Available options:
business_preset,
custom_expense_accounting_code,
custom_liability_accounting_code,
custom_tag_assignment,
expense_accounting_code,
liability_accounting_code,
managed_expense_accounting_code,
managed_liability_accounting_code,
managed_tag_assignment,
overtime_rate,
pay_rate,
pay_stub,
recurrence,
source_adjustment,
tag_assignment,
tag_assignment_amounts

Response

200 - application/json

OK

object
string
read-only

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

data
object[]