WibiClick icon

WibiClick

Interact with WibiClick API

Actions92

Overview

This node interacts with the WibiClick API to manage invoices and other related resources. Specifically, for the Invoice resource with the Get Invoices operation, it retrieves multiple invoices associated with a specified website. This is useful in scenarios where you want to fetch a list of invoices for reporting, auditing, or further processing within an automation workflow.

For example, you might use this node to:

  • Retrieve all invoices for a particular website to generate financial reports.
  • Filter invoices by employee, customer, or job IDs to analyze specific segments.
  • Paginate through large sets of invoices using limit and offset parameters.

Properties

Name Meaning
Website ID The unique identifier of the website for which invoices are being retrieved.
Limit Maximum number of invoice results to return (pagination control).
Offset Number of invoices to skip before starting to collect the result set (pagination control).
Additional Fields Optional filters to narrow down invoices by:
- Employee ID: Filter invoices by a specific employee.
- Customer ID: Filter invoices by a specific customer.
- Job ID: Filter invoices by a specific job.

Output

The output is a JSON object containing the retrieved invoices data from the WibiClick API. The structure typically includes an array or collection of invoice objects, each representing an invoice with its details as provided by the API.

Example output JSON structure (simplified):

{
  "invoices": [
    {
      "id": "invoice-id-1",
      "number": "INV-001",
      "customerId": "customer-id-1",
      "employeeId": "employee-id-1",
      "jobId": "job-id-1",
      "issuedAt": "2024-01-01T00:00:00Z",
      "dueAt": "2024-01-15T00:00:00Z",
      "sales": 1000,
      "notes": "Invoice notes here",
      ...
    },
    ...
  ],
  "totalCount": 123,
  "limit": 50,
  "offset": 0
}

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the WibiClick API.
  • Requires an API key credential configured in n8n for authentication.
  • The node uses HTTP requests to communicate with the WibiClick API endpoints.

Troubleshooting

  • Invalid Website ID: If the website ID is incorrect or missing, the API will likely return an error or empty results. Ensure the website ID is valid and correctly entered.
  • API Authentication Errors: If the API key credential is invalid or expired, requests will fail with authorization errors. Verify the API key and update if necessary.
  • Pagination Issues: Setting very high limits may cause performance issues or API rate limiting. Use reasonable values for limit and offset.
  • Filter Misuse: Providing invalid or non-existent employee, customer, or job IDs in additional fields may result in no invoices returned. Double-check filter values.
  • Network or API Downtime: Temporary network issues or API service downtime can cause request failures. Retry after some time or check API status.

Common error messages come directly from the API and are surfaced as node errors. They usually indicate issues like unauthorized access, invalid parameters, or resource not found.

Links and References


This summary focuses exclusively on the Invoice resource's Get Invoices operation as requested, based on static analysis of the provided source code and property definitions.

Discussion