PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)

Actions34

Overview

The PortaOne node for n8n, when configured with the Customer resource and the Get All operation, retrieves a list of customers from the PortaOne API. This node is useful for automating customer data synchronization, reporting, or integration tasks where you need to fetch customer records—optionally filtered and enriched with additional details.

Common scenarios:

  • Importing all customer records into another system (e.g., CRM, ERP).
  • Generating reports on customer status, billing, or usage.
  • Filtering customers by various criteria such as location, status, or custom fields.
  • Fetching detailed information about each customer for further processing in your workflow.

Practical example:
You could use this node to retrieve all active customers who have exceeded their credit limit, then send them notification emails or generate a report.

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 customer search. Includes:
- Bcc
- Bill Status (open, suspended, closed, exported, deactivated, inactive)
- Callshop Enabled (Yes/No)
- Check Usage (Yes/No)
- City
- Companyname
- Cont1
- Cont2
- Country
- Credit Limit Exceeded (Yes/No)
- Custom Fields Values (DB Value, I Custom Field, I Custom Field Value, Name)
- Detailed Info (Yes/No)
- Email
- Fax Number
- Firstname
- Get Auth Info (Yes/No)
- Get Notepad (Yes/No)
- Get Statuses (Yes/No)
- Get Total (Yes/No)
- Has Invoices (Yes/No)
- Customer Class ID
- Customer Type ID (Retail customer or subcustomer, Reseller, Distributor)
- Distributor ID
- Main Customer ID
- Office Type ID (none, branch_office, main_office)
- Parent ID
- Representative ID
- Invoicing Enabled (Yes/No)
- ISO 4217
- Lastname
- Limit
- Login
- Marked For Porting (Yes/No)
- Midinit
- Name
- Note
- Offset
- Phone1
- Phone2
- Salutation
- Search (Search By, Value)
- Skip Exported (Yes/No)
- Spending Limit Reached (Yes/No)
- State
- Tax Id
- With BP Charge CC (Yes/No)
- With Commission Plan (Yes/No)
- With Credit Limit Warnings (Yes/No)
- With Subresellers (Yes/No)
- With Terminated (Yes/No)
- Zip
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: customer_list.

Output

  • Standard Output:
    Returns a JSON object containing the list of customers and any additional metadata provided by the PortaOne API. The structure typically includes a top-level property (by default, customer_list) which is an array of customer objects, along with other possible metadata fields depending on the API response and selected options.

  • When "Simplify" is enabled:
    Only the property specified by "SimplifyPath" (default: customer_list) is returned, making it easier to work directly with the array of customers in downstream nodes.

  • Binary Data:
    This node does not output binary data.

Dependencies

  • External Services: Requires access to a PortaOne API instance.
  • Authentication:
    • Token Authentication: Needs valid PortaOne API token credentials.
    • Basic Authentication: Needs valid username and password credentials.
  • n8n Credentials:
    • portaOneTokenApi (for Token Authentication)
    • portaOneBasicApi (for Basic Authentication)

Troubleshooting

Common Issues:

  • Invalid Credentials:
    Error messages related to authentication failures indicate incorrect or missing API credentials. Ensure the correct credential type is selected and properly configured in n8n.

  • Missing Required Parameters:
    If using pagination (offset), ensure limit is also set, as required by the API.

  • API Errors:
    Any errors returned by the PortaOne API (such as invalid filter values or server issues) will be passed through. Review the error message for details and adjust input properties accordingly.

  • Empty Results:
    If no customers are returned, check your filter settings in "AdditionalFields" to ensure they are not too restrictive.

Links and References

Discussion