# List Invoices — Zoho Books

> Lists all invoices. See the documentation

- Key: `zoho_books-list-invoices`
- Type: Action (Read-only)
- Version: 0.3.1
- App: Zoho Books (`zoho_books`) — https://pipedream.com/apps/zoho-books.md
- This page (HTML): https://pipedream.com/apps/zoho-books/actions/list-invoices
- Hints: read-only · open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/zoho_books/actions/list-invoices/list-invoices.mjs

## Description

Lists all invoices. [See the documentation](https://www.zoho.com/books/api/v3/contacts/#list-contacts)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `invoiceNumber` | `string` | No | Search invoices by invoice number. Max-length [100] |
| `itemName` | `string` | No | Search invoices by item name. Max-length [100] |
| `itemId` | `string` | No | Search invoices by item id. |
| `itemDescription` | `string` | No | Search invoices by item description. Max-length [100] |
| `referenceNumber` | `string` | No | The reference number of the invoice. |
| `customerName` | `string` | No | The name of the customer. Max-length [100] |
| `recurringInvoiceId` | `string` | No | ID of the recurring invoice from which the invoice is created. |
| `email` | `string` | No | Search contacts by email id. Max-length [100] |
| `total` | `string` | No | The total amount to be paid. |
| `balance` | `string` | No | The unpaid amount. |
| `customField` | `string` | No | Search invoices by custom fields. |
| `date` | `string` | No | Search invoices by invoice date. Default date format is yyyy-mm-dd. |
| `dueDate` | `string` | No | Search invoices by due date. Default date format is yyyy-mm-dd. |
| `lastModifiedTime` | `string` | No | Last Modified Time |
| `status` | `string` | No | Search invoices by invoice status. |
| `customerId` | `string` | No | ID of the customer the invoice has to be created. |
| `filterBy` | `string` | No | Filter invoices by any status or payment expected date. |
| `searchText` | `string` | No | Search invoices by invoice number or purchase order or customer name. Max-length [100] |
| `sortColumn` | `string` | No | Sort invoices. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_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",
  },
})
```

**TypeScript**

```ts
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**

```bash
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"
    }
  }'
```

---

- App: https://pipedream.com/apps/zoho-books.md · All apps: https://pipedream.com/apps