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 all invoices based on specified filters and options. It is useful for scenarios where users need to fetch invoice data for reporting, auditing, or integration with other systems. For example, a user can retrieve all outstanding invoices for a specific customer or within a certain date range.

Use Case Examples

  1. Retrieve all outstanding invoices for a customer with ID 123.
  2. Fetch invoices issued between two dates for a specific organization.

Properties

Name Meaning
Limit Maximum number of invoice entries to return.
Offset Starting offset for the list of invoices to support pagination.
Customer Id Filter invoices by a specific customer ID.
Customer Group Id Filter invoices by a specific customer group ID.
Organisation Id Filter invoices by a specific organisation ID.
From Filter invoices from this date (start date).
To Filter invoices up to this date (end date).
Invoice Reference Filter invoices by invoice reference string.
Billing Period Filter invoices by billing period.
Status Filter invoices by their status.
Sort Sort order of the results, supporting multiple comma-separated values such as invoice_date, -invoice_date, billing_period, -billing_period, number, -number, due_date, -due_date, amount, -amount, balance, -balance.

Output

JSON

  • data - The JSON response containing the list of invoices 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 filter values 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 output; ensure the parameters are correctly set and the API endpoint is reachable.

Discussion