> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# Find Invoices

- Component: `appmixer.zoho.books.FindInvoices`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.zoho.books 1.3.0](https://connectors.appmixer.com/connector/appmixer.zoho.books/1.3.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.zoho.books/1.3.0/component/appmixer.zoho.books.FindInvoices>

Find invoices in Zoho Books by customer, status, invoice number, reference number, date range or search text. Returns up to 200 invoices, newest first.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Organization ID (`organizationId`) | text | Select the organization, or enter its ID. When empty, the default organization of the connected account is used. |
| Customer ID (`customerId`) | text | Only invoices of this customer. |
| Customer Name (`customerName`) | text | Only invoices of customers with this name. |
| Status (`status`) | select | Only invoices in this status. |
| Invoice Number (`invoiceNumber`) | text | Invoice number, e.g. INV-00001. |
| Reference Number (`referenceNumber`) | text | Reference number of the invoice, e.g. a purchase order number. |
| Invoice Date From (`dateStart`) | date-time | Only invoices dated on or after this date. |
| Invoice Date To (`dateEnd`) | date-time | Only invoices dated on or before this date. |
| Search Text (`searchText`) | text | Searches the invoice number, purchase order and customer name. |
| Output Type (`outputType`) | select | Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file. |

## Output ports

### Port `out`

Variables are loaded dynamically from `/component/appmixer/zoho/books/FindInvoices?outPort=out&ignoreAuth=true`.

### Port `notFound`

_No fields defined for this port._

## Full metadata (component.json)

```json
{
  "name": "appmixer.zoho.books.FindInvoices",
  "label": "Find Invoices",
  "author": "Appmixer <info@appmixer.com>",
  "description": "Find invoices in Zoho Books by customer, status, invoice number, reference number, date range or search text. Returns up to 200 invoices, newest first.",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:zoho:books",
    "scope": [
      "ZohoBooks.invoices.READ"
    ]
  },
  "quota": {
    "manager": "appmixer:zoho:books",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "organizationId": {
            "type": "string"
          },
          "customerId": {
            "type": "string"
          },
          "customerName": {
            "type": "string",
            "maxLength": 100
          },
          "status": {
            "type": "string"
          },
          "invoiceNumber": {
            "type": "string",
            "maxLength": 100
          },
          "referenceNumber": {
            "type": "string"
          },
          "dateStart": {
            "type": "string"
          },
          "dateEnd": {
            "type": "string"
          },
          "searchText": {
            "type": "string",
            "maxLength": 100
          },
          "outputType": {
            "type": "string"
          }
        }
      },
      "inspector": {
        "inputs": {
          "organizationId": {
            "type": "text",
            "label": "Organization ID",
            "index": 0,
            "tooltip": "Select the organization, or enter its ID. When empty, the default organization of the connected account is used.",
            "source": {
              "url": "/component/appmixer/zoho/books/ListOrganizations?outPort=out",
              "data": {
                "transform": "./transformers#organizationsToSelectArray"
              }
            }
          },
          "customerId": {
            "type": "text",
            "label": "Customer ID",
            "index": 1,
            "tooltip": "Only invoices of this customer."
          },
          "customerName": {
            "type": "text",
            "label": "Customer Name",
            "index": 2,
            "tooltip": "Only invoices of customers with this name."
          },
          "status": {
            "type": "select",
            "label": "Status",
            "index": 3,
            "tooltip": "Only invoices in this status.",
            "options": [
              {
                "clearItem": true,
                "content": "-- Clear selection --"
              },
              {
                "label": "Draft",
                "value": "draft"
              },
              {
                "label": "Sent",
                "value": "sent"
              },
              {
                "label": "Viewed",
                "value": "viewed"
              },
              {
                "label": "Overdue",
                "value": "overdue"
              },
              {
                "label": "Unpaid",
                "value": "unpaid"
              },
              {
                "label": "Partially Paid",
                "value": "partially_paid"
              },
              {
                "label": "Paid",
                "value": "paid"
              },
              {
                "label": "Void",
                "value": "void"
              }
            ]
          },
          "invoiceNumber": {
            "type": "text",
            "label": "Invoice Number",
            "index": 4,
            "tooltip": "Invoice number, e.g. INV-00001."
          },
          "referenceNumber": {
            "type": "text",
            "label": "Reference Number",
            "index": 5,
            "tooltip": "Reference number of the invoice, e.g. a purchase order number."
          },
          "dateStart": {
            "type": "date-time",
            "label": "Invoice Date From",
            "index": 6,
            "tooltip": "Only invoices dated on or after this date.",
            "config": {
              "format": "YYYY-MM-DD",
              "enableTime": false
            }
          },
          "dateEnd": {
            "type": "date-time",
            "label": "Invoice Date To",
            "index": 7,
            "tooltip": "Only invoices dated on or before this date.",
            "config": {
              "format": "YYYY-MM-DD",
              "enableTime": false
            }
          },
          "searchText": {
            "type": "text",
            "label": "Search Text",
            "index": 8,
            "tooltip": "Searches the invoice number, purchase order and customer name."
          },
          "outputType": {
            "type": "select",
            "label": "Output Type",
            "index": 9,
            "defaultValue": "array",
            "tooltip": "Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file.",
            "options": [
              {
                "label": "First Item Only",
                "value": "first"
              },
              {
                "label": "All items at once",
                "value": "array"
              },
              {
                "label": "One item at a time",
                "value": "object"
              },
              {
                "label": "Store to CSV file",
                "value": "file"
              }
            ]
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "source": {
        "url": "/component/appmixer/zoho/books/FindInvoices?outPort=out&ignoreAuth=true",
        "data": {
          "properties": {
            "generateOutputPortOptions": true
          },
          "messages": {
            "in/outputType": "inputs/in/outputType"
          }
        }
      }
    },
    {
      "name": "notFound",
      "schema": {
        "type": "object",
        "properties": {}
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
