Actions34
- Customer Actions
- Customer Xdrs Actions
- Customer Extensions Actions
- Account Actions
- Invoice Actions
- DID Numbers Actions
- Billing sessions Actions
- Rate Management Actions
Overview
This n8n node allows you to interact with the PortaOne API, specifically to retrieve account information using the "Account" resource and the "Get" operation. It supports both Token and Basic authentication methods. The node is useful for automating tasks such as fetching detailed account data, retrieving associated batch or subscriber information, and customizing the response with additional fields. Typical use cases include synchronizing account data between PortaOne and other systems, generating reports, or triggering workflows based on account details.
Practical examples:
- Fetching a customer's account details to display in a dashboard.
- Retrieving extended account information (such as included services or service features) for auditing or integration purposes.
- Automating customer support processes by pulling up account info based on login or ID.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| AdditionalFields | A collection of optional parameters to refine the query: - Aux Field Names: The names of additional fields to fetch - Batch Name: The name of the batch to which the account belongs - Control Number: Numeric control number - Detailed Info: Specifies whether detailed information will be returned (Yes/No) - Expand Alias: Whether to expand alias information (Yes/No) - Get Included Services: Whether to include services assigned to the account (Yes/No) - Get Service Features: List of service features to fetch configuration for - Account ID: Unique ID of the account record - Batch ID: ID of the batch - Subscriber ID: ID of the subscriber - ID: Subject's ID - Limit Alias DID Number List: Include list of DID numbers assigned as aliases - Login: Account login - With Call Processing Mode: Whether to fetch call processing mode (Yes/No) - With Customer Info: Whether to include customer info (Yes/No) - With Reseller Info: Whether to include reseller info (Yes/No) - Without Service Features: Exclude service features from response (Yes/No) |
| 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_info). |
Output
- By default, the node outputs a JSON object containing the account information retrieved from the PortaOne API.
- If "Simplify" is enabled, only the property specified by "SimplifyPath" (e.g.,
account_info) will be included in the output. - The structure of the output depends on the selected additional fields and options, but typically includes account details such as IDs, login, batch information, and any requested extended properties.
Example output (simplified):
{
"account_info": {
"i_account": 12345,
"login": "user@example.com",
"batch_name": "BatchA",
"detailed_info": true,
// ...other fields depending on AdditionalFields
}
}
- The node does not output binary data.
Dependencies
- External Services: Requires access to a PortaOne API endpoint.
- Authentication: Needs valid credentials for either Token Authentication or Basic Authentication.
- n8n Credentials:
portaOneTokenApi(for token-based auth)portaOneBasicApi(for basic auth)
- No special environment variables are required beyond standard n8n credential setup.
Troubleshooting
Common issues:
- Invalid credentials: If authentication fails, ensure the correct credentials are set up in n8n and match the selected authentication method.
- Missing required fields: Some queries may require specific identifiers (e.g., Account ID, Login). Ensure these are provided in AdditionalFields.
- API errors: Errors from the PortaOne API (such as "Not Found" or "Unauthorized") will be passed through. Check the API documentation for error meanings.
- Incorrect SimplifyPath: If "Simplify" is enabled and the path is incorrect, the output may be empty or throw an error. Double-check the property path.
Error messages:
"Invalid credentials": Check your authentication settings and credentials."Resource not found": Verify the provided Account ID, Login, or other identifiers."Missing required parameter": Ensure all necessary fields are filled in AdditionalFields.
