Restricts results by customer status. Accepts either the numeric status ID or a status word.

• 0-All non-archived statuses (Default)
• 1-Active
• 2-Inactive
• active-Active
• inactive-Inactive

Valid status values can also be retrieved from the List customer statuses endpoint.

The $filter parameter can be used to construct a filter statement that will be used to search for specific customer records. The expression must be URL-encoded and may not exceed 255 characters. For more information on filtering, see Filtering with CereTax APIs.

Comparison operators: eq, ne, gt, ge, lt, le.

Logical operators: and, or, not.

String functions: contains, startswith, endswith, length, indexof, tolower, toupper, trim, concat.

Date and numeric functions: year, month, day, hour, minute, second, date, time, now, round, floor, ceiling.

Filterable fields: customerId, customerName, customerAccount, taxpayerId, systemOriginId, statusId, createdAt, and modifiedAt.

Child collection fields (addresses, contacts, DBAs, and alternate IDs) are not filterable, and an unrecognized field name returns a 422. The expression is lowercased before it is applied, so literal values are matched case-insensitively.

A comma separated list of fields used to sort the result set. Prefix a field with a hyphen ( - ) to sort that field in descending order. The default sort is customerName ascending.

Sortable fields: customerId, customerName, customerAccount, taxpayerId, systemOriginId, statusId, createdAt, createdBy, modifiedAt, modifiedBy, activeCertificatesCount, attnName, addressType, addressLine1, addressLine2, city, region, postalCode, country, contactName, phoneNumber, faxNumber, emailAddress, dbaName, idType, idValue, idExpirationDate, and stateOfIssue.

Sorting on a child collection field orders results by the first related record. An unrecognized field name returns a 422.