Opencell icon

Opencell

Consume Opencell API

Overview

The Account Hierarchy - Search operation in this n8n node allows users to search for account hierarchies within the Opencell system using a set of flexible filters. This is particularly useful for organizations that need to retrieve and analyze account structures based on various criteria, such as address, billing cycle, customer code, or other attributes.

Common scenarios:

  • Finding all accounts in a specific city or country.
  • Filtering accounts by billing cycle or customer category.
  • Searching for accounts with a particular email or registration number.

Practical example:
A finance team could use this node to pull all accounts with a certain billing cycle code for reconciliation, or a support team might filter accounts by email domain to identify customers from a specific organization.


Properties

Name Type Meaning
Authentication options Selects the authentication method for connecting to Opencell (Basic Authentication or OAuth2).
Filters fixedCollection Allows specifying one or more filters to narrow down the search. Each filter consists of:
- Filter Name or ID (options): The field to filter by (e.g., Address1, City, Customer Code, etc.).
- Value (string): The value to match for the selected filter.

Output

  • The output is a JSON object containing the results returned by the Opencell API for the account hierarchy search.
  • The structure of the json field will directly reflect the response from the /opencell/api/rest/account/accountHierarchy/filtering endpoint, which typically includes an array of matching account hierarchy records and their details.

Example output:

{
  "accounts": [
    {
      "code": "ACC123",
      "name": "Acme Corp",
      "city": "New York",
      "countryCode": "US",
      // ...other fields
    },
    // ...more accounts
  ]
}

Note: The actual fields depend on the Opencell API response.


Dependencies

  • External Service: Requires access to an Opencell instance with the REST API enabled.
  • Authentication: Needs valid credentials for either Basic Authentication or OAuth2, configured in n8n credentials.
  • n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid Credentials: If authentication fails, you may see errors like Username/password error. Error code : 401. Ensure your credentials are correct and have sufficient permissions.
  • No Results Returned: If your filters are too restrictive or incorrectly specified, the result may be empty. Double-check filter names and values.
  • API Connection Errors: Network issues or incorrect Opencell API URLs can cause connection failures. Verify the API endpoint and network accessibility.

Error messages:

  • "Invalid credentials (unknown error)": Check your authentication settings.
  • "Host error. Error code : <code>": There may be a problem reaching the Opencell server; check network/firewall settings.
  • "This resource doesn't support custom fields": Custom fields are not applicable for this operation.

Links and References

Discussion