AvantGuard - Sage Intacct (Common Services) icon

AvantGuard - Sage Intacct (Common Services)

AvantGuard - Sage Intacct (Common Services)

Actions6

Overview

This node performs a query operation against a service API to retrieve data objects based on specified criteria. It is designed to post a query request with detailed filtering, sorting, and pagination options, allowing users to extract precisely the data they need from complex datasets.

Common scenarios where this node is beneficial include:

  • Retrieving vendor or account payable information filtered by status, amount due, or name.
  • Aggregating data fields such as credit limits or dates using functions like min, max, sum, etc.
  • Sorting results by multiple fields in ascending or descending order.
  • Paginating large result sets to process data in manageable chunks.

For example, a user might query active vendors with a total due greater than 1000, requesting specific fields like vendor ID and credit limit, sorted by total due ascending and last payment date descending.

Properties

Name Meaning
Additional Body Fields A collection of optional fields to customize the query request body:
- Object: The object type to query, formatted as <application-name>/<object name>. For custom objects, use platform-apps/nsp::<object-name>.
- Fields: JSON array specifying which fields to include in the response. Supports direct fields, related object fields (e.g., vendor.id), and aggregate functions (count, avg, sum, min, max).
- Filters: JSON array of filter conditions using operators like $eq, $gt, $contains to select matching objects.
- Filter Expression: Logical expression combining filters using and, or, and parentheses to define how multiple filters apply.
- Filter Parameters: JSON object with predefined filter options such as asOfDate, includeHierarchyFields, caseSensitiveComparison, and includePrivate.
- Order By: JSON array defining sorting order by field names and direction (asc or desc).
- Start: Number indicating the first record in the result set to include (pagination start).
- Size: Number of records to return, up to a maximum of 4000.

Output

The node outputs JSON data representing the queried objects according to the specified fields and filters. The structure typically includes an array of objects, each containing the requested fields and any aggregated values.

If binary data were supported, it would be summarized here; however, this node focuses on JSON responses only.

Dependencies

  • Requires an API key credential for authentication to the target service.
  • The base URL for the API is configured via credentials.
  • Uses a bundled OpenAPI specification to build request properties dynamically.
  • Depends on the external package @avantguardllc/n8n-openapi-node for request building and execution.

Troubleshooting

  • Invalid Filter Syntax: Errors may occur if the filter JSON or filter expression syntax is incorrect. Validate JSON formatting and logical expressions carefully.
  • Field Not Found: Requesting fields that do not exist in the specified object will cause errors. Verify field names against the API documentation.
  • Pagination Limits: Requesting more than 4000 records in size may be rejected. Adjust the size parameter accordingly.
  • Authentication Failures: Ensure the API key credential is correctly configured and has necessary permissions.
  • Malformed JSON Inputs: Since several properties expect JSON strings, improper formatting can cause parsing errors. Use valid JSON syntax.

Links and References

Discussion