LEDGERS icon

LEDGERS

Interact with LEDGERS API
Join our community

Actions34

Overview

This node allows updating a catalog entry in an external ledger or inventory management system via its API. It is designed to modify details of an existing catalog item such as currency, tax rate, units, description, status, and other financial or product-related attributes.

Common scenarios where this node is beneficial include:

  • Automating updates to product catalogs when prices, descriptions, or tax rates change.
  • Synchronizing product information between different systems.
  • Managing product metadata programmatically in bulk workflows.

For example, you could use this node to update the currency and tax rate of a product catalog entry after receiving new pricing information from a supplier.

Properties

Name Meaning
Catalog ID The unique identifier of the catalog entry to update. This is required to specify which catalog item will be modified.
Update Fields A collection of fields that can be updated for the catalog entry. These include:
- Currency The currency code for the catalog item price. Options include standard ISO currency codes like USD, INR, EUR, etc.
- Tax Rate The applicable tax rate for the catalog item. Options include percentages (0%, 5%, 18%, 40%) and special tax categories like Exempted Supply, Nil-Rated, Non-Tax Supply, Zero-Rated.
- Units The unit of measurement for the catalog item quantity. Options include pieces, kilograms, liters, dozens, bundles, cartons, meters, and many others.
- Product Description A text field to provide or update the description of the product.
- Status The active status of the catalog item. Options are Active (1) or Inactive (0).
- HSN/SAC Code The Harmonized System of Nomenclature (HSN) or Service Accounting Code (SAC) used for tax classification.
- Expense Name or ID An expense account associated with the catalog item, selectable from a list loaded dynamically from the ledger system.
- Cess Type The type of cess applied, either as a percentage or a flat value.
- Cess Value The numeric value of the cess. For percentage type, it should be between 1-100; for flat type, it is an absolute value.

Output

The node outputs JSON data representing the response from the ledger API after attempting to update the catalog entry. This typically includes confirmation of the update, any updated catalog data, or error messages if the update failed.

No binary data output is indicated by the source code.

Dependencies

  • Requires an API key credential and user authentication credentials (email and password) for the external ledger system.
  • The node performs login requests to obtain an API token before making update calls.
  • The API URL endpoint must be configured correctly in the credentials.
  • Uses HTTP POST and GET requests to interact with the ledger API.
  • Requires n8n's HTTP request helper functions for API communication.

Troubleshooting

  • Authentication Failures: If the node throws errors about authentication failure, verify that the API key, email, and password credentials are correct and have sufficient permissions.
  • Invalid Catalog ID: Ensure the Catalog ID provided exists in the ledger system; otherwise, the update will fail or return no data.
  • Incorrect Field Values: Providing invalid values for currency, tax rate, or units may cause the API to reject the update. Use only supported options.
  • API Endpoint Issues: Confirm the API URL is reachable and correct. Network issues or incorrect URLs will cause request failures.
  • Error Messages: The node surfaces API error messages such as "Failed to login" or validation errors from the ledger system. Review these messages to adjust inputs or credentials accordingly.

Links and References

Discussion