Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API

Actions476

Payments → Get All Payments

AI-generated

Overview

This node interacts with the Billing Booth One API to retrieve payment data. Specifically, the 'Get All Payments' operation fetches a list of payments with various filtering and sorting options. It is useful for scenarios where users need to query payment records based on criteria such as customer ID, organisation ID, invoice ID, provider, source, status, date ranges, and sorting preferences. For example, a user can retrieve all payments made by a specific customer within a date range or get the latest payments sorted by creation date.

Use Case Examples

  1. Retrieve the first 10 payments for a specific customer ID.
  2. Get all payments with status 'confirmed' from a particular provider.
  3. Fetch payments created between two dates and sort them by charge amount.

Properties

Name Meaning
limit Maximum number of payment entries to return.
offset Starting offset for the list of payments to return.
customer_id Filter payments by customer ID.
organisation_id Filter payments by organisation ID.
invoice_id Filter payments by invoice ID.
provider Filter payments by payment provider (e.g., Go Cardless, Smarter Pay, Stripe).
source Filter payments by source (User, Billingbooth, Provider).
status Filter payments by their status (e.g., pendingCustomerApproval, confirmed, paidOut).
from Filter payments created from this date.
to Filter payments created up to this date.
charge_from Filter payments charged from this date.
charge_to Filter payments charged up to this date.
last_updated_from Filter payments last updated from this date.
last_updated_to Filter payments last updated up to this date.
sort Sort order of results, supporting multiple comma-separated values (e.g., created, -created, charge, -charge).

Output

JSON

  • data - The main data object containing the list of payments returned by the API.

Dependencies

  • Billing Booth One API
  • An API key credential for 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 typically include details from the API response; ensure the base URL and access token are correctly configured.

Links

Discussion