Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Employee Payroll Settings → Get List

AI-generated

Summary

Retrieve a filtered list of Employee Payroll Settings records from Acumatica using optional OData-based filters to narrow results.

Inputs

  • Active Filter — Filter records by whether they are active; supports 'Equals' operator with a boolean value.
  • Cash Account Filter — Filter records by the Cash Account field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Class ID Filter — Filter records by the Class ID field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Employee ID Filter — Filter records by the Employee ID field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Employee Name Filter — Filter records by the Employee Name field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Employee Type Filter — Filter records by the Employee Type field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Last Modified Date Time Filter — Filter records by the last modified date and time; supports comparison operators including Equals, After, On or After, Before, and On or Before with a DateTime value.
  • Payment Method Filter — Filter records by the Payment Method field; supports 'Equals', 'Contains', and 'Starts With' operators on string values.
  • Employee Type Class Default Filter — Filter records by the Employee Type Class Default flag; supports 'Equals' operator with a boolean value.
  • Custom Filter — Apply an advanced custom OData $filter expression as a string to further refine the query beyond the provided filter fields.

Output shape

a list of Employee Payroll Settings records matching the specified filters

The operation applies all specified filters combined to query the Acumatica API using OData syntax. Results are paginated according to Acumatica server defaults. The returned records include employee payroll setting details as structured in Acumatica API's response schema.

Examples

Example 1: Filter to active employees with Employee ID starting with 'EMP'

Set 'Active Filter' to 'Equals' true, and 'Employee ID Filter' operator to 'Starts With' with value 'EMP' to retrieve active employee payroll settings for matching employee IDs.

Links

Discussion