Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Overview

This node interacts with the Billing Booth One API to retrieve data related to various resources, including categories. Specifically, for the 'Get All Categories' operation, it fetches a list of categories with support for filtering, sorting, and pagination. This is useful for workflows that need to integrate category data from Billing Booth One, such as syncing categories with other systems, generating reports, or automating category-based processes.

Use Case Examples

  1. Retrieve all categories with a limit of 10 entries to display in a dashboard.
  2. Search categories by name and sort them by priority for processing.
  3. Paginate through categories using offset and limit parameters to sync with an external database.

Properties

Name Meaning
Limit Maximum number of category entries to return in the response.
Offset Starting offset for the list of categories, used for pagination.
Search Search term to filter categories by name.
Sort Sort order of the results, supporting multiple fields separated by commas (e.g., name, -priority).

Output

JSON

  • data - The JSON response containing the list of categories retrieved from 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.
  • Error messages from the node typically include the API error message or a generic 'Unknown error occurred' message; ensure credentials and parameters are correct to resolve.

Links

Discussion