Huntress icon

Huntress

Work with the Huntress API

Actions11

Overview

This node interacts with the Huntress API to retrieve billing reports. Specifically, the "Get Many" operation under the "Billing Report" resource fetches multiple billing report entries based on specified filters. This is useful for scenarios where users want to review or analyze billing statuses in bulk, such as auditing open invoices, tracking paid bills, or investigating refunds.

Practical examples include:

  • Fetching all open billing reports to follow up on pending payments.
  • Retrieving all failed billing attempts for troubleshooting payment issues.
  • Listing all fully refunded transactions for financial reconciliation.

Properties

Name Meaning
Filters A collection of filter options to narrow down the billing reports returned by status. Possible values: Failed, Full Refund, Open, Paid, Partial Refund.

Output

The node outputs a JSON array of billing report objects matching the applied filters. Each object represents a billing report entry with details as provided by the Huntress API. The exact structure depends on the API response but typically includes fields like billing status, amounts, dates, and identifiers.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authenticating with the Huntress API.
  • The node uses the base URL https://api.huntress.io/v1 for requests.
  • Pagination support is included via a generic pagination function to handle multiple pages of results.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Using unsupported filter values may result in empty responses or errors.
    • Network connectivity problems can prevent successful API calls.
  • Error Messages:

    • Authentication errors typically indicate invalid API keys; verify and update credentials.
    • HTTP status codes from the API (e.g., 400, 401, 500) are passed through; check the message for details.
    • If no billing reports are returned, confirm that the filter criteria match existing data.

Links and References

Discussion