Actions17
Overview
The node integrates with the Zoho Books API to update invoice records. It allows users to modify various invoice details such as customer association, invoice date, line items, payment terms, discounts, and additional custom data. This node is beneficial in automating financial workflows where invoices need to be programmatically updated based on business logic or external triggers.
Practical examples:
- Automatically updating an invoice's due date or adding notes after a customer service interaction.
- Adjusting line items or applying discounts dynamically before sending the invoice to a customer.
- Merging additional JSON data into the invoice for custom fields or metadata not directly exposed by standard properties.
Properties
| Name | Meaning |
|---|---|
| Invoice ID | The unique identifier of the invoice to update. |
| Customer ID | The ID of the customer associated with the invoice (required). |
| Invoice Date | The date of the invoice in YYYY-MM-DD format. |
| Line Items | Collection of line items, each with Item ID or Item Name, Quantity, and Rate. |
| Additional Invoice Data (JSON) | Additional JSON data merged with other invoice fields for extended customization. |
| Invoice Number | The invoice number string. |
| Reference Number | A reference number associated with the invoice. |
| Due Date | The due date for the invoice in YYYY-MM-DD format. |
| Terms | Terms and conditions text for the invoice. |
| Notes | Internal notes related to the invoice. |
| Customer Notes | Notes intended for the customer. |
| Discount | Numeric discount amount applied to the invoice. |
| Shipping Charge | Shipping charge amount added to the invoice. |
| Adjustment | Adjustment amount (positive or negative) applied to the invoice total. |
| Adjustment Description | Description explaining the adjustment. |
| Template ID | Identifier for the invoice template to use. |
| Salesperson Name | Name of the salesperson associated with the invoice. |
Output
The node outputs an array of JSON objects representing the updated invoice(s). Each output item contains the invoice data returned from Zoho Books API after the update operation. The structure typically includes fields like invoice ID, customer ID, dates, line items, totals, and any other invoice attributes as returned by the API.
If the operation is successful, the output JSON will contain the updated invoice object under the key "invoice". In case of errors, the output may include an error message describing the failure.
This node does not output binary data.
Dependencies
- Requires an OAuth2 authenticated connection to Zoho Books API.
- The credentials must include:
- An organization ID (mandatory).
- OAuth2 tokens for API access.
- The node uses the Zoho Books API endpoint specific to the domain configured in credentials.
- No additional environment variables are required beyond the credential setup.
Troubleshooting
Missing Organization ID:
Error: "Zoho Books Organization ID is required in your credentials."
Resolution: Ensure the organization ID is set correctly in the Zoho Books API credentials.Missing Required IDs for Update:
Errors like "Invoice ID is required for Update operation."
Resolution: Provide the correct invoice ID when performing update operations.Invalid JSON in Additional Data:
Error: "Additional Invoice Data must be valid JSON."
Resolution: Verify that the JSON string provided in the "Additional Invoice Data" field is well-formed.API Errors:
Errors returned from Zoho Books API include error codes and messages. These usually indicate issues like invalid parameters, authentication failures, or resource not found.
Resolution: Review the error message, check input parameters, and ensure API credentials are valid.Line Items Formatting:
If line items are incorrectly formatted or missing required fields (like item ID or name), the API may reject the request.
Resolution: Ensure each line item has either an item ID or item name, along with quantity and rate.