SuperAPI AI Directory
Partner中文AI newsFavorites
Skillsfreee-api-skill

freee-api-skill

Office & productivity

View repository

Updated 10-15 20:08

About this skill

freee API Skills

Overview

freee-mcp (MCP server) to integrate with the freee API.

This skill's role:

  • Provide detailed references for the freee API
  • Provide freee-mcp usage guides and API call examples

Note: OAuth authentication must be performed by the user themselves in their own environment.

Setup

1. OAuth Authentication (run in your terminal)

npx freee-mcp configure

Log in to freee in your browser and select a company. The settings are saved to ~/.config/freee-mcp/config.json .

2. Restart and Verify

After restarting Claude, check the authentication status with thefreee_auth_status tool.

Reference

API Reference is references/ are included in . Each reference contains detailed information on parameters, request bodies, and responses.

To find the API you want,references/ search the files in the directory by keyword.

Main references:

  • accounting-deals.md - Deals
  • accounting-expense-applications.md - Expense applications
  • hr-employees.md - Employee information
  • hr-attendances.md - Attendance
  • invoice-invoices.md - Invoices

Usage

MCP Tools

Authentication/Company management:

  • freee_authenticate - OAuth authentication
  • freee_auth_status - Check authentication status
  • freee_clear_auth - Clear authentication information
  • freee_current_user - Get logged-in user information
  • freee_list_companies - List companies
  • freee_set_current_company - Switch companies
  • freee_get_current_company - Get current company

File operations:

  • freee_file_upload - Upload a file to File Box (POST /api/1/receipts)

API calls:

  • freee_api_get - GET request
  • freee_api_post - POST request
  • freee_api_put - PUT request
  • freee_api_delete - DELETE request
  • freee_api_patch - PATCH request
  • freee_api_list_paths - List of available API paths

service parameter (required):

service Description Example path
accounting freee Accounting (deals, accounts, partners, etc.) /api/1/deals
hr freee HR and Labor Management (employees, attendance, etc.) /api/v1/employees
invoice freee Invoicing (invoices, quotes, delivery notes) /invoices
pm freee Time Tracking (projects, man-hours, etc.) /projects
sm freee Sales (quotes, orders, sales, etc.) /businesses

Basic workflow

  1. Check the company: freee_get_current_company to get the current company ID (required the first time. Once obtained within a session, it can be reused thereafter)
  2. Check the recipe: recipes/ Read the relevant recipe in .
  3. Search the reference: As needed, references/ refer to .
  4. Call the API: freee_api_* Use the tool (for endpoints that require company_id, use the value obtained in step 1)

Note:

  • company_id must match the currently configured company. If it does not match, an error will occur.
  • To change the company: First freee_set_current_company switch with , then execute the request.

Recipes

For use case samples and tips for common operations, see below:

  • recipes/expense-application-operations.md - Expense applications
  • recipes/deal-operations.md - Deals (income and expenses)
  • recipes/hr-employee-operations.md - HR and payroll (employees and salaries)
  • recipes/hr-attendance-operations.md - Attendance (clock-in/clock-out, time clocking, break registration)
  • recipes/invoice-operations.md - Invoices, quotes, and delivery notes
  • recipes/receipt-operations.md - File box (uploading and managing supporting document files)
  • recipes/pm-operations.md - Time tracking (projects and actual time records)
  • recipes/pm-workload-registration.md - Safe time tracking registration (PM/HR collaboration workflow)
  • recipes/sm-operations.md - Sales management (deals and orders)

Error handling

  • Authentication error: freee_auth_status check at → freee_clear_auth → freee_authenticate
  • Office error: freee_list_companies → freee_set_current_company
  • Details: recipes/troubleshooting.md reference

About API feature limitations

Issues caused by feature limitations of the freee API itself cannot be resolved by freee-mcp. For details, see recipes/troubleshooting.md .

Related links