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 commission plans. It supports filtering, sorting, and pagination of commission plans, making it useful for scenarios where users need to manage or analyze commission structures in their billing system. For example, a user can fetch a limited number of commission plans filtered by type or search term, sorted by name.

Use Case Examples

  1. Retrieve the first 10 commission plans of type 'salePrice' sorted by name.
  2. Fetch commission plans starting from an offset of 20, filtering by 'profit' type, and searching by a specific name substring.

Properties

Name Meaning
Limit Maximum number of commission plan entries to return.
Offset Starting offset for the commission plans to return, useful for pagination.
Type Filter commission plans by type, either 'salePrice' or 'profit'.
Search Search commission plans by name.
Sort Sort order of the results, supporting multiple comma-separated values such as 'name' or '-name'.

Output

JSON

  • json - The JSON output contains the retrieved commission plans data from the API response.

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.
  • If the binary property name is specified but the binary data is missing, an error is thrown indicating the missing binary property.

Discussion