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 ledger entries for a specified customer. It is useful for scenarios where users need to fetch detailed financial transaction records, such as debits and credits, associated with a customer. Practical examples include generating financial reports, auditing transactions, or integrating ledger data into other systems for analysis.

Use Case Examples

  1. Retrieve all ledger entries for a customer with a limit of 10 entries.
  2. Filter ledger entries by transaction type (debit or credit) and sort them by entry date.
  3. Paginate through ledger entries using offset and limit parameters.

Properties

Name Meaning
Customer Id Unique identifier of the customer whose ledger entries are to be retrieved.
Limit Maximum number of ledger entries to return in the response.
Offset Starting offset for pagination to skip a number of entries before returning results.
Invoice Id Filter ledger entries by a specific invoice ID.
Transaction Type Filter ledger entries by transaction type, either debit or credit.
Sort Sort order of the results, supporting multiple comma-separated values such as entry_date or -entry_date for descending order.

Output

JSON

  • data - The JSON response containing the ledger entries 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 missing required parameters like Customer Id may cause the API to return errors or empty results.
  • Network or API endpoint issues can cause request failures; ensure the base URL is correctly configured.
  • If the binary property name is specified but the binary data is missing, an error will be thrown.

Links

Discussion