AvantGuard - Sage Intacct (Common Services) icon

AvantGuard - Sage Intacct (Common Services)

AvantGuard - Sage Intacct (Common Services)

Actions6

Overview

This node interacts with the Sage Intacct API to retrieve resource models related to services. Specifically, the "Get Services Model" operation fetches metadata about service resources available in the Sage Intacct platform. This is useful for dynamically understanding the structure, types, and versions of resources you can work with in your workflows.

Common scenarios include:

  • Discovering available service resources and their schema before performing further operations.
  • Fetching detailed metadata about a specific service resource to build dynamic forms or validations.
  • Retrieving version-specific resource models to ensure compatibility with different API versions.

For example, you might use this node to get the model definition of an accounts payable vendor resource (accounts-payable/vendor) to understand its fields and data types before creating or updating such a vendor record.

Properties

Name Meaning
Additional Query Parameters Optional parameters to customize the request:
- Name: The resource name in the format <application-name>/<resource name>. Some services have 3-part names (e.g., company-config/document-sequence/get-next-sequence). For custom objects, use platform-apps/nsp::<object-name>.
- Type: The type of resource to list or get, such as object, service, workflow, or specific types like ownedObject. Can be a comma-separated list excluding object and service.
- Version: API version to target (default v1). Use version=ALL to get all versions.
- Schema: Whether to return the full model (true) or a short definition (false). Defaults to true when requesting a single resource, otherwise false.
- Tags: Whether to return the schema with wrapping objects for groups, refs, and lists (true) or without them (false). Default is false.

Output

The node outputs JSON data representing the resource model retrieved from the Sage Intacct API. This includes:

  • Metadata about the resource's fields, types, and structure.
  • Version information if requested.
  • Schema details depending on the schema parameter (full or short).
  • Tags formatting based on the tags parameter.

If binary data were involved (not indicated here), it would typically represent files or attachments, but this node focuses on JSON metadata output only.

Dependencies

  • Requires an API key credential for authenticating with the Sage Intacct API.
  • Needs the base URL of the Sage Intacct API configured in credentials.
  • Uses the @avantguardllc/n8n-openapi-node package internally to build requests based on OpenAPI specifications.

Troubleshooting

  • Invalid Resource Name: If the name parameter is incorrect or does not exist, the API may return a 404 or similar error. Verify the resource name format and existence.
  • Unsupported Version: Requesting a non-existent API version will cause errors. Use version=ALL to list available versions first.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Malformed Query Parameters: Incorrect types or values in additional query parameters may lead to bad requests. Double-check parameter formats.
  • Empty or Unexpected Response: If the response lacks expected fields, verify that the schema and tags parameters are set appropriately.

Links and References

Discussion