Back to Details

freee-api-skill

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

freee API スキル

freee API 技能

概要

概要

@him0/freee-mcp (MCP サーバー) を通じて freee API と連携。
このスキルの役割:
  • freee API の詳細リファレンスを提供
  • freee-mcp 使用ガイドと API 呼び出し例を提供
注意: OAuth 認証はユーザー自身が自分の環境で実行する必要があります。
通过@him0/freee-mcp（MCP服务器）与freee API进行联动。
本技能的作用:
  • 提供freee API的详细参考文档
  • 提供freee-mcp使用指南及API调用示例
注意：OAuth认证需要用户在自己的环境中自行执行。

セットアップ

设置步骤

1. OAuth 認証（あなたのターミナルで実行）

1. OAuth认证（在你的终端中执行）

bash
npx @him0/freee-mcp configure
ブラウザで freee にログインし、事業所を選択します。設定は 
~/.config/freee-mcp/config.json
に保存されます。
bash
npx @him0/freee-mcp configure
在浏览器中登录freee，选择对应的企业。设置信息将保存到
~/.config/freee-mcp/config.json
中。

2. プラグインをインストール

2. 安装插件

  • Claude Code: コマンドパレット → "Claude: Install Plugin" → このリポジトリのパス
  • Claude Desktop: 設定 → Plugins → Add Plugin → このリポジトリのパス
  • Claude Code: 命令面板 → "Claude: Install Plugin" → 输入此仓库的路径
  • Claude Desktop: 设置 → Plugins → Add Plugin → 输入此仓库的路径

3. 再起動して確認

3. 重启并验证

Claude を再起動後、
freee_auth_status
ツールで認証状態を確認。
重启Claude后，使用
freee_auth_status
工具确认认证状态。

リファレンス

参考文档

API リファレンスが 
references/
に含まれます。各リファレンスにはパラメータ、リクエストボディ、レスポンスの詳細情報があります。
目的のAPIを探すには、
references/
ディレクトリ内のファイルをキーワード検索してください。
主なリファレンス:
  • accounting-deals.md
    - 取引
  • accounting-expense-applications.md
    - 経費申請
  • hr-employees.md
    - 従業員情報
  • hr-attendances.md
    - 勤怠
  • invoice-invoices.md
    - 請求書
API参考文档包含在
references/
目录中。每个参考文档都包含参数、请求体、响应的详细信息。
如需查找目标API，请在
references/
目录内的文件中进行关键词搜索。
主要参考文档:
  • accounting-deals.md
    - 交易
  • accounting-expense-applications.md
    - 费用申请
  • hr-employees.md
    - 员工信息
  • hr-attendances.md
    - 考勤
  • invoice-invoices.md
    - 发票

使い方

使用方法

MCP ツール

MCP工具

認証・事業所管理:
  • freee_authenticate
    - OAuth 認証
  • freee_auth_status
    - 認証状態確認
  • freee_clear_auth
    - 認証情報クリア
  • freee_current_user
    - ログインユーザー情報取得
  • freee_list_companies
    - 事業所一覧
  • freee_set_current_company
    - 事業所切り替え
  • freee_get_current_company
    - 現在の事業所取得
API 呼び出し:
  • freee_api_get
    - GET リクエスト
  • freee_api_post
    - POST リクエスト
  • freee_api_put
    - PUT リクエスト
  • freee_api_delete
    - DELETE リクエスト
  • freee_api_patch
    - PATCH リクエスト
  • freee_api_list_paths
    - 利用可能なAPIパス一覧
serviceパラメータ (必須):
service説明パス例
accounting
freee会計 (取引、勘定科目、取引先など)
/api/1/deals
hr
freee人事労務 (従業員、勤怠など)
/api/v1/employees
invoice
freee請求書 (請求書、見積書、納品書)
/invoices
pm
freee工数管理 (プロジェクト、工数など)
/api/1/projects
sm
freee販売 (見積、受注、売上など)
/api/1/...
认证・企业管理:
  • freee_authenticate
    - OAuth认证
  • freee_auth_status
    - 认证状态确认
  • freee_clear_auth
    - 清除认证信息
  • freee_current_user
    - 获取登录用户信息
  • freee_list_companies
    - 企业列表
  • freee_set_current_company
    - 切换企业
  • freee_get_current_company
    - 获取当前企业
API调用:
  • freee_api_get
    - GET请求
  • freee_api_post
    - POST请求
  • freee_api_put
    - PUT请求
  • freee_api_delete
    - DELETE请求
  • freee_api_patch
    - PATCH请求
  • freee_api_list_paths
    - 可用API路径列表
service参数（必填）:
service说明路径示例
accounting
freee会计（交易、会计科目、客户等）
/api/1/deals
hr
freee人事劳务（员工、考勤等）
/api/v1/employees
invoice
freee发票（发票、报价单、送货单）
/invoices
pm
freee工时管理（项目、工时等）
/api/1/projects
sm
freee销售（报价、订单、销售额等）
/api/1/...

company_id について

关于company_id

リクエストに 
company_id
を含める場合、現在設定されている事業所（
freee_get_current_company
で確認可能）と一致している必要があります。不一致の場合はエラーになります。
  • 事業所を変更する場合: 先に 
    freee_set_current_company
    で切り替えてからリクエストを実行
  • company_id を含まない API（例: 
    /api/1/companies
    ）: そのまま実行可能
如果请求中包含
company_id
，必须与当前设置的企业（可通过
freee_get_current_company
确认）一致。不一致将导致错误。
  • 如需切换企业：请先通过
    freee_set_current_company
    切换后再执行请求
  • 不包含company_id的API（例如：
    /api/1/companies
    ）：可直接执行

基本ワークフロー

基本工作流程

  1. 操作ガイドを確認: 
    docs/
    内の該当ガイドを読む
  2. リファレンスを検索: 必要に応じて 
    references/
    を参照
  3. API を呼び出す: 
    freee_api_*
    ツールを使用
  1. 查看操作指南：阅读
    docs/
    目录内的对应指南
  2. 搜索参考文档：根据需要参考
    references/
    目录
  3. 调用API：使用
    freee_api_*
    工具

操作ガイド

操作指南

よくある操作の使用例とTipsは以下を参照:
  • docs/expense-application-operations.md
    - 経費申請
  • docs/deal-operations.md
    - 取引（収入・支出）
  • docs/hr-operations.md
    - 人事労務（従業員・勤怠）
  • docs/invoice-operations.md
    - 請求書・見積書・納品書
常见操作的使用示例及技巧请参考以下内容：
  • docs/expense-application-operations.md
    - 费用申请
  • docs/deal-operations.md
    - 交易（收入・支出）
  • docs/hr-operations.md
    - 人事劳务（员工・考勤）
  • docs/invoice-operations.md
    - 发票・报价单・送货单

エラー対応

故障排除

  • 認証エラー: 
    freee_auth_status
    で確認 → 
    freee_clear_auth
    → 
    freee_authenticate
  • 事業所エラー: 
    freee_list_companies
    → 
    freee_set_current_company
  • 詳細: 
    docs/troubleshooting.md
    参照
  • 认证错误：使用
    freee_auth_status
    确认 → 
    freee_clear_auth
    清除认证 → 
    freee_authenticate
    重新认证
  • 企业错误：使用
    freee_list_companies
    查看企业列表 → 
    freee_set_current_company
    切换企业
  • 详细内容：请参考
    docs/troubleshooting.md

対応 API

支持的API

serviceベースURLパス形式
accounting
https://api.freee.co.jp
/api/1/...
hr
https://api.freee.co.jp/hr
/api/v1/...
invoice
https://api.freee.co.jp/iv
/invoices
, 
/quotations
, 
/delivery_slips
pm
https://api.freee.co.jp/pm
/api/1/...
sm
https://api.freee.co.jp/sm
/api/1/...
service基础URL路径格式
accounting
https://api.freee.co.jp
/api/1/...
hr
https://api.freee.co.jp/hr
/api/v1/...
invoice
https://api.freee.co.jp/iv
/invoices
, 
/quotations
, 
/delivery_slips
pm
https://api.freee.co.jp/pm
/api/1/...
sm
https://api.freee.co.jp/sm
/api/1/...

請求書 API について

关于发票API

請求書・見積書・納品書の操作については 
docs/invoice-operations.md
を参照してください。
注意: 会計 API の 
/api/1/invoices
は過去の API であり、現在は請求書 API (
service: "invoice"
) を使用してください。
发票、报价单、送货单的操作请参考
docs/invoice-operations.md
。
注意：会计API的
/api/1/invoices
是旧版API，当前请使用发票API（
service: "invoice"
）。

関連リンク

相关链接