Billing Booth One icon

Billing Booth One

Interact with Billing Booth One API
Join our community

Actions476

Overview

This node interacts with the Billing Booth One API to retrieve all credit notes based on specified filters and options. It is useful for scenarios where users need to fetch multiple credit notes with criteria such as customer ID, date range, organization ID, credit note number, and sorting preferences. For example, a user can retrieve all credit notes for a specific customer within a date range or limit the number of results returned.

Use Case Examples

  1. Fetch all credit notes for a given customer ID with a limit of 20 entries.
  2. Retrieve credit notes filtered by organization ID and sorted by credit date in descending order.

Properties

Name Meaning
Customer Id Customer unique identifier used to filter credit notes.
Limit Maximum number of credit note entries to return.
Offset Starting offset for the list of credit notes, useful for pagination.
From Filter credit notes from this date (start date).
To Filter credit notes up to this date (end date).
Organisation Id Filter credit notes by organization ID.
Credit Note Number Filter credit notes by their credit note number.
Sort Sort order of results, supporting multiple comma-separated values such as creditdate, -creditdate, amount, -amount, number, -number.

Output

JSON

  • json - The JSON output contains the retrieved credit notes data from the Billing Booth One API, structured as an array of credit note objects or a single object depending on the API response.

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.
  • Network or API endpoint issues may cause request failures; ensure the base URL is correct and the API service is reachable.

Discussion