Bizappay icon

Bizappay

Interact with Bizappay API

Actions13

Overview

This node integrates with the Bizappay API to manage bills and related entities. Specifically, the "Bill - Get Many" operation retrieves multiple bills from Bizappay with optional filtering and pagination. This is useful for scenarios where you want to list or analyze a collection of bills, such as generating reports, monitoring outstanding payments, or syncing bill data with other systems.

For example, you can use this node to:

  • Fetch all open bills on page 1 with a limit of 50 results.
  • Retrieve paid bills filtered by a specific category.
  • Paginate through bills in batches for processing or exporting.

Properties

Name Meaning
Filters Collection of filters to apply when retrieving bills:
- Page: Page number for pagination (default 1).
- Limit: Maximum number of results to return per request (minimum 1, default 50).
- Status: Filter bills by status. Options: Open, Closed, Paid (default Open).
- Category Name or ID: Filter bills by category. Choose from a loaded list or specify an ID.

Output

The output JSON contains the response from the Bizappay API for the list of bills. The main structure includes:

  • bills: An array of bill objects, each representing a bill with details such as ID, name, amount, status, category, payer info, etc.
  • total: Total number of bills returned.
  • filters_applied: List of filter keys that were applied in the request.
  • search_summary: Summary information including total found, count of filters applied, and timestamp of the search.

Additionally, the node adds a _summary field summarizing the retrieved bills:

  • totalBills: Number of bills returned.
  • statusBreakdown: Object counting how many bills are in each status.
  • totalAmount: Sum of amounts of all retrieved bills, formatted as a string with two decimals.

Example snippet of output JSON structure:

{
  "status": "ok",
  "data": [
    {
      "billId": "123",
      "name": "Electricity Bill",
      "amount": "100.00",
      "status": "open",
      "category": "utilities",
      "payer_email": "customer@example.com"
      // ... other bill fields
    }
    // ... more bills
  ],
  "total": 10,
  "filters_applied": ["page", "limit", "status"],
  "_summary": {
    "totalBills": 10,
    "statusBreakdown": {
      "open": 7,
      "paid": 3
    },
    "totalAmount": "1500.00"
  }
}

Dependencies

  • Requires an API key credential for authenticating requests to the Bizappay API.
  • Uses the internal helper function to make HTTP POST requests to endpoints like /bill/list.
  • The node depends on n8n's environment to provide credentials and handle HTTP communication.

Troubleshooting

  • Empty or missing bills array: Ensure that the filters are correctly set and that there are bills matching those criteria in your Bizappay account.
  • Invalid pagination parameters: The page must be a positive integer; limit must be at least 1.
  • API errors: If the API returns an error, it will be surfaced as a node error. Check your API key validity and network connectivity.
  • Category filter issues: When filtering by category, ensure the category exists and is correctly selected or specified by ID.
  • Serialization errors: If the response contains non-serializable data, the node will catch and report it as a serialization error.

Links and References

Discussion