PortaOne icon

PortaOne

Consume PortaOne API (v.1.0.24)
Join our community

Actions34

Overview

The PortaOne - Rate Management: Get All node retrieves a list of rates from the PortaOne API, supporting advanced filtering, sorting, and output customization. This node is useful for telecom operators or billing administrators who need to fetch, analyze, or export rate tables for destinations, tariffs, or customer groups.

Common scenarios:

  • Exporting all current rates for reporting or auditing.
  • Filtering rates by country, destination, or effective date.
  • Downloading rate lists in CSV or Excel format for offline analysis.
  • Integrating rate data into other n8n workflows for automation (e.g., updating CRM, sending notifications).

Practical example:
A user wants to get all rates for a specific tariff, filter them by country code "US", and download the results as an Excel file.

Properties

Name Meaning
Authentication The authentication method to use. Options: Token Authentication, Basic Authentication.
Tariff ID Numeric identifier of the tariff to filter rates.
Limit The number of rows to retrieve. Mandatory if using Offset.
Offset The number of rows to skip at the beginning of the list. Requires Limit to be specified.
Complex Ordering Allows specifying multiple fields and directions (ASC/DESC) for sorting the results.
Country The ISO 3166-1 alpha-2 country code to filter rates.
Destination Pattern of the destination prefix to filter rates.
Destination List Set of destination records, each with a Dest ID.
Discontinued Indicates that the rate is discontinued.
Effective At Filter to view rates effective at a specific date and time. Can be combined with Effective From.
Effective From Filter to view rates effective after a given date/time.
Effective From Datetime Return rates with the effective_from value later than this datetime.
Extended Info Whether to include extended information like destination group for the rates.
File Format Enables downloading rates as an attachment in "csv", "xls", or "xlsx" formats.
Forbidden Indicates that no calls are authorized for the particular destination.
Get Simple Info Whether to get simplified information for the rates (limits filtering/ordering).
Get Total Whether to return the total number of retrieved customers. Options: No, Yes.
Hidden Indicates that the rate is excessive and may be omitted when listing rates.
Destination Group ID Numeric identifier for the destination group.
Template ID Numeric identifier for the template.
ISO 3166 1 A2 The ISO 3166 two-letter country code.
Network Name of the mobile network to filter rates.
Order By Field name to sort the resulting rate list.
Order Direction Sort order: ascending or descending.
Reverse Rating Indicates whether the rate is marked as reverse.
Type Type of search: "number" or "prefix". Default is "prefix".
Simplify Whether to simplify the output data. If enabled, only the property at SimplifyPath will be returned.
SimplifyPath Path to the property that should be returned when Simplify is enabled (default: "rate_list").

Output

  • Standard Output:
    Returns a JSON object containing the full response from the PortaOne API, which typically includes a rate_list array with detailed rate objects and possibly additional metadata (such as totals, pagination info, etc.).

  • Simplified Output:
    If Simplify is enabled, only the property specified by SimplifyPath (by default, rate_list) is returned. This is usually an array of rate objects.

  • Binary Output:
    If File Format is set (e.g., "csv", "xls", "xlsx"), the node may return binary data as an attachment containing the rates in the requested format.

Dependencies

  • External Services:
    • PortaOne API access is required.
  • API Credentials:
    • Either Token Authentication (portaOneTokenApi) or Basic Authentication (portaOneBasicApi) credentials must be configured in n8n.
  • n8n Configuration:
    • Ensure the appropriate credentials are set up in the n8n credential store.

Troubleshooting

  • Authentication Errors:

    • Error: "Invalid credentials" or "401 Unauthorized"
      Resolution: Check that the correct authentication method and valid credentials are provided.

  • Missing Required Fields:

    • Error: "Limit is required when using Offset"
      Resolution: Specify the Limit property if you use Offset.

  • No Data Returned:

    • Possible causes: Filters are too restrictive, or there are no matching rates.
      Resolution: Broaden your filters or check that the data exists in PortaOne.

  • Binary Output Issues:

    • Error: "Cannot parse binary data"
      Resolution: When requesting file formats, ensure downstream nodes can handle binary data.

Links and References

Discussion