Sign in

v4

OpenAPI 3.0.02026-07-314441026.8 MB
Allowance Line Items

List allowance line items

get/allowance_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
'automobile_and_motor_vehicle' | 'cell_phone_allowance' | 'child_care_expenses' | 'child_eduction_non_taxable' | 'child_eduction_taxable' | 'clothing_non_taxable' | 'clothing_taxable' | 'education_and_professional_development' | 'housing_allowance_cash' | 'internet_allowance' | 'meals_taxable' | 'moving_allowance_non_taxable' | 'moving_allowance_taxable' | 'municipal_officers_expense' | 'non_taxable_allowance' | 'overtime_meals_non_taxable' | 'parking_allowance' | 'professional_membership' | 'professional_membership_dues_taxable' | 'social_event_allowance' | 'taxable_cash_allowance' | 'tools_allowance' | 'transit_pass' | 'travelling_allowance_non_taxable' | 'travelling_allowance_taxable' | 'utilities_allowance' | 'vehicle_allowance_non_taxable'
OR
string[]
'automobile_and_motor_vehicle' | 'cell_phone_allowance' | 'child_care_expenses' | 'child_eduction_non_taxable' | 'child_eduction_taxable' | 'clothing_non_taxable' | 'clothing_taxable' | 'education_and_professional_development' | 'housing_allowance_cash' | 'internet_allowance' | 'meals_taxable' | 'moving_allowance_non_taxable' | 'moving_allowance_taxable' | 'municipal_officers_expense' | 'non_taxable_allowance' | 'overtime_meals_non_taxable' | 'parking_allowance' | 'professional_membership' | 'professional_membership_dues_taxable' | 'social_event_allowance' | 'taxable_cash_allowance' | 'tools_allowance' | 'transit_pass' | 'travelling_allowance_non_taxable' | 'travelling_allowance_taxable' | 'utilities_allowance' | 'vehicle_allowance_non_taxable'
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").