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 payment 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 whose total due exceeds $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 by their index (starting at 1) using and, or, and parentheses for grouping.
- 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 of the output JSON corresponds directly to the requested fields, including any aggregated values if specified.

If binary data were supported, it would represent file contents or attachments related to the queried objects; however, this node focuses on JSON data responses only.

Dependencies

  • Requires an API key credential for authentication to the target service.
  • The base URL for the API must be configured in the node credentials.
  • Depends on the external service's API endpoint /ia/api/v1 to perform the query.
  • Uses JSON formatting extensively for input properties and request body construction.

Troubleshooting

  • Invalid JSON in fields, filters, or other JSON properties: Ensure that JSON inputs are correctly formatted. Use JSON validators if necessary.
  • Filter expression errors: The logical expression must reference filter conditions by their correct numeric indices starting at 1. Syntax errors or invalid operators will cause failures.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Pagination issues: Setting start or size outside allowed ranges may result in empty or partial results.
  • Field or object not found: Confirm that the object property and requested fields exist in the target system.
  • Exceeded size limit: The size property cannot exceed 4000 records per request.

Links and References

Discussion