Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Deduction Benefit Code → Get List

AI-generated

Summary

Retrieves a list of Deduction Benefit Code records from the Acumatica API, filtered by any combination of the 14 available fields (ACA Applicable, Active, Affects Tax Calculation, Associated With, Contribution Type, Deduction Benefit Code ID, Description, Invoice Descr Source, Is Garnishment, Last Modified Date Time, Payable Benefit, Show Applicable Wage Tab, Vendor, Vendor Invoice Description) using operator-value pairs or a custom OData $filter string.

Inputs

  • ACAApplicableFilter — Filter by ACA Applicable (boolean) using Equals operator
  • ActiveFilter — Filter by Active (boolean) using Equals operator
  • AffectsTaxCalculationFilter — Filter by Affects Tax Calculation (boolean) using Equals operator
  • AssociatedWithFilter — Filter by Associated With (string) using Equals, Contains, or Starts With operator
  • ContributionTypeFilter — Filter by Contribution Type (string) using Equals, Contains, or Starts With operator
  • DeductionBenefitCodeIDFilter — Filter by Deduction Benefit Code ID (string) using Equals, Contains, or Starts With operator
  • DescriptionFilter — Filter by Description (string) using Equals, Contains, or Starts With operator
  • InvoiceDescrSourceFilter — Filter by Invoice Descr Source (string) using Equals, Contains, or Starts With operator
  • IsGarnishmentFilter — Filter by Is Garnishment (boolean) using Equals operator
  • LastModifiedDateTimeFilter — Filter by Last Modified Date Time (dateTime) using Equals, After, On or After, Before, or On or Before operator
  • PayableBenefitFilter — Filter by Payable Benefit (boolean) using Equals operator
  • ShowApplicableWageTabFilter — Filter by Show Applicable Wage Tab (boolean) using Equals operator
  • VendorFilter — Filter by Vendor (string) using Equals, Contains, or Starts With operator
  • VendorInvoiceDescriptionFilter — Filter by Vendor Invoice Description (string) using Equals, Contains, or Starts With operator
  • customFilter — Advanced OData $filter expression (e.g., 'Description/value eq 'Pension'') applied in addition to any field filters

Output shape

Array of Deduction Benefit Code objects, each representing a record from the Acumatica Deduction Benefit Code endpoint

The response contains the filtered list of records as returned by the Acumatica API

Examples

Example 1: Retrieve all active deduction benefit codes

Set ActiveFilter: { activeFilter: { operator: 'eq', value: true } }

Example 2: Find deduction benefit codes related to health insurance

Set DescriptionFilter: { descriptionFilter: { operator: 'contains', value: 'Health' } }

Example 3: Get codes modified after a specific date

Set LastModifiedDateTimeFilter: { lastModifiedDateTimeFilter: { operator: 'gt', value: '2024-01-01T00:00:00' } }

Links

Discussion