Acumatica API - Endpoint Default 24 200 001 icon

Acumatica API - Endpoint Default 24 200 001

Interact with Acumatica Endpoint Default/24.200.001

Actions478

Business Account → Get List

AI-generated

Summary

Retrieves a paginated list of Acumatica Business Account records filtered by configurable criteria.

Inputs

  • AccountRefFilter — Filter results by Account Ref using an operator (Equals, Contains, Starts With).
  • BusinessAccountIDFilter — Filter results by Business Account ID using an operator (Equals, Contains, Starts With).
  • ClassIDFilter — Filter results by Class ID using an operator (Equals, Contains, Starts With).
  • DuplicateFilter — Filter results by Duplicate using an operator (Equals, Contains, Starts With).
  • LastIncomingActivityFilter — Filter results by Last Incoming Activity using a date/time operator (Equals, After, On or After, Before, On or Before).
  • LastModifiedDateTimeFilter — Filter results by Last Modified Date Time using a date/time operator (Equals, After, On or After, Before, On or Before).
  • LastOutgoingActivityFilter — Filter results by Last Outgoing Activity using a date/time operator (Equals, After, On or After, Before, On or Before).
  • MainAddressValidatedFilter — Filter results by Main Address Validated (boolean).
  • NameFilter — Filter results by Name using an operator (Equals, Contains, Starts With).
  • OwnerFilter — Filter results by Owner using an operator (Equals, Contains, Starts With).
  • OwnerEmployeeNameFilter — Filter results by Owner Employee Name using an operator (Equals, Contains, Starts With).
  • ParentAccountFilter — Filter results by Parent Account using an operator (Equals, Contains, Starts With).
  • ShippingAddressOverrideFilter — Filter results by Shipping Address Override (boolean).
  • ShippingAddressValidatedFilter — Filter results by Shipping Address Validated (boolean).
  • SourceCampaignFilter — Filter results by Source Campaign using an operator (Equals, Contains, Starts With).
  • StatusFilter — Filter results by Status using an operator (Equals, Contains, Starts With).
  • TypeFilter — Filter results by Type using an operator (Equals, Contains, Starts With).
  • WorkgroupFilter — Filter results by Workgroup using an operator (Equals, Contains, Starts With).
  • WorkgroupDescriptionFilter — Filter results by Workgroup Description using an operator (Equals, Contains, Starts With).
  • CurrencyIDFilter — Filter results by Currency ID using an operator (Equals, Contains, Starts With).
  • EnableCurrencyOverrideFilter — Filter results by Enable Currency Override (boolean).
  • customFilter — Advanced OData $filter expression (e.g., CustomerID/value eq 'CUST001') applied in addition to the standard filters.

Output shape

a list of items, each containing a Business Account object (excluding framework fields like id, rowNumber, note, custom, error, files, _links).

The list is generated dynamically from the Acumatica API schema. The actual field set depends on the specific Acumatica version (e.g., 24.200.001) and configured API endpoints.

Examples

Example 1: Find active business accounts owned by a specific employee.

Set OwnerEmployeeNameFilter.value to the employee name and StatusFilter.value to the active status.

Example 2: Retrieve business accounts modified after a specific date.

Set LastModifiedDateTimeFilter.operator to 'On or After' and LastModifiedDateTimeFilter.value to the target date/time.

Example 3: Filter by multiple criteria including an advanced expression.

Configure standard filters (e.g., TypeFilter) and add a customFilter string for complex logic.

Links

Discussion