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 CLI (Command Line Interface) entries. Specifically, the 'Get All Clis' operation fetches a list of CLI entries with support for filtering, pagination, and sorting. It is useful for scenarios where users need to query and manage CLI data, such as filtering by customer ID, cost centre ID, or CLI type, and controlling the number of results returned.

Use Case Examples

  1. Retrieve all CLI entries for a specific customer with a limit of 20 results.
  2. Fetch CLI entries excluding billing CDR and billing service files, sorted by identity.
  3. Search CLI entries by an identifier string and paginate results with offset and limit.

Properties

Name Meaning
Limit Maximum number of CLI entries to return.
Offset Starting offset for the list of CLI entries, used for pagination.
Customer Id Filter CLI entries by a specific customer ID.
Cost Centre Id Filter CLI entries by a specific cost centre ID.
Cli Type Id Filter CLI entries by a specific CLI type ID.
Exclude Billing Cdr Filter to exclude CLI entries associated with billing CDR.
Exclude Billing Service File Filter to exclude CLI entries associated with billing service files.
Search Search CLI entries by an identifier string.
Sort Sort order of the CLI results, supporting multiple comma-separated values such as 'identity' or '-identity'.

Output

JSON

  • json - The JSON response from the Billing Booth One API containing the list of CLI entries and their details.

Dependencies

  • Billing Booth One API with an API key credential for 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 indicating the missing binary property.

Links

Discussion