Accounting Code Rules6

Accounting Codes6

Adjustments5

Allowance Line Items14

Allowance Types2

Allowances14

Async Tasks1

Bank Accounts8

Business Entities7

Business Entity ROE Authorizations5

Business Entity Verifications1

Business Presets5

Calculations1

Companies4

Contractors7

Deduction Line Items14

Deduction Types2

Deductions14

Earning Line Items14

Earning Types2

Earnings14

Effective Tax Properties1

Employee Benefit Line Items14

Employee Benefit Types2

Employee Benefits14

Employees8

Employer Benefit Line Items14

Employer Benefit Types2

Employer Benefits14

Employer Statutory Withholding Line Items5

Employer Statutory Withholding Types2

Form Batches7

Form Types5

Forms9

Holidays2

Integrations8

Journal Entries2

Overtime Rates14

Partners1

Pay Rates14

Pay Schedules5

Pay Splits5

Pay Stubs15

Payments4

Payrolls10

Reimbursement Line Items14

Reimbursement Types2

Reimbursements14

Remittance Account Enrollments9

Remittance Accounts5

Remittance Totals1

Reports17

ROE SAT Agreements6

Statutory Withholding Line Items5

Statutory Withholding Types2

Tag Groups5

Tags5

Tax Properties8

Tax Property Templates1

Tokens2

Usage Records2

Usage Summaries2

Vacation Pay2

Vacation Pay Settings8

Webhooks5

Work Assignments13

Employer Benefit Line Items

List employer benefit line items

get/employer_benefit_line_items

Query parameters

pay_stub_idstring

Only return line items on the specified Pay Stub.

payroll_idstring

Only return line items on Pay Stubs on the specified Payroll.

string[]

'correction' | 'historical' | 'off_cycle' | 'regular'

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

Only return line items on Pay Stubs on the specified Pay Schedule.

work_assignment_idstring

Only return line items on Pay Stubs for the specified Work Assignment.

employee_idstring

Only return line items on pay stubs for the specified Employee.

contractor_idstring

Only return line items on pay stubs for the specified Contractor.

business_entity_idstring

Only return line items on Pay Stubs under the specified Business Entity.

has_business_presetboolean

business_preset_idstring

string[]

Only return line items with the specified types.

string[]

Only return line items without the specified types.

external_refstring

expandstring[]

Response

objectstring

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

Changes

Changed in 5 of the 18 revisions of this API.1020

Aug 29, 202629c2d6ac71312See the full diff
- ○
  added the optional property data/items/data/anyOf[subschema #4: With remittance_account expanded]/remittance_account/data/superseded_by to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #4: With remittance_account expanded]/remittance_account/data/superseded_on to the response with the 200 status
  response-optional-property-added
Aug 8, 202601cd9c45a9232See the full diff
- ●
  added the new included_in_stat_holiday_pay enum value to the data/items/data/allOf[subschema #1: Employer Benefit Line Item]/employer_benefit_type/data/features/items/definitions/items/effects/items/ response property for the response status 200
  response-property-enum-value-added
- ●
  added the new stat_payable enum value to the data/items/data/allOf[subschema #1: Employer Benefit Line Item]/employer_benefit_type/data/features/items/type response property for the response status 200
  response-property-enum-value-added
Aug 4, 2026544a6469dc3f88See the full diff
- ●
  removed the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/expense_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/liability_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/expense_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/liability_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/expense_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/liability_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/expense_template_code from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/liability_template_code from the response with the 200 status
  response-optional-property-removed
- ○
  added the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/expense_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/liability_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/expense_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/liability_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/expense_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/liability_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/expense_segment to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/liability_segment to the response with the 200 status
  response-optional-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 31, 20267c45252e3e569See the full diff
- ○
  added the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/expense_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #13: With tag_assignment expanded]/tag_assignment/data/tag_allocations/items/tags/items/liability_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/expense_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #14: With managed_tag_assignment expanded]/managed_tag_assignment/data/tag_allocations/items/tags/items/liability_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/expense_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #15: With custom_tag_assignment expanded]/custom_tag_assignment/data/tag_allocations/items/tags/items/liability_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/expense_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #16: With tag_assignment_amounts expanded]/tag_assignment_amounts/data/items/data/tag_allocations/items/tags/items/liability_template_code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property data/items/data/anyOf[subschema #4: With remittance_account expanded]/remittance_account/data/linked_remittance_account to the response with the 200 status
  response-optional-property-added
Jul 26, 202622e92d8c33761See the full diff
- ○
  added the optional property data/items/data/anyOf[subschema #2: With pay_stub expanded]/pay_stub/data/apply_standard_tax_reductions to the response with the 200 status
  response-optional-property-added

Full history