avanta icon

avanta

Consume avanta API

Actions8

Overview

This node integrates with the Avanta API to create or update company records. It is designed to manage company data within a customer management or ERP system context, allowing users to add new companies or modify existing ones programmatically.

Common scenarios include:

  • Automating the onboarding of new customers by creating their company profiles.
  • Updating company details such as status, contact information, or group affiliations in bulk or individually.
  • Synchronizing company data from other systems into Avanta.

Practical example:

  • When a new customer signs up on an e-commerce platform, this node can automatically create a corresponding company record in Avanta with all relevant details like name, customer ID, and sales organization.
  • Periodic updates to company statuses or additional attributes can be pushed using this node to keep the system data current.

Properties

Name Meaning
Return to Webhook Boolean flag indicating if a 'Respond to Webhook' node should return the response after execution.
Use Bulk API Boolean flag to enable or disable usage of the bulk API for creating companies (only for create operation).
Customer ID The unique identifier of the customer associated with the company (required for creation).
Name The official name of the company (required for creation).
Status Boolean indicating whether the company is active or inactive (required for creation).
External Company Customer Group ID Identifier linking the company to an external customer group (required for creation).
External SalesOrg ID Identifier linking the company to an external sales organization (required for creation).
Additional Fields A collection of optional fields to provide extra company details:
- Alias Alternative name or short name for the company.
- Duns D-U-N-S number identifying the company globally.
- Email Contact email address for the company.
- Store Group ID Identifier for the store group; selectable from a list or via expression.
- Interim Account Numeric value representing interim account status or code.
- Internet URL or internet-related information for the company.
- Logo URL or reference to the company's logo image.
- Telephone Contact telephone number.
- Vat ID VAT identification number for tax purposes.
- Extension Attributes Multiple custom extension attributes, each with a code and a value, allowing flexible metadata addition.

Output

The node outputs JSON data representing the result of the create or update operation on the company resource. This typically includes confirmation of the created or updated company record, its identifiers, and any returned metadata from the Avanta API.

If binary data were involved (e.g., files or images), it would be summarized here, but based on the provided code and properties, the output is purely JSON structured data related to company entities.

Dependencies

  • Requires connection to the Avanta API service.
  • Needs an API authentication token or key configured in n8n credentials to authorize requests.
  • For some properties like "Store Group ID" and "Extension Attributes," dynamic loading methods are used, implying dependency on Avanta API endpoints that provide these options.

Troubleshooting

  • Missing Required Fields: Errors may occur if mandatory fields like Customer ID, Name, Status, External Company Customer Group ID, or External SalesOrg ID are not provided. Ensure all required inputs are filled.
  • API Authentication Failures: If the API key or token is invalid or missing, the node will fail to connect. Verify credential configuration.
  • Bulk API Usage Issues: When "Use Bulk API" is enabled, ensure the Avanta API supports bulk operations and that payloads conform to expected formats.
  • Invalid Option Values: Selecting or specifying invalid IDs for Store Group or Extension Attributes may cause errors. Use the provided load options or valid expressions.
  • Webhook Response Requirement: If "Return to Webhook" is set to true, a subsequent 'Respond to Webhook' node must be present to handle the response properly.

Links and References

Discussion