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 billing run data. Specifically, the 'Get All Billing Runs' operation fetches a list of billing runs with optional filtering and pagination parameters. It is useful for scenarios where users need to access billing run records for reporting, auditing, or integration with other systems. For example, a user can retrieve billing runs within a specific date range, limit the number of results, or sort the results by start date.

Use Case Examples

  1. Retrieve the latest 10 billing runs sorted by start date descending.
  2. Fetch billing runs filtered by a specific billing period or customer group ID.
  3. Paginate through billing runs using offset and limit parameters.

Properties

Name Meaning
Limit Maximum number of billing run entries to return.
Offset Starting offset for the list of billing runs, used for pagination.
From Start date/time to filter billing runs from (inclusive).
To End date/time to filter billing runs to (inclusive).
Billing Period Filter billing runs by a specific billing period date.
Customer Group Id Filter billing runs by a specific customer group ID.
Anniversary Billing Day Filter billing runs by anniversary billing day.
Sort Sort order of the results, supporting multiple comma-separated values (e.g., 'name,reference'). Possible values include 'started' and '-started' for ascending or descending start date sorting.

Output

JSON

  • data - The JSON response containing the list of billing runs and their details.

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 will be thrown.
  • Network or connectivity issues can cause request failures; ensure the base URL is correct and accessible.

Links

Discussion