PortaOneInstall

Overview

The PortaOne node for n8n enables users to interact with the PortaOne API, specifically to retrieve a list of accounts using the "Account" resource and the "Get All" operation. This node is useful for automating tasks such as synchronizing account data, generating reports, or integrating PortaOne account information into other systems or workflows.

Common scenarios:

• Fetching all customer accounts for reporting or analytics.
• Filtering accounts based on various criteria (e.g., status, location, custom fields).
• Integrating PortaOne account data with CRM, billing, or support platforms.

Practical example:
A telecom company could use this node to automatically pull all active customer accounts nightly, filter by "Bill Status," and update their internal dashboard or trigger follow-up actions in other systems.

---

Properties

Name	Meaning
Authentication	The authentication method to use. Options: Token Authentication, Basic Authentication.
AdditionalFields	A collection of optional filters and parameters to refine the account search. Includes fields like Account ID, Master Account ID, Bill Status (open, suspended, closed, exported, deactivated, inactive), Company Name, Email, etc.
Simplify	Whether to simplify the output data. If enabled, only the property specified by "SimplifyPath" will be returned.
SimplifyPath	Path to the property that should be returned when "Simplify" is enabled (default: account_list).

Notable options within AdditionalFields:

• Bill Status: open, suspended, closed, exported, deactivated, inactive
• Billing Model: Open, Suspended
• Expand Alias, Free Of Extensions, Get Not Closed Accounts, Get Only Real Accounts, Get Statuses, Get Total, Has Extension, SIP Status, With Addon Products, With Call Processing Mode, With Sim Card Info: Yes/No options
• Custom Fields Values, Account Role List, Control Number List: Allow specifying multiple values or nested collections for advanced filtering.

---

Output

• By default, the output is a JSON object containing the full response from the PortaOne API, which typically includes an array of account objects under a property such as account_list.
• If Simplify is enabled, only the property specified by SimplifyPath (default: account_list) is returned, usually an array of account records.

Example output (simplified):

[
  {
    "i_account": 12345,
    "companyname": "Acme Corp",
    "email": "contact@acme.com",
    "bill_status": "O",
    ...
  },
  ...
]

• The structure of each account object may include fields such as account ID, company name, contact details, status, and any additional fields requested.

Binary Data:
This node does not output binary data; all outputs are in JSON format.

---

Dependencies

• External Services: Requires access to a PortaOne API instance.
• API Credentials:
  • For Token Authentication: PortaOne API token credentials (portaOneTokenApi)
  • For Basic Authentication: PortaOne username/password credentials (portaOneBasicApi)
• n8n Configuration: Credentials must be set up in n8n's credential store.

---

Troubleshooting

Common issues:

• Invalid credentials: Ensure the correct authentication method and valid credentials are provided.
• Missing required fields: Some filters (like offset and limit) may require both properties to be set for pagination.
• API errors: Errors from the PortaOne API (e.g., invalid filter values) will be passed through and shown as node errors.

Common error messages:

• "Authentication failed": Check your credentials and authentication method.
• "Missing required parameter: limit": When using offset, ensure limit is also specified.
• "Invalid value for field X": Double-check the value and type for the specified field.

How to resolve:

• Verify credentials and authentication method.
• Review the documentation for required and optional fields.
• Use the node's "Execute Node" feature in n8n to test different configurations and review error messages.

---

Links and References

• PortaOne Official Documentation
• n8n Documentation: Creating Workflows
• ISO 3166-1 alpha-2 country codes

---