@arathron/n8n-nodes-zoho-books

n8n-nodes-zoho-books

This is an n8n community node that lets you use Zoho Books in your n8n workflows.

Zoho Books is a cloud-based accounting software that helps you manage your finances, automate business workflows, and work collaboratively across departments.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

This node supports the following operations for each resource:

Sales Orders

• Create: Create a new sales order
• Get: Get a sales order by ID
• Get All: Get all sales orders with filters
• Update: Update an existing sales order
• Void: Void a sales order

Invoices

• Create: Create a new invoice
• Get: Get an invoice by ID
• Get All: Get all invoices with filters
• Update: Update an existing invoice
• Void: Void an invoice

Items

• Create: Create a new item
• Get: Get an item by ID
• Get All: Get all items with filters
• Update: Update an existing item
• Delete: Delete an item

Vendors

• Create: Create a new vendor
• Get: Get a vendor by ID
• Get All: Get all vendors with filters
• Update: Update an existing vendor
• Delete: Delete a vendor

Credit Notes

• Create: Create a new credit note
• Get: Get a credit note by ID
• Get All: Get all credit notes with filters
• Update: Update an existing credit note
• Void: Void a credit note

Payments

• Create: Create a new payment
• Get: Get a payment by ID
• Get All: Get all payments with filters
• Update: Update an existing payment
• Delete: Delete a payment

Credentials

To use this node, you need to create OAuth2 credentials for Zoho Books:

• Go to Zoho API Console
• Create a new client:
  • Choose "Server-based Applications"
  • Add authorized redirect URL from n8n (shown when creating credentials)
  • Note down your Client ID and Client Secret
• In n8n:
  • Create new Zoho Books OAuth2 credentials
  • Select your data center (US, EU, IN, AU, or CN)
  • Enter your Client ID and Client Secret
  • Enter your Organization ID (found in Zoho Books Settings)
  • Click "Connect My Account" and authorize the app

Required Scopes

The node requires the following scope:

• ZohoBooks.fullaccess.all

Compatibility

• n8n version 1.0.0 or higher
• Tested with Zoho Books API v3

Usage

Example: Create an Invoice

• Add a Zoho Books node to your workflow
• Select "Invoice" as the resource
• Select "Create" as the operation
• Fill in required fields:
  • Customer ID
  • Line Items (with item ID, quantity, and rate)
• Add optional fields as needed:
  • Due date
  • Discount
  • Notes
  • Custom fields

Example: Get All Sales Orders with Filters

• Add a Zoho Books node
• Select "Sales Order" as the resource
• Select "Get All" as the operation
• Configure filters:
  • Status: "confirmed"
  • Date range
  • Sort by date descending
• Choose to return all results or limit to specific number

Example: Apply Payment to Invoices

• Add a Zoho Books node
• Select "Payment" as the resource
• Select "Create" as the operation
• Fill in:
  • Customer ID
  • Payment mode (e.g., "Bank Transfer")
  • Amount
  • Date
• In Additional Fields, add invoices to apply the payment to:
  • Invoice ID
  • Amount to apply

Resources

• n8n community nodes documentation
• Zoho Books API documentation
• OAuth2 setup guide for Zoho

Development

Setup

# Install dependencies
npm install

# Build the node
npm run build

# Run tests
npm test

# Run in development mode
npm run dev

Testing

The node includes comprehensive unit tests and integration tests. To run tests:

# Run all tests
npm test

# Run with coverage
npm run test:coverage

# Run only unit tests
npm run test -- test/unit

# Run only integration tests
npm run test:integration

Contributing

• Fork the repository
• Create a feature branch (git checkout -b feature/amazing-feature)
• Commit your changes (git commit -m 'feat: add amazing feature')
• Push to the branch (git push origin feature/amazing-feature)
• Open a Pull Request

Please ensure:

• All tests pass
• Code coverage remains above 90%
• Linting passes (npm run lint)
• Commits follow Conventional Commits

License

MIT