WibiClick

Interact with WibiClick API

Actions92

Overview

This node integrates with the WibiClick API to manage various resources such as employees, jobs, contacts, invoices, and more. Specifically for the Employee resource and the Get Employee Earnings operation, it retrieves the earnings data of a specified employee within a given date range.

Typical use cases include:

Fetching payroll or earnings reports for an employee over a specific period.
Integrating employee earnings data into payroll systems or financial dashboards.
Automating reporting workflows that require employee compensation details.

For example, you can use this node to get the total earnings of an employee between January 1st and March 31st, which can then be used for accounting or HR purposes.

Properties

Name	Meaning
Employee ID	The unique identifier of the employee whose earnings are to be retrieved.
Start Date	The start date of the period for which to fetch employee earnings (inclusive).
End Date	The end date of the period for which to fetch employee earnings (inclusive).

These properties must be provided to specify the employee and the time frame for the earnings query.

Output

The output JSON contains the earnings data returned by the WibiClick API for the specified employee and date range. The structure depends on the API response but typically includes fields such as total earnings, breakdowns by pay period, bonuses, deductions, or other relevant financial details related to the employee's compensation.

Example output snippet (structure may vary):

{
  "employeeId": "12345",
  "startDate": "2024-01-01T00:00:00Z",
  "endDate": "2024-03-31T23:59:59Z",
  "earnings": [
    {
      "date": "2024-01-31",
      "amount": 3000
    },
    {
      "date": "2024-02-28",
      "amount": 3200
    }
  ],
  "totalEarnings": 6200
}

No binary data is output by this operation.

Dependencies

Requires an API key credential for authenticating requests to the WibiClick API.
The node uses HTTP requests to communicate with the WibiClick service endpoint.
Ensure the API URL and key are correctly configured in the node credentials.

Troubleshooting

Invalid or missing Employee ID: The API call will fail if the employee ID is not provided or incorrect. Verify the employee ID before running the node.
Date format errors: The start and end dates must be valid ISO 8601 date strings. Invalid formats will cause errors.
Start date after end date: The node checks that the start date is before the end date; otherwise, it throws an error.
API authentication errors: If the API key is invalid or expired, requests will fail with authorization errors. Update the API key in credentials.
Network or API downtime: Temporary network issues or API unavailability will cause request failures. Retry later or check API status.

Error messages from the node generally reflect these issues and provide guidance on what parameter or configuration needs correction.

Links and References

WibiClick API Documentation (Assumed link, replace with actual if available)
n8n HTTP Request Node documentation: https://docs.n8n.io/nodes/n8n-nodes-base.httpRequest/
n8n Credentials Management: https://docs.n8n.io/credentials/overview/

This summary focuses exclusively on the Employee resource and the Get Employee Earnings operation as requested.

WibiClickInstall