WibiClick icon

WibiClick

Interact with WibiClick API

Actions92

Overview

This node integrates with the WibiClick API to manage various resources such as invoices, contacts, jobs, employees, and more. Specifically, for the Invoice resource with the Get Outstanding Invoices operation, it retrieves a list of outstanding invoices for a specified website within a given year and month.

This functionality is useful in scenarios where businesses want to automate the retrieval of unpaid or overdue invoices for financial tracking, reporting, or follow-up actions. For example, an accounting workflow could use this node to fetch all outstanding invoices monthly and then trigger reminders or update accounting systems accordingly.

Properties

Name Meaning
Website ID The unique identifier of the website for which to retrieve outstanding invoices.
Year The calendar year (e.g., 2023) for which to get outstanding invoices.
Month The calendar month (1-12) for which to get outstanding invoices.

These properties are required inputs to specify the scope of the outstanding invoices query.

Output

The node outputs JSON data containing the outstanding invoices retrieved from the WibiClick API for the specified website, year, and month.

  • The output JSON structure corresponds directly to the API response from the endpoint /outstanding-invoices.
  • It typically includes details about each outstanding invoice such as invoice ID, customer info, amounts due, dates, and status.
  • No binary data output is involved in this operation.

Example output snippet (conceptual):

{
  "invoices": [
    {
      "id": "invoice123",
      "customerId": "customer456",
      "amountDue": 1500,
      "dueDate": "2023-01-31",
      "status": "outstanding"
    },
    ...
  ]
}

Dependencies

  • Requires an active connection to the WibiClick API.
  • Needs an API key credential configured in n8n for authentication.
  • The node uses HTTP requests to communicate with the WibiClick API endpoints.
  • Proper network access to the API URL specified in the credentials is necessary.

Troubleshooting

  • Invalid Website ID: If the website ID is incorrect or not found, the API may return an error or empty results. Verify the website ID input.
  • Authentication Errors: Missing or invalid API key will cause authorization failures. Ensure the API key credential is correctly set up.
  • Invalid Date Inputs: Year and month must be valid numbers; month should be between 1 and 12. Invalid values may cause errors or no data returned.
  • API Rate Limits or Downtime: If the API service is unavailable or rate-limited, requests may fail. Check API status and retry later.
  • Error Messages: The node throws errors with messages from the API or generic messages like "Failed to create note" for other operations. For this operation, errors would typically relate to request failure or invalid parameters.

Links and References


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

Discussion