Acumatica API - Endpoint Default 23 200 001 icon

Acumatica API - Endpoint Default 23 200 001

Interact with Acumatica Endpoint Default/23.200.001

Actions478

Customer Class → Get List

AI-generated

Summary

Get List operation for the Customer Class resource retrieves a collection of Customer Class records from Acumatica, applying any combination of the numerous filter fields (each providing an operator and a value) and an optional custom OData $filter expression.

Inputs

  • Filter Fields — Each filter field (e.g., ClassIDFilter, DescriptionFilter, CountryFilter, CreditLimitFilter, etc.) appears as an optional fixedCollection containing an operator (options vary by field: eq, contains, startswith, gt, ge, lt, le, etc.) and a value whose type matches the underlying field (string, number, boolean, dateTime). All filter fields are optional and are combined with AND logic.
  • customFilter — Advanced OData $filter string (e.g., 'ClassID/value eq ABC' or 'CreditLimit/value gt 1000') that is AND‑combined with the fixed‑collection filters.

Output shape

array

Each element is a Customer Class object returned by the Acumatica API.

Examples

Example 1: Retrieve all customer classes with a specific Class ID.

Set ClassIDFilter.operator = 'eq' and ClassIDFilter.value = 'MYCLASS'. Leave all other filters blank.

Example 2: Find customer classes whose description contains 'VIP' and have a credit limit greater than 5000.

Set DescriptionFilter.operator = 'contains', DescriptionFilter.value = 'VIP'; set CreditLimitFilter.operator = 'gt', CreditLimitFilter.value = 5000.

Links

Discussion