Zoho Books ACTION
List Invoices
Lists all invoices. See the documentation
- Action
- Read only
- OAuth
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Zoho Books account once, then configure and run List Invoices from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "zoho_books-list-invoices",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
zoho_books: { authProvisionId: "apn_xxxxxxx" },
invoiceNumber: "Invoice Number",
itemName: "Item Name",
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "zoho_books-list-invoices",
"configured_props": {
"zoho_books": { "authProvisionId": "apn_xxxxxxx" },
"invoiceNumber": "Invoice Number",
"itemName": "Item Name"
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "zoho_books",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "zoho_books-list-invoices",
arguments: {
invoiceNumber: "Invoice Number",
itemName: "Item Name",
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
invoiceNumber Invoice Number | string | Search invoices by invoice number. Max-length [100] Optional |
itemName Item Name | string | Search invoices by item name. Max-length [100] Optional |
itemId Item Id | string | Search invoices by item id. Optional |
itemDescription Item Description | string | Search invoices by item description. Max-length [100] Optional |
referenceNumber Reference Number | string | The reference number of the invoice. Optional |
customerName Customer Name | string | The name of the customer. Max-length [100] Optional |
recurringInvoiceId Recurring Invoice Id | string | ID of the recurring invoice from which the invoice is created. Optional |
email Email | string | Search contacts by email id. Max-length [100] Optional |
total Total | string | The total amount to be paid. Optional |
balance Balance | string | The unpaid amount. Optional |
customField Custom Field | string | Search invoices by custom fields. Optional |
date Date | string | Search invoices by invoice date. Default date format is yyyy-mm-dd. Optional |
dueDate Due Date | string | Search invoices by due date. Default date format is yyyy-mm-dd. Optional |
lastModifiedTime Last Modified Time | string | Optional |
status Status | string | Search invoices by invoice status. Optional |
customerId Customer Id | string | ID of the customer the invoice has to be created. Optional |
filterBy Filter By | string | Filter invoices by any status or payment expected date. Optional |
searchText Search Text | string | Search invoices by invoice number or purchase order or customer name. Max-length [100] Optional |
sortColumn Sort Column | string | Sort invoices. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- zoho_books-list-invoices
- Version
- 0.3.1
- App
- Zoho Books
- Authentication
- OAuth
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗