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 invoice data using cursor-based pagination. It supports fetching all invoices by specifying cursor positions, page size, and various filters such as organisation ID, date range, invoice reference, billing period, and status. This is useful for workflows that need to process or analyze large sets of invoice data incrementally, for example, syncing invoices to another system or generating reports.

Use Case Examples

  1. Retrieve all outstanding invoices starting from a specific cursor position to process payments.
  2. Fetch invoices filtered by organisation ID and date range for financial reporting.
  3. Paginate through invoices using next and previous cursors to handle large datasets efficiently.

Properties

Name Meaning
Next Cursor Cursor to start at for fetching the next set of invoices.
Previous Cursor Cursor to start at for fetching the previous set of invoices.
Page Size Maximum number of invoice entries to return in one request.
Offset Starting offset for the invoice list.
Organisation Id Filter invoices by organisation ID.
From Filter invoices from this date.
To Filter invoices up to this date.
Invoice Reference Filter invoices by invoice reference.
Billing Period Filter invoices by billing period.
Status Filter invoices by their status (e.g., outstanding, settled, void, partially settled).

Output

JSON

  • data - The JSON response containing invoice data retrieved from the Billing Booth One API.

Dependencies

  • Billing Booth One API
  • An API key credential for authentication

Troubleshooting

  • Ensure the API base URL and credentials are correctly configured to avoid authentication errors.
  • Verify that the cursor values (next_cursor, previous_cursor) are valid numbers to prevent request failures.
  • Check that the page size and offset values are within acceptable limits as defined by the API to avoid errors.
  • If filtering by dates or other fields, ensure the values are correctly formatted and valid according to the API specifications.

Links

Discussion