Acumatica API - Endpoint Default 24 200 001Install

Summary

Retrieve a filtered list of Lead entities from the Acumatica ERP system using multiple available field filters and a custom OData filter expression.

Inputs

• Business Account Filter — Filters the leads by matching the business account using operators like equals, contains, or starts with.
• Company Name Filter — Filters leads based on the company name with operators equals, contains, or starts with.
• Contact Method Filter — Filters leads by contact method with operators equals, contains, or starts with.
• Do Not Call Filter — Filters leads where the 'Do Not Call' attribute equals the given boolean value.
• Do Not Email Filter — Filters leads where the 'Do Not Email' attribute equals the given boolean value.
• Do Not Fax Filter — Filters leads where the 'Do Not Fax' attribute equals the given boolean value.
• Do Not Mail Filter — Filters leads where the 'Do Not Mail' attribute equals the given boolean value.
• Duplicate Filter — Filters leads by the duplicate status using operators equals, contains, or starts with.
• Duplicate Found Filter — Filters leads where the 'Duplicate Found' flag matches the specified boolean value.
• Email Filter — Filters leads by email with operators equals, contains, or starts with.
• Fax Filter — Filters leads by fax number with operators equals, contains, or starts with.
• Fax Type Filter — Filters leads by fax type with operators equals, contains, or starts with.
• First Name Filter — Filters leads by first name using operators equals, contains, or starts with.
• Job Title Filter — Filters leads by job title using operators equals, contains, or starts with.
• Language Or Locale Filter — Filters leads by language or locale using operators equals, contains, or starts with.
• Last Incoming Activity Filter — Filters leads by their last incoming activity date using operators like equals, after, on or after, before, or on or before.
• Last Name Filter — Filters leads by last name using operators equals, contains, or starts with.
• Last Outgoing Activity Filter — Filters leads by their last outgoing activity date using operators like equals, after, on or after, before, or on or before.
• Lead Class Filter — Filters leads by lead class using operators equals, contains, or starts with.
• Lead Display Name Filter — Filters leads by display name using operators equals, contains, or starts with.
• Lead ID Filter — Filters leads by lead ID using numeric comparison operators: equals, greater than, greater than or equal, less than, or less than or equal.
• No Marketing Filter — Filters leads where the 'No Marketing' flag equals the provided boolean value.
• No Mass Mail Filter — Filters leads where the 'No Mass Mail' flag equals the provided boolean value.
• Owner Filter — Filters leads by owner using string operators equals, contains, or starts with.
• Owner Employee Name Filter — Filters leads by owner employee name using operators equals, contains, or starts with.
• Parent Account Filter — Filters leads by parent account using operators equals, contains, or starts with.
• Phone1 Filter — Filters leads by their primary phone number using operators equals, contains, or starts with.
• Phone1 Type Filter — Filters leads by the type of their primary phone using operators equals, contains, or starts with.
• Phone2 Filter — Filters leads by their secondary phone number using operators equals, contains, or starts with.
• Phone2 Type Filter — Filters leads by the type of their secondary phone using operators equals, contains, or starts with.
• Phone3 Filter — Filters leads by their tertiary phone number using operators equals, contains, or starts with.
• Phone3 Type Filter — Filters leads by the type of their tertiary phone using operators equals, contains, or starts with.
• Reason Filter — Filters leads by reason using operators equals, contains, or starts with.
• Source Filter — Filters leads by source using operators equals, contains, or starts with.
• Source Campaign Filter — Filters leads by source campaign using operators equals, contains, or starts with.
• Status Filter — Filters leads by status using operators equals, contains, or starts with.
• Title Filter — Filters leads by title using operators equals, contains, or starts with.
• Web Site Filter — Filters leads by website using operators equals, contains, or starts with.
• Workgroup Filter — Filters leads by workgroup using operators equals, contains, or starts with.
• Workgroup Description Filter — Filters leads by workgroup description using operators equals, contains, or starts with.
• Last Modified Date Time Filter — Filters leads by last modified date/time using comparison operators such as equals, after, on or after, before, or on or before.
• Active Filter — Filters leads by active status where the flag equals the given boolean value.
• Description Filter — Filters leads by description using operators equals, contains, or starts with.
• Ref Contact ID Filter — Filters leads by reference contact ID using numeric comparison operators: equals, greater than, greater than or equal, less than, or less than or equal.
• Converted By Filter — Filters leads by who converted them using operators equals, contains, or starts with.
• Qualification Date Filter — Filters leads by qualification date using comparison operators such as equals, after, on or after, before, or on or before.
• Custom Filter — Specifies an advanced custom OData $filter expression applied in addition to the field-specific filters for more complex queries.

Output shape

a list of Lead records matching the specified filters

The operation returns an array of Lead entities filtered by provided criteria. It supports extensive filtering on multiple fields using OData syntax under the hood. The custom filter allows complex OData $filter strings. Pagination details are not specified in the provided information.

Examples

Example 1: Retrieve leads filtered by active status and recent modification date

Set the Active Filter to true and Last Modified Date Time Filter to a 'On or After' operator with the desired date to get all active leads modified after that date.

Links

• n8n community nodes installation guide