List payrolls

The business_entity_id field is required when pay_schedule_id is not present.

The pay_schedule_id field is required when business_entity_id is not present.

Allows for restricting to only next payrolls, or to exclude any next payrolls. A payroll is the next payroll within a single PaySchedule, if it has a status of draft, approved, processing, or failed.

If an off_cycle payroll has been created, the next off_cycle payroll with a status of draft, approved, processing, or failed will also be returned by default.

If a year is passed, the payrolls will be restricted to only those which can be used as the source_payroll_id on an off_cycle payroll.

Filter by payroll status. Supports multiple comma-separated values, for example status=draft,approved,processing. The partially_paid status is deprecated and matches no payrolls.

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

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

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

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