Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API
Join our community

Actions476

Overview

This node interacts with the Billing Booth One API to retrieve all customer groups based on specified filters and options. It is useful for scenarios where users need to fetch and manage customer group data, such as in billing or customer management workflows. For example, it can be used to list customer groups with pagination, search by name, or filter by billing type and method.

Use Case Examples

  1. Retrieve a list of customer groups with a limit of 10 entries starting from offset 0.
  2. Search customer groups by name and filter by billing type 'manual'.
  3. Sort customer groups by name or reference.

Properties

Name Meaning
Limit Maximum number of customer group entries to return.
Offset Starting offset for the list of customer groups to return.
Search Search term to filter customer groups by name.
Billing Type Filter customer groups by billing type, either 'manual' or 'automatic'.
Method Filter customer groups by method, either 'standard' or 'anniversary'.
Sort Sort order of the results, supporting multiple comma-separated values such as 'name' or '-name'.

Output

JSON

  • data - The JSON response containing the list of customer groups 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 API are propagated and can be seen in the node's output; ensure parameters are valid and the API endpoint is reachable.

Links

Discussion