freee_get_partners
Retrieve customer and vendor master data from freee Accounting. Supports fuzzy search by name or shortcut and pagination for large datasets.
Instructions
Get list of partners - Retrieves customer/vendor master data efficiently. For partner-based analysis, use profit_loss API with partner breakdown instead of aggregating individual transactions. Cache results as partner data changes infrequently.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| companyId | No | Company ID (optional, uses FREEE_DEFAULT_COMPANY_ID if not provided) | |
| keyword | No | Search keyword: fuzzy matches partner name, formal name, kana name, or exact matches shortcut keys | |
| offset | No | Pagination offset | |
| limit | No | Number of results (1-100) | |
| compact | No | When true, returns summary statistics only without individual records. Useful for quick overviews. |