WibiClick icon

WibiClick

Interact with WibiClick API
Join our community

Actions92

Overview

This node integrates with the WibiClick API to manage estimates within a website's system. Specifically, the "Add or Update Estimate" operation allows users to create a new estimate or update an existing one by providing detailed estimate data and associated line items. This is useful for businesses that need to generate cost estimates for customers, track sales projections, or update existing estimates as project details change.

Common scenarios include:

  • Creating a new estimate for a customer based on job requirements.
  • Updating an existing estimate with revised pricing or additional line items.
  • Managing estimates programmatically as part of a larger workflow involving jobs, invoices, or customer management.

Example use case:
A service company automates the creation of estimates when a new job request is received, including itemized costs, due dates, and assigned employees, ensuring accurate and timely communication with clients.

Properties

Name Meaning
Website ID The unique identifier of the website where the estimate belongs.
Estimate Data A collection of fields describing the estimate:
- Customer ID: Identifier of the customer.
- Due At: Due date of the estimate (date/time).
- Employee ID: Identifier of the employee responsible.
- ID: Identifier of the estimate (used for updates).
- Issued At: Date when the estimate was issued (date/time).
- Job ID: Identifier of the associated job.
- Name: Name/title of the estimate.
- Notes: Additional notes related to the estimate.
- Number: Reference number of the estimate.
- Reason: Reason or description for the estimate.
- Sales: Sales amount (numeric).
Line Items Multiple line items associated with the estimate, each containing:
- ID: Identifier of the line item (for updates).
- Name: Name of the item.
- Description: Description of the item.
- Amount: Monetary amount for the item.
- Quantity: Quantity of the item (default 1).

Output

The output JSON contains the response from the WibiClick API after adding or updating an estimate. It typically includes the full details of the created or updated estimate, reflecting all provided fields and line items.

Example output structure:

{
  "id": "string",
  "customerId": "string",
  "dueAt": "2024-06-01T00:00:00Z",
  "employeeId": "string",
  "issuedAt": "2024-05-01T00:00:00Z",
  "jobId": "string",
  "name": "Estimate Name",
  "notes": "Notes about the estimate",
  "number": "EST-12345",
  "reason": "Reason for estimate",
  "sales": 1000,
  "items": [
    {
      "id": "string",
      "name": "Item Name",
      "description": "Item description",
      "amount": 100,
      "quantity": 2
    }
  ]
}

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the WibiClick API.
  • An API key credential must be configured in n8n to authenticate requests.
  • The node uses HTTP POST requests to send estimate data to the endpoint /add-estimate?id={websiteId}.

Troubleshooting

  • Missing or invalid Website ID: Ensure the Website ID is correctly provided and valid; otherwise, the API will reject the request.
  • Invalid date formats: Dates such as dueAt and issuedAt should be in ISO 8601 format; invalid formats may cause errors.
  • Line items missing required fields: Each line item should have at least a name and amount; missing these may result in incomplete or failed requests.
  • API authentication errors: Verify that the API key credential is correctly set up and has sufficient permissions.
  • Unexpected API responses: If the API returns an error, check the message for details; network issues or malformed requests are common causes.

Links and References

Discussion