Zoho Books
@finopsbricks/fob-zb connects you to your Zoho Books organization. One npm package gives you two ways in:
| You want to… | Use | Start here |
|---|---|---|
| Query and update your books from a terminal, or let an AI agent do it | The CLI, fob-zb | Install the CLI |
| Put Zoho Books inside automated workflows: workers, scheduled jobs, assembly lines | The library, import { fobZb } | Use the library |
Both need the same thing first: a connection to Zoho, which is a Zoho Self Client plus a one-time grant code. Connect Zoho Books walks you through it in about five minutes.
fob-zb covers 27 Zoho Books resources: reads on all of them, and writes on the core documents. Some features are not built yet. See Beta limits.
How it works#
fob-zb runs on your machine, or in your worker, and calls the Zoho Books API directly with your own OAuth credentials. No FinOpsBricks server sits in between, and your data and credentials are never sent to us.
- Credentials live in
~/.fob/fob-zb/config.yml(file mode 0600) for the CLI, or inFOB_ZB_*environment variables for workers. - Access tokens last one hour. fob-zb refreshes them from your long-lived refresh token automatically.
- Data centers: Zoho runs separate regions (US, EU, India, Australia and more). Your credentials only work in the region where you created them. See Regions.
What you can do#
| Area | Resources | Writes |
|---|---|---|
| Sales and receivables | contacts, contact persons, estimates, sales orders, invoices, recurring invoices, credit notes, retainer invoices, customer payments | Create, edit and delete contacts, estimates, sales orders, invoices and credit notes. Status actions (mark sent/void/accepted, submit, approve), email, invoice write-off, stop or resume recurring invoices |
| Purchases and payables | bills, recurring bills, vendor credits, purchase orders, expenses, recurring expenses, vendor payments | Create, edit and delete bills and purchase orders. Mark bills open or void. Submit, approve and email purchase orders. Record and delete vendor payments. Stop or resume recurring bills and expenses |
| Banking | bank accounts, bank transactions | Create, edit, delete, activate and deactivate bank accounts. Create, delete, categorize, match, unmatch, exclude and restore feed transactions |
| Accounting | chart of accounts, journals, items | Create, edit, delete, activate and deactivate accounts and items. Journals are read only |
| Projects | projects, time entries | Read only |
| Settings | organizations, users, taxes, currencies | Read only |
Every resource supports list and show. The command reference lists every command and option.
Beta limits#
bank-rulesandbase-currency-adjustmentsare not built yet.bank-transactions categorizeandmatchhave not been validated against a live bank feed. Try them on a test organization first.- Not yet supported: attachments and receipts, bulk operations, report endpoints, and a browser-based login.
Missing something? Open an issue on GitHub.
fob-zb is not affiliated with or endorsed by Zoho Corporation. "Zoho" and "Zoho Books" are trademarks of Zoho Corporation.