books_get_customers
Retrieve customer lists from Zoho Books with filtering and pagination. Use as a starting point for invoicing and payment workflows.
Instructions
Get customer list from Books with filtering and pagination. WORKFLOW STARTER for Books financial operations.\n\nPrerequisites: Books access with customer management permissions\n\nNext Steps:\n→ Use books_get_customer for detailed customer information\n→ Use customer_id in books_create_invoice for billing\n→ Use customer_id in books_create_payment for payment processing\n\nCommon Financial Workflow: books_get_customers → books_get_customer → books_create_invoice → books_create_payment\n\nExample: Find customers by name\n{"search_text": "John", "per_page": 10}\n\nError Recovery: If no customers found, verify search filters and Books access permissions
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (starts at 1) | |
| No | Filter by email address (partial match) | ||
| phone | No | Filter by phone number (partial match) | |
| address | No | Filter by address (partial match) | |
| per_page | No | Number of customers per page (1-200) | |
| filter_by | No | Advanced filter field (e.g., "Status.Active", "CustomerType.Business") | |
| last_name | No | Filter by last name (partial match) | |
| first_name | No | Filter by first name (partial match) | |
| sort_order | No | Sort order: A=ascending, D=descending | |
| search_text | No | Global search across all customer fields | |
| sort_column | No | Column to sort by (e.g., "contact_name", "company_name", "created_time") | |
| company_name | No | Filter by company name (partial match) | |
| contact_name | No | Filter by contact name (partial match) | |
| contact_type | No | Filter by contact type | |
| customer_sub_type | No | Filter by customer subtype |