Zoho Books icon

Zoho Books

Consume Zoho Books API

Credit Note → Update

AI-generated

Overview

This node operation updates an existing Credit Note in Zoho Books. It allows users to modify various fields of a credit note, including line items, dates, reference numbers, notes, terms, discounts, and exchange rates. This is useful for businesses that need to correct or adjust credit notes after they have been created, such as updating quantities, prices, or applying new terms.

Practical examples:

  • Adjusting the quantity or rate of items on a credit note after a customer requests a change.
  • Adding notes or terms to clarify the reason for the credit.
  • Applying discounts at either the entity or item level.
  • Updating the credit note date or reference number for record-keeping compliance.

Properties

Name Meaning
Credit Note ID The unique identifier of the credit note to update.
Line Items A collection of line items to include in the credit note. Each item includes:
- Item Name or ID (select from list or specify ID)
- Quantity (minimum 0.01)
- Rate (price per unit, with two decimals)
- Tax ID (tax rate to apply)
Update Fields Additional fields to update on the credit note:
- Date: The date of the credit note (YYYY-MM-DD format)
- Credit Note Number: Custom credit note number
- Reference Number: Reference number for the credit note
- Notes: Notes text
- Terms: Terms and conditions text
- Discount: Discount amount or percentage (two decimals)
- Discount Type: How discount is applied, options are "Entity Level" or "Item Level"
- Exchange Rate: Exchange rate for multi-currency credit notes (four decimals)

Output

The output is a JSON object representing the updated credit note returned by the Zoho Books API. It contains all relevant details of the credit note after the update, including updated line items, amounts, dates, and metadata.

If multiple input items are processed, the output will be an array of such JSON objects, each paired with the corresponding input item index.

No binary data output is indicated.

Dependencies

  • Requires an active connection to Zoho Books via an OAuth2 API credential.
  • The node dynamically loads the Credit Note resource handler internally.
  • The user must provide a valid Credit Note ID and appropriate permissions to update it.
  • The node uses helper methods to load selectable options for items and taxes.

Troubleshooting

  • Invalid Credit Note ID: If the provided Credit Note ID does not exist or is incorrect, the API will return an error. Verify the ID is correct.
  • Missing Required Fields: The node requires at least one line item to update. Ensure the line items collection is not empty.
  • Permission Errors: Insufficient API permissions or expired credentials may cause authorization errors. Refresh or reconfigure credentials.
  • Invalid Field Values: Providing invalid dates, negative quantities, or unsupported discount types can cause validation errors. Check field formats carefully.
  • API Rate Limits: Frequent updates may hit Zoho Books API rate limits. Implement retry logic or reduce request frequency if needed.

Links and References

Discussion