Zoho Books icon

Zoho Books

Consume Zoho Books API

Vendor Credit → Update

AI-generated

Overview

This node operation updates an existing Vendor Credit record in Zoho Books. It allows users to modify various fields of a vendor credit such as date, reference number, notes, currency, discounts, tax exemptions, adjustments, and line items. This is useful for businesses that need to correct or adjust vendor credits after they have been created, ensuring accurate accounting records.

Common scenarios:

  • Correcting the date or reference number on a vendor credit.
  • Adding or updating notes or terms related to the vendor credit.
  • Changing currency or exchange rates for multi-currency transactions.
  • Applying discounts or adjustments to the vendor credit.
  • Updating line items to reflect changes in quantities, rates, or descriptions.

Practical example:
A company receives a vendor credit but notices the discount was not applied correctly. Using this node, they can update the discount amount and type, adjust line items if necessary, and add notes explaining the change.

Properties

Name Meaning
Vendor Credit ID The unique identifier of the vendor credit to update.
Update Fields Collection of fields to update on the vendor credit. Options include:
- Date The date of the vendor credit (format YYYY-MM-DD).
- Vendor Credit Number Custom vendor credit number.
- Reference Number Reference number associated with the vendor credit.
- Notes Additional notes for the vendor credit.
- Terms Terms and conditions related to the vendor credit.
- Currency Currency used for the vendor credit. Options are dynamically loaded from available currencies.
- Exchange Rate Exchange rate for multi-currency vendor credits (precision up to 4 decimal places).
- Discount Discount amount or percentage applied to the vendor credit (precision up to 2 decimal places).
- Discount Type How the discount is applied; options are "Entity Level" or "Item Level".
- Is Discount Before Tax Boolean indicating whether the discount is applied before tax calculation.
- Tax Exemption ID Tax exemption to apply to the vendor credit. Options are dynamically loaded from available tax exemptions.
- Adjustment Adjustment amount to be added or subtracted (precision up to 2 decimal places).
- Adjustment Description Description explaining the adjustment.
Line Items Optional collection to update line items of the vendor credit. Each line item includes:
- Line Type Type of line item, either "Item" or "Expense".
- Item Item identifier for "Item" line types (dynamically loaded).
- Account Account identifier for "Expense" line types (dynamically loaded).
- Quantity Quantity of the item. Defaults to 1.
- Rate Rate per unit, must be non-negative (precision up to 2 decimal places).
- Description Description for the line item.

Output

The node outputs the updated vendor credit record as JSON. The output structure corresponds to the updated vendor credit object returned by the Zoho Books API, including all fields reflecting the changes made.

If multiple input items are processed, the output will be an array of updated vendor credit objects paired with their respective input items.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to Zoho Books via an OAuth2 API credential.
  • The node depends on Zoho Books API endpoints for vendor credit updates.
  • Dynamic option loading for currencies, tax exemptions, items, and accounts requires appropriate API permissions and connectivity.
  • No additional external services beyond Zoho Books API are required.

Troubleshooting

  • Invalid Vendor Credit ID: If the provided vendor credit ID does not exist or is incorrect, the API will return an error. Verify the ID before running the node.
  • Permission Errors: Ensure the API credentials have sufficient permissions to update vendor credits.
  • Invalid Field Values: Providing invalid values (e.g., negative rates, unsupported currency IDs) may cause errors. Validate inputs carefully.
  • Line Items Format: When updating line items, ensure the structure matches expected types and required fields are present.
  • API Rate Limits: Frequent updates may hit Zoho Books API rate limits. Implement retry logic or reduce request frequency if encountering rate limit errors.
  • Continue On Fail: If enabled, the node will continue processing other items even if one fails, returning error details in the output JSON.

Links and References

Discussion