Acumatica API - Endpoint Default 25 200 001 icon

Acumatica API - Endpoint Default 25 200 001

Interact with Acumatica Endpoint Default/25.200.001

Actions478

Employee Payroll Settings → Get List

AI-generated

Summary

Retrieve a list of Employee Payroll Settings records, optionally filtering results using multiple predefined filter fields or a custom OData $filter expression.

Inputs

  • Active Filter — Filter results by active status. Use the operator 'Equals' and a boolean value.
  • Cash Account Filter — Filter results by Cash Account. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Class ID Filter — Filter results by Class ID. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Employee ID Filter — Filter results by Employee ID. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Employee Name Filter — Filter results by Employee Name. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Employee Type Filter — Filter results by Employee Type. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Last Modified Date Time Filter — Filter results by last modified date/time. Choose an operator ('Equals', 'After', 'On or After', 'Before', 'On or Before') and specify a date-time value.
  • Payment Method Filter — Filter results by Payment Method. Choose an operator ('Equals', 'Contains', 'Starts With') and specify a string value.
  • Employee Type Class Default Filter — Filter results by Employee Type Class Default. Use the operator 'Equals' and a boolean value.
  • Custom Filter — Provide an advanced OData $filter string expression for additional filtering, e.g., "CustomerID/value eq 'CUST001'". This filter is applied in addition to any specified filter fields.

Output shape

a list of Employee Payroll Settings records matching the applied filters

The results are filtered according to any combination of the predefined filter fields and/or the custom OData $filter expression. Multiple filter criteria are combined using logical AND. Returned data corresponds to the Employee Payroll Settings resource schema.

Examples

Example 1: Retrieve all active employee payroll settings

Set 'Active Filter' to 'Equals' true, leave other filters empty.

Example 2: Retrieve employee payroll settings for a specific Employee ID containing '123'

Set 'Employee ID Filter' operator to 'Contains' and value to '123'.

Example 3: Retrieve records modified after January 1, 2024

Set 'Last Modified Date Time Filter' operator to 'After' and value to '2024-01-01T00:00:00'.

Links

Discussion