Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Tariffs → Get All Tariffs

AI-generated

Overview

This node interacts with the Billing Booth One API to retrieve tariff data. Specifically, the 'Get All Tariffs' operation fetches a list of tariffs with optional filtering, sorting, and pagination. It is useful for scenarios where users need to access tariff information programmatically, such as integrating tariff data into billing systems, dashboards, or reports.

Use Case Examples

  1. Retrieve a limited number of tariffs with a maximum of 10 entries.
  2. Fetch tariffs starting from a specific offset to paginate through results.
  3. Filter tariffs by a specific category ID to narrow down the list.
  4. Search tariffs by name to find specific entries quickly.

Properties

Name Meaning
Limit Maximum number of tariff entries to return in the response.
Offset Starting offset for the list of tariffs, used for pagination.
Category Id Filter tariffs by the category ID to retrieve tariffs belonging to a specific category.
Search Search tariffs by name to filter results based on a search string.
Sort Sort order of the tariff results. Multiple values can be provided separated by commas, e.g., 'name,-name' to sort ascending or descending by name.

Output

JSON

  • data - The main data object containing the list of tariffs returned by the API.

Dependencies

  • Requires an API key credential for Billing Booth One API authentication.

Troubleshooting

  • Common issues include missing or invalid API credentials, resulting in authentication errors.
  • Incorrect or unsupported query parameters may cause the API to return errors or empty results.
  • Network connectivity issues can prevent successful API requests.
  • If the binary property name is specified but the binary data is missing, an error will be thrown.

Links

Discussion