WibiClick icon

WibiClick

Interact with WibiClick API

Actions92

Overview

The node integrates with the WibiClick API to manage various resources such as notes, jobs, contacts, employees, estimates, invoices, and more. Specifically for the Invoice resource with the Get Invoice operation, it retrieves a single invoice by its ID from the WibiClick system.

This node is beneficial in scenarios where you need to automate invoice retrieval within workflows, such as fetching invoice details for reporting, processing payments, or syncing invoice data with other systems.

Example use case:
You have an automation that triggers when a new payment is received, and you want to fetch the corresponding invoice details to update your accounting software or notify your finance team.


Properties

Name Meaning
Invoice ID The unique identifier of the invoice to retrieve. This is a required string input.

Output

The output JSON contains the full invoice data as returned by the WibiClick API for the specified invoice ID. The structure depends on the API response but typically includes fields such as invoice number, customer details, line items, amounts, dates, status, and notes.

No binary data output is produced by this operation.


Dependencies

  • Requires an active connection to the WibiClick API via an API key credential.
  • The node uses HTTP requests to communicate with the WibiClick API endpoints.
  • The API base URL and authentication token must be configured in the node credentials.

Troubleshooting

  • Common issues:

    • Invalid or missing Invoice ID will cause the request to fail.
    • Network connectivity problems or incorrect API credentials will result in authentication errors.
    • If the invoice ID does not exist, the API may return a 404 error or an empty response.
  • Error messages:

    • "Failed to get invoice" (implied if the API returns no data).
    • HTTP errors from the API are wrapped and thrown as node errors.
  • Resolution tips:

    • Ensure the Invoice ID is correct and exists in the WibiClick system.
    • Verify that the API key credential is valid and has necessary permissions.
    • Check network connectivity and API endpoint availability.

Links and References


Summary of Relevant Code Snippet for "Invoice" Resource and "Get Invoice" Operation

if(m === "invoice") {
  if(r === "getInvoice") {
    let invoiceId = this.getNodeParameter("invoiceId", e);
    let response = await this.helpers.request({
      method: "GET",
      url: `${s.apiUrl}/invoice?id=${invoiceId}`,
      headers: { Authorization: `Bearer ${s.apiKey}` },
      json: true,
    });
    o.push({ json: response });
  }
}

This snippet shows that the node performs a GET request to the /invoice endpoint with the invoice ID as a query parameter, using the stored API key for authorization, then outputs the JSON response.

Discussion