
Freee Api Skill
- 11 installs
- 4 repo stars
- Updated July 31, 2026
- kimny1143/claude-code-template
Helps with backend & apis tasks.
About
freee-api-skill is a Claude Code skill for backend & apis. It helps solo builders move faster with AI-assisted development.
- freee-api-skill
- Backend & APIs
- AI-coding skill
Freee Api Skill by the numbers
- 11 all-time installs (skills.sh)
- Ranked #3,562 of 4,348 Backend & APIs skills by installs in the Skillselion catalog
- Data as of Aug 2, 2026 (Skillselion catalog sync)
npx skills add https://github.com/kimny1143/claude-code-template --skill freee-api-skillAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 11 |
|---|---|
| repo stars | ★ 4 |
| Last updated | July 31, 2026 |
| Repository | kimny1143/claude-code-template ↗ |
What it does
Helps with backend & apis tasks.
Files
freee API スキル
概要
freee-mcp (MCP サーバー) を通じて freee API と連携。
このスキルの役割:
- freee API の詳細リファレンスを提供
- freee-mcp 使用ガイドと API 呼び出し例を提供
注意: OAuth 認証はユーザー自身が自分の環境で実行する必要があります。
セットアップ
1. OAuth 認証(あなたのターミナルで実行)
npx freee-mcp configureブラウザで freee にログインし、事業所を選択します。設定は ~/.config/freee-mcp/config.json に保存されます。
2. 再起動して確認
Claude を再起動後、freee_auth_status ツールで認証状態を確認。
リファレンス
API リファレンスが references/ に含まれます。各リファレンスにはパラメータ、リクエストボディ、レスポンスの詳細情報があります。
目的のAPIを探すには、references/ ディレクトリ内のファイルをキーワード検索してください。
主なリファレンス:
accounting-deals.md- 取引accounting-expense-applications.md- 経費申請hr-employees.md- 従業員情報hr-attendances.md- 勤怠invoice-invoices.md- 請求書
使い方
MCP ツール
認証・事業所管理:
freee_authenticate- OAuth 認証freee_auth_status- 認証状態確認freee_clear_auth- 認証情報クリアfreee_current_user- ログインユーザー情報取得freee_list_companies- 事業所一覧freee_set_current_company- 事業所切り替えfreee_get_current_company- 現在の事業所取得
ファイル操作:
freee_file_upload- ファイルボックスにファイルをアップロード (POST /api/1/receipts)
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工数管理 (プロジェクト、工数など) | /projects |
sm | freee販売 (見積、受注、売上など) | /businesses |
基本ワークフロー
1. 事業所を確認: freee_get_current_company で現在の事業所IDを取得する(初回は必須。セッション内で1回取得すれば以降は使い回せる) 2. レシピを確認: recipes/ 内の該当レシピを読む 3. リファレンスを検索: 必要に応じて references/ を参照 4. API を呼び出す: freee_api_* ツールを使用(company_id が必要なエンドポイントでは手順1で取得した値を使う)
注意:
company_idは現在設定されている事業所と一致している必要がある。不一致の場合はエラーになる- 事業所を変更する場合: 先に
freee_set_current_companyで切り替えてからリクエストを実行
レシピ
よくある操作のユースケースサンプルとTipsは以下を参照:
recipes/expense-application-operations.md- 経費申請recipes/deal-operations.md- 取引(収入・支出)recipes/hr-employee-operations.md- 人事労務(従業員・給与)recipes/hr-attendance-operations.md- 勤怠(出退勤・打刻・休憩の登録)recipes/invoice-operations.md- 請求書・見積書・納品書recipes/receipt-operations.md- ファイルボックス(証憑ファイルのアップロード・管理)recipes/pm-operations.md- 工数管理(プロジェクト・工数実績)recipes/pm-workload-registration.md- 工数の安全な登録(PM・HR連携ワークフロー)recipes/sm-operations.md- 販売管理(案件・受注)
エラー対応
- 認証エラー:
freee_auth_statusで確認 →freee_clear_auth→freee_authenticate - 事業所エラー:
freee_list_companies→freee_set_current_company - 詳細:
recipes/troubleshooting.md参照
API の機能制限について
freee API 自体の機能制限に起因する問題は freee-mcp では解決できません。詳細は recipes/troubleshooting.md を参照してください。
関連リンク
取引(収入・支出)の操作
freee会計APIを使った取引の登録・検索ガイド。
概要
取引APIを使って収入・支出の記録、検索、更新を行います。
利用可能なパス
| パス | 説明 |
|---|---|
/api/1/deals | 取引一覧・作成 |
/api/1/deals/{id} | 取引詳細・更新・削除 |
/api/1/deals/{id}/payments | 支払行の作成 |
/api/1/deals/{id}/renews | +更新行の作成 |
使用例
取引一覧を取得
freee_api_get {
"service": "accounting",
"path": "/api/1/deals",
"query": {
"limit": 10
}
}期間で絞り込み
freee_api_get {
"service": "accounting",
"path": "/api/1/deals",
"query": {
"start_issue_date": "2025-01-01",
"end_issue_date": "2025-01-31",
"type": "expense"
}
}支出を作成(未決済)
freee_api_post {
"service": "accounting",
"path": "/api/1/deals",
"body": {
"company_id": 123456,
"issue_date": "2025-01-15",
"type": "expense",
"details": [
{
"account_item_id": 101,
"tax_code": 1,
"amount": 10000,
"description": "消耗品購入"
}
]
}
}支出を作成(決済済み)
freee_api_post {
"service": "accounting",
"path": "/api/1/deals",
"body": {
"company_id": 123456,
"issue_date": "2025-01-15",
"type": "expense",
"details": [
{
"account_item_id": 101,
"tax_code": 1,
"amount": 10000,
"description": "消耗品購入"
}
],
"payments": [
{
"amount": 10000,
"from_walletable_type": "wallet",
"from_walletable_id": 1,
"date": "2025-01-15"
}
]
}
}Tips
作成後のWeb確認URL
取引を作成した後、以下のURLでWeb画面から確認できます:
https://secure.freee.co.jp/deals#deal_id={id}{id} は API レスポンスで返される取引ID(deal.id)を使用します。
収支区分
| type | 説明 |
|---|---|
income | 収入 |
expense | 支出 |
決済状況
| status | 説明 |
|---|---|
unsettled | 未決済 |
settled | 完了 |
口座区分(from_walletable_type)
| 値 | 説明 |
|---|---|
bank_account | 銀行口座 |
credit_card | クレジットカード |
wallet | 現金 |
private_account_item | プライベート資金 |
関連API
取引作成時に必要なマスタ情報:
/api/1/account_items- 勘定科目一覧/api/1/taxes- 税区分一覧/api/1/walletables- 口座一覧/api/1/partners- 取引先一覧
リファレンス
詳細なAPIパラメータは references/accounting-deals.md を参照。
経費申請の操作
freee会計APIを使った経費申請のガイド。
概要
経費精算APIを使って経費申請の作成・取得・承認操作を行います。
利用可能なパス
| パス | 説明 |
|---|---|
/api/1/expense_applications | 経費申請一覧・作成 |
/api/1/expense_applications/{id} | 経費申請詳細・更新・削除 |
/api/1/expense_application_line_templates | 経費科目一覧 |
使用例
経費申請一覧を取得
freee_api_get {
"service": "accounting",
"path": "/api/1/expense_applications",
"query": {
"limit": 10
}
}経費申請を作成
freee_api_post {
"service": "accounting",
"path": "/api/1/expense_applications",
"body": {
"company_id": 123456,
"title": "交通費",
"issue_date": "2025-01-15",
"expense_application_lines": [
{
"transaction_date": "2025-01-15",
"description": "新宿→渋谷",
"amount": 400
}
]
}
}経費科目一覧を取得
経費申請作成時に使用する経費科目IDを確認:
freee_api_get {
"service": "accounting",
"path": "/api/1/expense_application_line_templates"
}Tips
作成後のWeb確認URL
経費申請を作成した後、以下のURLでWeb画面から確認できます:
https://secure.freee.co.jp/expense_applications/{id}{id} は API レスポンスで返される経費申請ID(expense_application.id)を使用します。
申請ステータス
| status | 説明 |
|---|---|
draft | 下書き |
in_progress | 申請中 |
approved | 承認済 |
rejected | 却下 |
feedback | 差戻し |
取引ステータス(承認後)
| deal_status | 説明 |
|---|---|
unsettled | 清算待ち |
settled | 精算済み |
注意点
- 申請経路に部門役職データ連携を使用している経費申請はAPI経由で作成・更新できません
- 申請の削除は下書き・差戻し状態の場合のみ可能
- 領収書添付が必要な場合はファイルボックスAPIと連携
リファレンス
詳細なAPIパラメータは references/accounting-expense-applications.md を参照。
勤怠の操作
freee人事労務APIを使った勤怠管理ガイド。
利用可能なパス
| パス | 説明 |
|---|---|
/api/v1/employees/{id}/work_records/{date} | 勤怠記録(GET/PUT/DELETE) |
/api/v1/employees/{id}/time_clocks | 打刻(POST) |
/api/v1/employees/{id}/work_record_summaries/{year}/{month} | 勤怠サマリ(GET) |
使用例
勤怠記録を取得
freee_api_get {
"service": "hr",
"path": "/api/v1/employees/{employee_id}/work_records/2025-01-15",
"query": { "company_id": 123456 }
}is_editable: true であれば更新可能です。
打刻を登録
freee_api_post {
"service": "hr",
"path": "/api/v1/employees/{employee_id}/time_clocks",
"body": {
"company_id": 123456,
"type": "clock_in",
"datetime": "2025-01-15T09:00:00+09:00"
}
}出退勤時刻と休憩時間を登録・更新
work_record_segments で出退勤時刻、break_records で休憩時間を指定します。
freee_api_put {
"service": "hr",
"path": "/api/v1/employees/{employee_id}/work_records/2025-01-15",
"body": {
"company_id": 123456,
"work_record_segments": [
{
"clock_in_at": "2025-01-15 10:40:00",
"clock_out_at": "2025-01-15 20:15:00"
}
],
"break_records": [
{
"clock_in_at": "2025-01-15 12:00:00",
"clock_out_at": "2025-01-15 13:00:00"
}
]
}
}- 時刻はJST(
+09:00)として扱われる(タイムゾーン省略可) break_recordsを空配列にすると休憩なしになる- 複数回の出退勤がある場合は
work_record_segmentsに複数要素を指定する - 既に登録済みの勤怠も同じAPIで上書き更新できる
Tips
打刻タイプ
| type | 説明 |
|---|---|
clock_in | 出勤 |
clock_out | 退勤 |
break_begin | 休憩開始 |
break_end | 休憩終了 |
self_only 権限について
/api/v1/employees は管理者権限が必要ですが、/api/v1/users/me で自分の employee_id を取得すれば、自分の勤怠は操作可能です。
freee_api_get {
"service": "hr",
"path": "/api/v1/users/me",
"query": { "company_id": 123456 }
}レスポンスの companies[].employee_id が自分の従業員IDです。
リファレンス
references/hr-attendances.md- 勤怠API詳細references/hr-time-clocks.md- 打刻API詳細
従業員・給与の操作
freee人事労務APIを使った従業員・勤怠管理ガイド。
概要
人事労務APIを使って従業員情報の取得、勤怠データの管理を行います。
利用可能なパス
従業員関連
| パス | 説明 |
|---|---|
/api/v1/employees | 従業員一覧(対象年月指定) |
/api/v1/companies/{company_id}/employees | 全期間の従業員一覧 |
/api/v1/employees/{id} | 従業員詳細 |
給与関連
| パス | 説明 |
|---|---|
/api/v1/payroll_statements | 給与明細一覧 |
/api/v1/bonus_statements | 賞与明細一覧 |
使用例
従業員一覧を取得
対象年月を指定して取得:
freee_api_get {
"service": "hr",
"path": "/api/v1/employees",
"query": {
"year": 2025,
"month": 1
}
}全期間の従業員一覧を取得
退職者も含めて取得:
freee_api_get {
"service": "hr",
"path": "/api/v1/companies/123456/employees"
}給与明細一覧を取得
freee_api_get {
"service": "hr",
"path": "/api/v1/payroll_statements",
"query": {
"year": 2025,
"month": 1
}
}Tips
作成後のWeb確認URL
人事労務の各画面は以下のURLで確認できます:
| 種類 | URL形式 |
|---|---|
| 従業員詳細 | https://p.secure.freee.co.jp/employees/{id} |
翌月払いの従業員情報取得
締め日支払い日設定が翌月払いの場合、指定month + 1の従業員情報が返されます。
例: 2025年1月の情報を取得する場合
freee_api_get {
"service": "hr",
"path": "/api/v1/employees",
"query": {
"year": 2024,
"month": 12
}
}注意点
- 管理者権限を持ったユーザーのみ実行可能なAPIが多い
- 指定年月に退職済みのユーザーは
/api/v1/employeesでは取得できない - 全期間取得が必要な場合は
/api/v1/companies/{company_id}/employeesを使用
リファレンス
詳細なAPIパラメータは以下を参照:
references/hr-employees.md- 従業員references/hr-payroll-statements.md- 給与明細
請求書・見積書・納品書の操作
freee請求書APIを使った帳票操作のガイド。
概要
請求書 API は https://api.freee.co.jp/iv をベースとした独立した API です。
注意: 会計 API の /api/1/invoices は過去の API であり、現在は請求書 API (service: "invoice") を使用してください。
利用可能なパス
| パス | 説明 |
|---|---|
/invoices | 請求書一覧 |
/invoices/{id} | 請求書詳細 |
/quotations | 見積書一覧 |
/quotations/{id} | 見積書詳細 |
/delivery_slips | 納品書一覧 |
/delivery_slips/{id} | 納品書詳細 |
注意: company_id は必須
請求書APIの一覧取得(GET)では、クエリパラメータに company_id が必須です。省略すると認証エラーになります。 作成(POST)でもリクエストボディに company_id が必須です。
使用例
請求書一覧を取得:
freee_api_get {
"service": "invoice",
"path": "/invoices",
"query": { "company_id": 123456 }
}請求書を作成:
freee_api_post {
"service": "invoice",
"path": "/invoices",
"body": {
"company_id": 123456,
"billing_date": "2025-01-15",
"partner_id": 789,
"partner_title": "御中",
"tax_entry_method": "out",
"tax_fraction": "omit",
"withholding_tax_entry_method": "out",
"lines": [
{
"description": "コンサルティング費用",
"quantity": 1,
"unit_price": "100000",
"tax_rate": 10
}
]
}
}Tips
作成後のWeb確認URL
請求書・見積書・納品書を作成・更新した後、以下のURLでWeb画面から確認できます:
| 種類 | URL形式 |
|---|---|
| 請求書 | https://invoice.secure.freee.co.jp/reports/invoices/{id} |
| 見積書 | https://invoice.secure.freee.co.jp/reports/quotations/{id} |
| 納品書 | https://invoice.secure.freee.co.jp/reports/delivery_slips/{id} |
{id} は API レスポンスで返されるID(invoice.idなど)を使用します。
例: 請求書ID 49034614 の場合
https://invoice.secure.freee.co.jp/reports/invoices/49034614作成完了時にこのURLをユーザーに提示すると、すぐにWeb画面で内容を確認できます。
リファレンス
詳細なAPIパラメータは以下を参照:
references/invoice-invoices.md- 請求書APIreferences/invoice-quotations.md- 見積書APIreferences/invoice-delivery-slips.md- 納品書API
工数管理の操作
freee工数管理APIを使ったプロジェクト・工数の管理ガイド。
重要: company_id の指定方法
すべてのエンドポイントで company_id が必須です。
- GETリクエスト:
queryにcompany_idを含める - POSTリクエスト:
bodyにcompany_idを含める
利用可能なパス
| パス | メソッド | 説明 |
|---|---|---|
/projects | GET, POST | プロジェクト一覧・作成 |
/projects/{id} | GET, PUT, DELETE, PATCH | プロジェクト詳細・更新・削除 |
/workloads | GET, POST | 工数実績一覧・登録 |
/workload_summaries | GET | 工数サマリ取得 |
/people | GET | 従業員一覧(payroll_employee_id でHR連携可) |
/teams | GET | チーム一覧 |
/partners | GET | 取引先一覧 |
/unit_costs | GET | 単価マスタ |
/users/me | GET | ログインユーザー情報 |
使用例
プロジェクト一覧を取得
freee_api_get {
"service": "pm",
"path": "/projects",
"query": {
"company_id": 123456
}
}プロジェクトを作成
freee_api_post {
"service": "pm",
"path": "/projects",
"body": {
"company_id": 123456,
"name": "新規プロジェクト",
"code": "PJ-001",
"from_date": "2025-04-01",
"thru_date": "2025-12-31",
"pm_budgets_cost": 5000
}
}工数を登録
freee_api_post {
"service": "pm",
"path": "/workloads",
"body": {
"company_id": 123456,
"project_id": 1,
"date": "2025-03-10",
"minutes": 120,
"memo": "設計作業"
}
}工数実績を取得
freee_api_get {
"service": "pm",
"path": "/workloads",
"query": {
"company_id": 123456,
"year_month": "2025-03"
}
}工数サマリを取得
freee_api_get {
"service": "pm",
"path": "/workload_summaries",
"query": {
"company_id": 123456,
"year_month": "2025-03"
}
}Tips
運用ステータス
| 値 | 説明 |
|---|---|
planning | 計画中 |
awaiting_approval | 承認待ち |
in_progress | 進行中 |
rejected | 却下 |
done | 完了 |
従業員スコープ(workloads/workload_summaries)
| 値 | 説明 |
|---|---|
all | 全従業員 |
team | チーム単位(team_ids で絞り込み) |
employee | 従業員単位(person_ids で絞り込み) |
| 未指定 | ログインユーザーのみ |
人事労務APIとの連携
/people レスポンスの payroll_employee_id が人事労務側の employee_id に対応します。 安全な工数登録ワークフロー(勤怠チェック・重複確認・承認フロー)については recipes/pm-workload-registration.md を参照してください。
リファレンス
詳細なAPIパラメータは以下を参照:
references/pm-projects.md- プロジェクトreferences/pm-workloads.md- 工数実績references/pm-people.md- 従業員references/pm-teams.md- チームreferences/pm-partners.md- 取引先references/pm-unit-costs.md- 単価references/pm-users.md- ログインユーザー
工数の安全な登録(PM・HR連携ワークフロー)
freee工数管理と人事労務APIを連携した安全な工数登録ワークフロー。 勤怠チェック・重複確認・ユーザー承認を経て工数を登録します。
概要
工数登録を単独で行うと以下のリスクがあります:
- 休日に工数を登録してしまう
- 有給取得日に工数を登録してしまう
- 既に登録済みの工数と重複する
- 締め済みの日に登録を試みてエラーになる
このレシピでは、人事労務APIの勤怠情報を事前確認し、 ユーザーの承認を得てから登録することで、安全に工数登録を行います。
工数APIの基本操作は recipes/pm-operations.md、 勤怠APIの基本操作は recipes/hr-attendance-operations.md を参照してください。
ワークフロー
Step 1: ユーザーID解決
PM側の person_id と HR側の employee_id を紐付けます。
1-1. PM側のログインユーザー情報を取得
freee_api_get {
"service": "pm",
"path": "/users/me"
}レスポンスの companies[].person_me.id がPM側の person_id です。 companies[].id から対象の company_id も確認できます。
1-2. HR側の employee_id を取得
方法A: PM /people の payroll_employee_id を使う
freee_api_get {
"service": "pm",
"path": "/people",
"query": {
"company_id": 123456,
"person_ids[]": [1]
}
}レスポンスの people[].payroll_employee_id が HR の employee_id に対応します。
方法B: HR /api/v1/users/me から直接取得
freee_api_get {
"service": "hr",
"path": "/api/v1/users/me",
"query": {
"company_id": 123456
}
}レスポンスの companies[].employee_id が HR の employee_id です。 payroll_employee_id が null の場合はこちらを使ってください。
self_only 権限の詳細は recipes/hr-attendance-operations.md の「self_only 権限について」を参照してください。
Step 2: 勤怠情報の事前確認
対象日の勤怠記録を取得して、工数登録が可能かチェックします。
freee_api_get {
"service": "hr",
"path": "/api/v1/employees/{employee_id}/work_records/2025-03-10",
"query": {
"company_id": 123456
}
}レスポンスのフィールドを「安全チェック一覧」テーブルに基づいて確認し、すべてのチェックを通過した場合のみ次のステップに進みます。 勤怠APIの詳細は recipes/hr-attendance-operations.md を参照してください。
Step 3: 既存工数の重複チェック
PM GET /workloads で対象月の既存工数を取得し、同じ日・同じプロジェクトに登録済みでないか確認します(工数取得の例は recipes/pm-operations.md 参照)。
Step 4: ユーザー承認(Human-in-the-Loop)
以下の情報をユーザーに提示し、承認を得てから登録を実行します。
提示する情報:
- 登録対象日: YYYY-MM-DD
- 勤怠状態: 所定労働日 / 出勤済み(Step 2 の結果)
- 対象プロジェクト: プロジェクト名
- 登録時間: XX分(X時間XX分)
- 業務内容: メモ
- 既存工数: なし、または既存の一覧(Step 3 の結果)
ユーザーが承認したら Step 5 へ進みます。
Step 5: 工数登録の実行
PM POST /workloads で工数を登録します(登録例は recipes/pm-operations.md 参照)。
Step 6: 登録結果の検証
PM GET /workloads で登録した工数を取得し、日・プロジェクト・時間が正しいことを確認してユーザーに報告します。
安全チェック一覧
| チェック項目 | API | 確認フィールド | ブロック条件 |
|---|---|---|---|
| 休日チェック | HR work_records | day_pattern | prescribed_holiday, legal_holiday |
| 欠勤チェック | HR work_records | is_absence | true |
| 有給チェック | HR work_records | paid_holidays | 配列が空でない |
| 締め済みチェック | HR work_records | is_editable | false |
| 重複チェック | PM workloads | 同日・同プロジェクト | 既存レコードあり |
Tips
一括登録のパターン
複数日分の工数を一括登録する場合は、各日ごとに Step 2〜4 を繰り返します。 安全チェックでブロック条件に該当した日はスキップし、ユーザーに報告してください。
権限に関する注意
- 管理者権限がない場合、他の従業員の勤怠情報は取得できません(self_only 制約)
- 自分の工数登録のみであれば self_only 権限で実行可能です
- 他者の工数を登録する場合は管理者権限が必要です
リファレンス
references/pm-workloads.md- 工数実績API詳細references/pm-people.md- 従業員(payroll_employee_id)references/pm-users.md- ログインユーザーreferences/hr-attendances.md- 勤怠API詳細recipes/pm-operations.md- 工数管理の基本操作recipes/hr-attendance-operations.md- 勤怠の操作
ファイルボックス(証憑ファイル)の操作
freee会計APIとカスタムツールを使ったファイルボックスの操作ガイド。
概要
ファイルボックスAPIを使って証憑ファイル(レシート・請求書等)のアップロード・検索・更新を行います。
利用可能なパス
| パス | 説明 |
|---|---|
/api/1/receipts | 証憑ファイル一覧・アップロード |
/api/1/receipts/{id} | 証憑ファイル詳細・更新・削除 |
/api/1/receipts/{id}/download | 証憑ファイルのダウンロード |
ファイルアップロード
カスタムツール freee_file_upload を使う(推奨)
ローカルファイルをファイルボックスにアップロードするには、カスタムツール freee_file_upload を使います。 APIの POST /api/1/receipts は multipart/form-data が必要なため、通常の freee_api_post では利用できません。
freee_file_upload {
"file_path": "/path/to/receipt.jpg",
"document_type": "receipt",
"description": "ファミリーマート レシート",
"receipt_metadatum_amount": 460,
"receipt_metadatum_issue_date": "2024-09-29",
"receipt_metadatum_partner_name": "ファミリーマート"
}パラメータ:
| 名前 | 必須 | 説明 |
|---|---|---|
| file_path | はい | アップロードするファイルのローカルパス |
| document_type | いいえ | 書類の種類: receipt(領収書), invoice(請求書), other(その他) |
| description | いいえ | メモ(最大255文字) |
| receipt_metadatum_amount | いいえ | 金額 |
| receipt_metadatum_issue_date | いいえ | 発行日 (yyyy-mm-dd) |
| receipt_metadatum_partner_name | いいえ | 取引先名(最大255文字) |
| qualified_invoice | いいえ | 適格請求書等: qualified, not_qualified, unselected |
使用例
証憑ファイル一覧を取得
freee_api_get {
"service": "accounting",
"path": "/api/1/receipts",
"query": {
"start_date": "2025-01-01",
"end_date": "2025-01-31"
}
}特定の証憑ファイルを取得
freee_api_get {
"service": "accounting",
"path": "/api/1/receipts/432228305"
}証憑ファイルのメタ情報を更新
freee_api_put {
"service": "accounting",
"path": "/api/1/receipts/432228305",
"body": {
"description": "ファミリーマート 一の橋店 レシート",
"receipt_metadatum": {
"partner_name": "ファミリーマート",
"issue_date": "2024-09-29",
"amount": 460
},
"document_type": "receipt"
}
}証憑ファイルを削除
freee_api_delete {
"service": "accounting",
"path": "/api/1/receipts/432228305"
}Tips
アップロード後のWeb確認URL
ファイルをアップロードした後、以下のURLでWeb画面から確認できます:
https://secure.freee.co.jp/receipts/{id}{id} は API レスポンスで返されるファイルボックスID(receipt.id)を使用します。
アップロード制限
- ファイルサイズ: 64MBまで
- 月間アップロード容量: 合計10GBまで
- 1分間あたりのアップロード数: 300ファイルまで
- プランによる月間アップロード数制限あり
書類の種類(document_type)
| 値 | 説明 |
|---|---|
receipt | 領収書 |
invoice | 請求書 |
other | その他 |
ステータス
| 値 | 説明 |
|---|---|
confirmed | 確認済み |
deleted | 削除済み |
ignored | 無視 |
カテゴリ(一覧取得時のフィルタ)
| 値 | 説明 |
|---|---|
all | すべて |
without_deal | 未登録 |
with_expense_application_line | 経費申請中 |
with_deal | 登録済み |
ignored | 無視 |
リファレンス
詳細なAPIパラメータは references/accounting-receipts.md を参照。
販売管理の操作
freee販売APIを使った案件・受注の管理ガイド。
重要: company_id の指定方法
データ作成時に company_id が必須です。
- POSTリクエスト:
bodyにcompany_idを含める
利用可能なパス
| パス | 説明 |
|---|---|
/businesses | 案件一覧・作成 |
/businesses/{id} | 案件詳細・更新 |
/sales_orders | 受注一覧・作成 |
/sales_orders/{id} | 受注詳細・更新 |
使用例
案件一覧を取得
freee_api_get {
"service": "sm",
"path": "/businesses"
}案件詳細を取得
freee_api_get {
"service": "sm",
"path": "/businesses/1"
}案件を作成
freee_api_post {
"service": "sm",
"path": "/businesses",
"body": {
"company_id": 123456,
"name": "新規案件"
}
}案件を更新
freee_api_patch {
"service": "sm",
"path": "/businesses/1",
"body": {
"name": "案件名変更",
"internal_memo": "メモ更新"
}
}受注一覧を取得
freee_api_get {
"service": "sm",
"path": "/sales_orders"
}受注詳細を取得
freee_api_get {
"service": "sm",
"path": "/sales_orders/1"
}受注を作成
freee_api_post {
"service": "sm",
"path": "/sales_orders",
"body": {
"company_id": 123456,
"sales_order_date": "2025-03-10",
"customer_id": 1,
"billing_partner_id": 1,
"collecting_partner_id": 1,
"lines": [
{
"name": "商品A",
"unit_price": 10000,
"quantity": 1
}
]
}
}Tips
案件の更新可能項目
| 項目 | 説明 |
|---|---|
name | 案件名称 |
code | 案件コード |
business_date | 案件登録日 |
charge_employee_id | 社内担当者の従業員ID |
customer_id | 顧客の取引先ID |
prospect_sales_order | 受注見込 |
sales_progression_id | 受注確度ID |
scheduled_completion_date | 完了予定日 |
completion_date | 完了日 |
business_phase_id | 案件フェーズID |
reporting_section_id | 担当部門ID |
internal_memo | 社内メモ |
受注の必須項目
| 項目 | 説明 |
|---|---|
sales_order_date | 受注日 |
customer_id | 顧客の取引先ID |
billing_partner_id | 請求先の取引先ID |
collecting_partner_id | 入金元の取引先ID |
lines | 明細リスト |
関連API
マスタ情報の取得:
references/sm-master.md- マスタ情報(テンプレート等)
リファレンス
詳細なAPIパラメータは以下を参照:
references/sm-businesses.md- 案件references/sm-sales-orders.md- 受注references/sm-master.md- マスタ
トラブルシューティング
freee API スキル使用時の一般的な問題と解決方法。
認証関連
問題: "401 Unauthorized"
原因: 認証トークンの有効期限切れ
解決方法:
freee_authenticate再認証後、再度操作を実行してください。
問題: "403 Forbidden"
原因: 必要な権限がない、またはレートリミット
解決方法:
1. freee 開発者ポータルでアプリケーションの権限を確認 2. 必要な権限が有効化されているか確認 3. 権限を追加した場合は再認証が必要
freee_clear_auth
freee_authenticateレートリミットの場合は数分待ってから再試行してください。
問題: OAuth 認証画面が表示されない
原因: ブラウザがブロックしている可能性
解決方法:
1. ポップアップブロックを一時的に無効化 2. 手動でコールバック URL にアクセス 3. 別のブラウザを試す
事業所関連
問題: "Company not found"
原因: 指定した事業所 ID が存在しないか、アクセス権限がない
解決方法:
# 利用可能な事業所を確認
freee_list_companies
# 正しい事業所IDを設定
freee_set_current_company { "company_id": 12345 }問題: 事業所を切り替えたい
解決方法:
freee_list_companies
freee_set_current_company { "company_id": 12345 }
freee_get_current_company # 切り替わったことを確認問題: 複数事業所がある場合どれを選ぶべきか
解決方法:
- 操作したい事業所を選択
- 不明な場合は経理部門に確認
freee_list_companiesで事業所の説明を確認
問題: "company_id の不整合"
原因: リクエストに含まれる company_id と、現在設定されている事業所が異なる
解決方法:
# 現在の事業所を確認
freee_get_current_company
# 方法1: 事業所を切り替える
freee_set_current_company { "company_id": 12345 }
# 方法2: リクエストの company_id を現在の事業所に合わせる注意: company_id を含むリクエストは、必ず現在の事業所と一致している必要があります。
工数管理・販売API関連
問題: freee工数管理またはfreee販売APIで "500 Internal Server Error"
原因: company_id がリクエストに含まれていない
解決方法: recipes/pm-operations.md および recipes/sm-operations.md の company_id 指定方法を参照。
経費申請作成時のエラー
問題: "expense_application_line_template_id が無効"
原因: 指定した経費科目 ID が存在しない、または事業所で無効化されている
解決方法:
# 有効な経費科目IDを確認
freee_api_get {
"service": "accounting",
"path": "/api/1/expense_application_line_templates"
}詳細: 各事業所で利用可能な経費科目は異なります。必ず事前に確認してください。
問題: "amount must be positive"
原因: 金額が 0 以下または数値でない
解決方法: 正の整数を指定
"amount": 5000 // 正しい
"amount": -100 // 負の数 - NG
"amount": 0 // ゼロ - NG
"amount": "5000" // 文字列 - NG(JSONでは整数で指定)
"amount": 5000.5 // 小数 - NG(整数のみ)問題: "Invalid date format"
原因: 日付形式が不正
解決方法: "yyyy-mm-dd" 形式を使用
"transaction_date": "2025-10-19" // 正しい
"transaction_date": "10/19/2025" // NG - スラッシュ区切り
"transaction_date": "2025-10-19T00:00:00Z" // NG - 時刻部分は不要
"transaction_date": "20251019" // NG - ハイフンなし問題: "issue_date must be after transaction_date"
原因: 申請日が発生日より前
解決方法: 申請日を発生日以降に設定
"transaction_date": "2025-10-15", // 発生日
"issue_date": "2025-10-19" // 申請日は発生日以降注意: 通常、申請日は「今日」または発生日以降の日付を指定します。
問題: "title is required"
原因: 申請タイトルが空または未設定
解決方法: わかりやすいタイトルを設定
"title": "2025年10月 東京出張経費" // 具体的で推奨
"title": "経費申請" // 抽象的だが可
"title": "" // 空文字 - NG問題: "expense_application_lines is required"
原因: 経費明細が空または未設定
解決方法: 少なくとも 1 つの経費明細を含める
{
"expense_application_lines": [
{
"expense_application_line_template_id": 1001,
"amount": 5000,
"transaction_date": "2025-10-19"
}
]
}問題: "section_id が無効"
原因: 指定した部門 ID が存在しない
解決方法:
# 部門一覧を確認
freee_api_get {
"service": "accounting",
"path": "/api/1/sections"
}問題: 申請作成後に内容を確認したい
解決方法:
# 最近の申請を確認
freee_api_get {
"service": "accounting",
"path": "/api/1/expense_applications",
"query": { "limit": 10 }
}Web画面での確認: https://secure.freee.co.jp/expense_applications/{id}
データ取得時の問題
問題: 経費科目一覧が取得できない
原因:
- company_id が未設定または不正
- 権限がない
解決方法:
# 現在の事業所を確認
freee_get_current_company
# 経費科目を取得
freee_api_get {
"service": "accounting",
"path": "/api/1/expense_application_line_templates"
}問題: "経費科目が多すぎてどれを選べばいいかわからない"
解決方法:
1. 経費科目の name と description を確認 2. 一般的な科目:
- 交通費: 電車、バス、タクシー
- 宿泊費: ホテル、旅館
- 接待交際費: 会食、接待
- 消耗品費: 文房具、備品
3. 不明な場合は経理部門に確認
パフォーマンス関連
問題: レスポンスが遅い
原因:
- 大量のデータを取得している
- ネットワークの問題
解決方法:
limitパラメータで取得件数を制限- 必要なデータのみ取得するよう条件を絞る
よくある質問
Q: 経費申請を下書き保存できますか?
A: freee API では、申請作成時に自動的に申請されます。下書き保存したい場合は、ローカルでデータを保存しておき、後で API を実行してください。
Q: 領収書画像を添付できますか?
A: ファイルボックス API (/api/1/receipts) を使用して証憑をアップロードし、receipt_ids で経費申請や取引に紐づけることができます。
Q: 作成した申請を修正できますか?
A: 下書き・差戻し状態の経費申請は PUT API で更新できます。申請中・承認済みの場合は freee Web UI を使用してください。
Q: 複数の経費をまとめて申請すべきですか?
A: 以下を考慮してください:
- 同じ出張: まとめる(例: 交通費+宿泊費)
- 同じ月の交通費: まとめることが多い
- 異なる種類の経費: 別々に申請することを推奨
- 会社の方針に従ってください
API の機能制限に関する問題
freee API 自体が対応していない操作については、freee-mcp(クライアント)側では解決できません。
以下のようなケースは API の機能制限に該当します:
- 特定の承認経路(部門・役職ベース等)で API から申請ができない
- 特定の条件(外貨を含む等)のデータが API で取得できない
- Web UI では可能な操作が API では提供されていない
- 特定のエンドポイントやフィールドが存在しない
このような場合は、freee Public API のリクエストフォームから要望を送信してください:
- freee Public API リクエストフォーム: https://docs.google.com/forms/d/e/1FAIpQLSdG19OrIdc0nbI-F5L1hkYRAfh4l-qD0ugvuFqxvaOUdXVqXg/viewform
API の機能制限を freee-mcp の GitHub Issues に報告いただいても、クライアント側では対応できません。
サポートが必要な場合
freee API 公式ドキュメント
https://developer.freee.co.jp/docs
freee Public API リクエストフォーム
API の機能拡充や改善の要望は、freee Public API リクエストフォームから送信してください:
- https://docs.google.com/forms/d/e/1FAIpQLSdG19OrIdc0nbI-F5L1hkYRAfh4l-qD0ugvuFqxvaOUdXVqXg/viewform
GitHub Issues(freee-mcp の不具合・改善要望)
https://github.com/freee/freee-mcp/issues
freee-mcp(MCP サーバー)自体の不具合や改善要望は、上記リポジトリの Issue で報告してください。freee API が提供していない機能のリクエストは、freee Public API リクエストフォーム(https://docs.google.com/forms/d/e/1FAIpQLSdG19OrIdc0nbI-F5L1hkYRAfh4l-qD0ugvuFqxvaOUdXVqXg/viewform)へお願いします。freee サポートでは freee-mcp に関するお問い合わせは受け付けておりません。
問い合わせ前に確認すること
1. freee_auth_status で認証を確認しましたか? 2. freee_get_current_company で事業所を確認しましたか? 3. エラーメッセージを正確にコピーしましたか? 4. API の機能制限ではなく、freee-mcp の問題であることを確認しましたか?
Account groups
概要
決算書表示名
エンドポイント一覧
POST /api/1/account_groups
操作: 決算書表示名の作成
説明: 概要 指定した事業所の決算書表示名を作成する
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1 - name (必須): string - 決算書表示名 (20文字以内) 例:
新しい決算書表示名 - account_category_id (必須): integer(int64) - 勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です 例:
1 - index (任意): integer(int64) - 表示順 例:
1
レスポンス (201)
- account_group (必須): object
- company_id (必須): integer(int64) - 事業所ID 例:
1 - id (必須): integer(int64) - 決算書表示名(小カテゴリー)ID 例:
1 - name (必須): string - 決算書表示名 例:
新しい決算書表示名 - account_structure_id (必須): integer(int64) - 年度ID 例:
1 - account_category_id (必須): integer(int64) - 勘定科目カテゴリID 例:
1 - index (必須): integer(int64) - 表示順 例:
1
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Account items
概要
勘定科目
エンドポイント一覧
GET /api/1/account_items/{id}
操作: 勘定科目の取得
説明: 概要 指定した勘定科目を取得する 事業所の設定で勘定科目コードを使用する設定にしている場合、レスポンスで勘定科目コード(code)を返します
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
| id | path | はい | integer(int64) | 勘定科目ID |
レスポンス (200)
- account_item (必須): object
- id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - name (必須): string - 勘定科目名 (30文字以内) 例:
ソフトウェア - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - account_category (必須): string - 勘定科目カテゴリー 例:
現金・預金 - account_category_id (必須): integer(int64) - 勘定科目のカテゴリーID 例:
1(最小: 1) - shortcut (任意): string - ショートカット1 (20文字以内) 例:
SOFUTO - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
123 - code (任意): string - 勘定科目コード 例:
123 - searchable (必須): integer(int64) - 検索可能:2, 検索不可:3 例:
2(最小: 2, 最大: 3) - accumulated_dep_account_item_name (任意): string - 減価償却累計額勘定科目(法人のみ利用可能) 例:
減価償却累計額 - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - items (任意): array[object]
- partners (任意): array[object]
- available (必須): boolean - 勘定科目の使用設定(true: 使用する、false: 使用しない) 例:
true - walletable_id (必須): integer(int64) - 口座ID 例:
1(最小: 1) - group_name (任意): string - 決算書表示名(小カテゴリー) 例:
売掛金 - group_id (任意): integer(int64) - 決算書表示名ID(小カテゴリー) 例:
1(最小: 1) - corresponding_income_name (任意): string - 収入取引相手勘定科目名 例:
売掛金 - corresponding_income_id (任意): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_name (任意): string - 支出取引相手勘定科目名 例:
買掛金 - corresponding_expense_id (任意): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1)
PUT /api/1/account_items/{id}
操作: 勘定科目の更新
説明: 概要 指定した勘定科目を更新する 注意点 tax_codeは、指定した事業所の税区分一覧の取得APIでavailableの値がtrue、かつ経過措置税区分ではない5%の税区分を確認して、そのcodeを指定して勘定科目の更新をしてください。例 課対仕入の場合、34を指定してください codeを利用するには、事業所の設定で勘定科目コードを使用する設定にする必要があります。
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 勘定科目ID |
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - account_item (必須): object
- name (任意): string - 勘定科目名 (30文字以内)
口座に紐付かない勘定科目の更新時は必須です。 口座に紐付く勘定科目の更新時は指定することができません。 例: 新しい勘定科目
- shortcut (任意): string - ショートカット1 (20文字以内) 例:
NEWACCOUNTITEM - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
999 - code (任意): string - 勘定科目コード 例:
999(パターン: ^[0-9a-zA-Z_-]+$) - tax_code (必須): integer(int64) - 税区分コード 指定できるコードは本APIの注意点をご確認ください。 例:
1(最小: 0, 最大: 2147483647) - group_name (必須): string - 決算書表示名(小カテゴリー) Selectablesフォーム用選択項目情報エンドポイント(account_groups.name)で取得可能です 例:
その他預金 - account_category_id (必須): integer(int64) - 勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です 例:
1(最小: 1) - corresponding_income_id (必須): integer(int64) - 収入取引相手勘定科目ID 例:
1 - corresponding_expense_id (必須): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1) - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - searchable (任意): integer(int64) - 検索可能:2, 検索不可:3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。) 例:
2(最小: 2, 最大: 3) - items (任意): array[object] - 品目
- partners (任意): array[object] - 取引先
レスポンス (200)
- account_item (必須): object
- id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - name (必須): string - 勘定科目名 (30文字以内) 例:
ソフトウェア - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - account_category (必須): string - 勘定科目カテゴリー 例:
現金・預金 - account_category_id (必須): integer(int64) - 勘定科目のカテゴリーID 例:
1(最小: 1) - shortcut (任意): string - ショートカット1 (20文字以内) 例:
SOFUTO - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
123 - code (任意): string - 勘定科目コード 例:
123 - searchable (必須): integer(int64) - 検索可能:2, 検索不可:3 例:
2(最小: 2, 最大: 3) - accumulated_dep_account_item_name (任意): string - 減価償却累計額勘定科目(法人のみ利用可能) 例:
減価償却累計額 - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - items (任意): array[object]
- partners (任意): array[object]
- available (必須): boolean - 勘定科目の使用設定(true: 使用する、false: 使用しない) 例:
true - walletable_id (必須): integer(int64) - 口座ID 例:
1(最小: 1) - group_name (任意): string - 決算書表示名(小カテゴリー) 例:
売掛金 - group_id (任意): integer(int64) - 決算書表示名ID(小カテゴリー) 例:
1(最小: 1) - corresponding_income_name (任意): string - 収入取引相手勘定科目名 例:
売掛金 - corresponding_income_id (任意): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_name (任意): string - 支出取引相手勘定科目名 例:
買掛金 - corresponding_expense_id (任意): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1)
DELETE /api/1/account_items/{id}
操作: 勘定科目の削除
説明: 概要 指定した勘定科目を削除する 注意点 削除できる勘定科目は、追加で作成したカスタム勘定科目のみです。 デフォルトで存在する勘定科目や口座の勘定科目は削除できません。
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 勘定科目ID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (204)
GET /api/1/account_items
操作: 勘定科目一覧の取得
説明: 概要 指定した事業所の勘定科目一覧を取得する 定義 default_tax_code : リクエストした日時を基準とした税区分コード 注意点 default_tax_code は勘定科目作成・更新時に利用するものではありません 事業所の設定で勘定科目コードを使用する設定にしている場合、レスポンスで勘定科目コード(code)を返します
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
| base_date | query | いいえ | string | 基準日:指定した場合、勘定科目に紐づく税区分(default_tax_code)が、基準日の税率に基づいて返ります。 |
| start_update_date | query | いいえ | string | 更新日で絞込:開始日(yyyy-mm-dd) |
| end_update_date | query | いいえ | string | 更新日で絞込:終了日(yyyy-mm-dd) |
レスポンス (200)
- account_items (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - name (必須): string - 勘定科目名 (30文字以内) 例:
ソフトウェア - tax_code (必須): integer(int64) - 税区分コード 例:
1 - shortcut (任意): string - ショートカット1 (20文字以内) 例:
SOFUTO - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
123 - code (任意): string - 勘定科目コード 例:
123 - default_tax_code (必須): integer(int64) - デフォルト設定がされている税区分コード 例:
34 - account_category (必須): string - 勘定科目カテゴリー 例:
現金・預金 - account_category_id (必須): integer(int64) - 勘定科目のカテゴリーID 例:
1(最小: 1) - categories (必須): array[string]
- available (必須): boolean - 勘定科目の使用設定(true: 使用する、false: 使用しない) 例:
true - walletable_id (必須): integer(int64) - 口座ID 例:
1(最小: 1) - group_name (任意): string - 決算書表示名(小カテゴリー) 例:
売掛金 - group_id (任意): integer(int64) - 決算書表示名ID(小カテゴリー) 例:
1(最小: 1) - corresponding_income_name (任意): string - 収入取引相手勘定科目名 例:
売掛金 - corresponding_income_id (任意): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_name (任意): string - 支出取引相手勘定科目名 例:
買掛金 - corresponding_expense_id (任意): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1) - update_date (任意): string - 更新日(yyyy-mm-dd) 例:
2020-06-15
POST /api/1/account_items
操作: 勘定科目の作成
説明: 概要 指定した事業所の勘定科目を作成する 注意点 tax_codeは、指定した事業所の税区分一覧の取得APIでavailableの値がtrue、かつ経過措置税区分ではない5%の税区分を確認して、そのcodeを指定して勘定科目の作成をしてください。例 課対仕入の場合、34を指定してください codeを利用するには、事業所の設定で勘定科目コードを使用する設定にする必要があります。
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - account_item (必須): object
- name (必須): string - 勘定科目名 (30文字以内) 例:
新しい勘定科目 - shortcut (任意): string - ショートカット1 (20文字以内) 例:
NEWACCOUNTITEM - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
999 - code (任意): string - 勘定科目コード 例:
999(パターン: ^[0-9a-zA-Z_-]+$) - tax_code (必須): integer(int64) - 税区分コード 指定できるコードは本APIの注意点をご確認ください。 例:
1(最小: 0, 最大: 2147483647) - group_name (必須): string - 決算書表示名(小カテゴリー) Selectablesフォーム用選択項目情報エンドポイント(account_groups.name)で取得可能です 例:
その他預金 - account_category_id (必須): integer(int64) - 勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です 例:
1(最小: 1) - corresponding_income_id (必須): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_id (必須): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1) - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - searchable (任意): integer(int64) - 検索可能:2, 検索不可:3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。) 例:
2(最小: 2, 最大: 3) - items (任意): array[object] - 品目
- partners (任意): array[object] - 取引先
レスポンス (201)
- account_item (必須): object
- id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - name (必須): string - 勘定科目名 (30文字以内) 例:
ソフトウェア - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - account_category (必須): string - 勘定科目カテゴリー 例:
現金・預金 - account_category_id (必須): integer(int64) - 勘定科目のカテゴリーID 例:
1(最小: 1) - shortcut (任意): string - ショートカット1 (20文字以内) 例:
SOFUTO - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
123 - code (任意): string - 勘定科目コード 例:
123 - searchable (必須): integer(int64) - 検索可能:2, 検索不可:3 例:
2(最小: 2, 最大: 3) - accumulated_dep_account_item_name (任意): string - 減価償却累計額勘定科目(法人のみ利用可能) 例:
減価償却累計額 - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - items (任意): array[object]
- partners (任意): array[object]
- available (必須): boolean - 勘定科目の使用設定(true: 使用する、false: 使用しない) 例:
true - walletable_id (必須): integer(int64) - 口座ID 例:
1(最小: 1) - group_name (任意): string - 決算書表示名(小カテゴリー) 例:
売掛金 - group_id (任意): integer(int64) - 決算書表示名ID(小カテゴリー) 例:
1(最小: 1) - corresponding_income_name (任意): string - 収入取引相手勘定科目名 例:
売掛金 - corresponding_income_id (任意): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_name (任意): string - 支出取引相手勘定科目名 例:
買掛金 - corresponding_expense_id (任意): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1)
PUT /api/1/account_items/code/upsert
操作: 勘定科目の更新(存在しない場合は作成)
説明: 概要 勘定科目コードをキーに、指定した勘定科目の情報を更新(存在しない場合は作成)する 注意点 tax_codeは、指定した事業所の税区分一覧の取得APIでavailableの値がtrue、かつ経過措置税区分ではない5%の税区分を確認して、そのcodeを指定して勘定科目の更新をしてください。例 課対仕入の場合、34を指定してください codeを利用するには、事業所の設定で勘定科目コードを使用する設定にする必要があります。
リクエストボディ
(必須)
- code (必須): string - 勘定科目コード 例:
999(パターン: ^[0-9a-zA-Z_-]+$) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - account_item (必須): object
- name (任意): string - 勘定科目名 (30文字以内)
口座に紐付かない勘定科目の更新時は必須です。 口座に紐付く勘定科目の更新時は指定することができません。 例: 新しい勘定科目
- shortcut (任意): string - ショートカット1 (20文字以内) 例:
NEWACCOUNTITEM - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
999 - tax_code (必須): integer(int64) - 税区分コード 指定できるコードは本APIの注意点をご確認ください。 例:
1(最小: 0, 最大: 2147483647) - group_name (必須): string - 決算書表示名(小カテゴリー) Selectablesフォーム用選択項目情報エンドポイント(account_groups.name)で取得可能です 例:
その他預金 - account_category_id (必須): integer(int64) - 勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です 例:
1(最小: 1) - corresponding_income_id (必須): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_id (必須): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1) - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - searchable (任意): integer(int64) - 検索可能:2, 検索不可:3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。) 例:
2(最小: 2, 最大: 3) - items (任意): array[object] - 品目
- partners (任意): array[object] - 取引先
レスポンス (200)
- account_item (必須): object
- id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - name (必須): string - 勘定科目名 (30文字以内) 例:
ソフトウェア - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - account_category (必須): string - 勘定科目カテゴリー 例:
現金・預金 - account_category_id (必須): integer(int64) - 勘定科目のカテゴリーID 例:
1(最小: 1) - shortcut (任意): string - ショートカット1 (20文字以内) 例:
SOFUTO - shortcut_num (任意): string - ショートカット2 (20文字以内) 例:
123 - code (任意): string - 勘定科目コード 例:
123 - searchable (必須): integer(int64) - 検索可能:2, 検索不可:3 例:
2(最小: 2, 最大: 3) - accumulated_dep_account_item_name (任意): string - 減価償却累計額勘定科目(法人のみ利用可能) 例:
減価償却累計額 - accumulated_dep_account_item_id (任意): integer(int64) - 減価償却累計額勘定科目ID(法人のみ利用可能) 例:
1(最小: 1) - items (任意): array[object]
- partners (任意): array[object]
- available (必須): boolean - 勘定科目の使用設定(true: 使用する、false: 使用しない) 例:
true - walletable_id (必須): integer(int64) - 口座ID 例:
1(最小: 1) - group_name (任意): string - 決算書表示名(小カテゴリー) 例:
売掛金 - group_id (任意): integer(int64) - 決算書表示名ID(小カテゴリー) 例:
1(最小: 1) - corresponding_income_name (任意): string - 収入取引相手勘定科目名 例:
売掛金 - corresponding_income_id (任意): integer(int64) - 収入取引相手勘定科目ID 例:
1(最小: 1) - corresponding_expense_name (任意): string - 支出取引相手勘定科目名 例:
買掛金 - corresponding_expense_id (任意): integer(int64) - 支出取引相手勘定科目ID 例:
1(最小: 1)
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Approval flow routes
概要
申請経路
エンドポイント一覧
GET /api/1/approval_flow_routes
操作: 申請経路一覧の取得
説明: 概要 指定した事業所の申請経路一覧を取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 経費精算APIの使い方については、freee会計の経費精算APIの使い方をご参照ください 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定(申請者の所属部門) 役職指定(申請時に部門指定) 部門および役職指定
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
| included_user_id | query | いいえ | integer(int64) | 経路に含まれるユーザーのユーザーID |
| usage | query | いいえ | string | 申請種別(各申請種別が使用できる申請経路に絞り込めます。例えば、ApprovalRequest を指定すると、各種申請が使用できる申請経路に絞り込めます。) |
TxnApproval- 仕訳承認ExpenseApplication- 経費精算PaymentRequest- 支払依頼ApprovalRequest- 各種申請DocApproval- 請求書等 (見積書・納品書・請求書・発注書) (選択肢: TxnApproval, ExpenseApplication, PaymentRequest, ApprovalRequest, DocApproval) |
| request_form_id | query | いいえ | integer | 申請フォームID request_form_id指定時はusage条件をApprovalRequestに指定してください。指定しない場合無効になります。 |
レスポンス (200)
- approval_flow_routes (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - name (任意): string - 申請経路名 例:
申請経路 - description (任意): string - 申請経路の説明 例:
申請経路の説明 - user_id (任意): integer(int64) - 更新したユーザーのユーザーID 例:
1(最小: 1) - definition_system (任意): boolean - システム作成の申請経路かどうか 例:
true - first_step_id (任意): integer(int64) - 最初の承認ステップのID 例:
1(最小: 1) - usages (任意): array[string] - 申請種別(申請経路を使用できる申請種別を示します。例えば、ApprovalRequest の場合は、各種申請で使用できる申請経路です。)
TxnApproval- 仕訳承認ExpenseApplication- 経費精算PaymentRequest- 支払依頼ApprovalRequest- 各種申請DocApproval- 請求書等 (見積書・納品書・請求書・発注書)- request_form_ids (任意): array[integer] - 申請経路で利用できる申請フォームID配列
- default_route (必須): boolean - 基本経路として設定されているかどうか<br><br>
リクエストパラメータusageに下記のいずれかが指定され、かつ、基本経路の場合はtrueになります。
TxnApproval- 仕訳承認ExpenseApplication- 経費精算PaymentRequest- 支払依頼ApprovalRequest(リクエストパラメータrequest_form_idを同時に指定) - 各種申請DocApproval- 請求書等 (見積書・納品書・請求書・発注書)
<a href="https://support.freee.co.jp/hc/ja/articles/900000507963" target="_blank">申請フォームの基本経路設定</a> 例: true
GET /api/1/approval_flow_routes/{id}
操作: 申請経路の取得
説明: 概要 指定した事業所の申請経路を取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 経費精算APIの使い方については、freee会計の経費精算APIの使い方をご参照ください 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定(申請者の所属部門) 役職指定(申請時に部門指定) 部門および役職指定
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer | 経路申請ID |
| company_id | query | はい | integer | 事業所ID |
レスポンス (200)
- approval_flow_route (必須): object
- id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - name (任意): string - 申請経路名 例:
申請経路 - description (任意): string - 申請経路の説明 例:
申請経路の説明 - user_id (任意): integer(int64) - 更新したユーザーのユーザーID 例:
1(最小: 1) - definition_system (任意): boolean - システム作成の申請経路かどうか 例:
true - first_step_id (任意): integer(int64) - 最初の承認ステップのID 例:
1(最小: 1) - usages (任意): array[string] - 申請種別(申請経路を使用できる申請種別を示します。例えば、ApprovalRequest の場合は、各種申請で使用できる申請経路です。)
TxnApproval- 仕訳承認ExpenseApplication- 経費精算PaymentRequest- 支払依頼ApprovalRequest- 各種申請DocApproval- 請求書等 (見積書・納品書・請求書・発注書)- request_form_ids (必須): array[integer] - 申請経路で利用できる申請フォームID配列
- steps (任意): array[object] - 承認ステップ(配列)
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Approval requests
概要
各種申請
エンドポイント一覧
GET /api/1/approval_requests
操作: 各種申請一覧の取得
説明: 概要 指定した事業所の各種申請一覧を取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 本APIでは、各種申請一覧を取得することができます。 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定(申請者の所属部門) 役職指定(申請時に部門指定) 部門および役職指定 申請フォームの項目に契約書(freeeサイン連携)が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
| status | query | いいえ | string | 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) |
| 承認者指定時には無効です。 (選択肢: draft, in_progress, approved, rejected, feedback) | ||||
| application_number | query | いいえ | integer(int64) | 申請No. |
| title | query | いいえ | string | 申請タイトル |
| form_id | query | いいえ | integer(int64) | 申請フォームID |
| start_application_date | query | いいえ | string | 申請日で絞込:開始日(yyyy-mm-dd) |
| end_application_date | query | いいえ | string | 申請日で絞込:終了日(yyyy-mm-dd) |
| applicant_id | query | いいえ | integer(int64) | 申請者のユーザーID |
| min_amount | query | いいえ | integer(int64) | 金額で絞込:以上 |
| max_amount | query | いいえ | integer(int64) | 金額で絞込:以下 |
| approver_id | query | いいえ | integer(int64) | 承認者のユーザーID |
| 承認者指定時には申請ステータスが申請中のものだけが取得可能です。 | ||||
| offset | query | いいえ | integer(int64) | 取得レコードのオフセット (デフォルト: 0) |
| limit | query | いいえ | integer(int64) | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500) |
レスポンス (200)
- approval_requests (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 各種申請ID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (必須): string - 申請日 (yyyy-mm-dd) 例:
2019-12-17 - title (必須): string - 申請タイトル 例:
大阪出張 - applicant_id (必須): integer(int64) - 申請者のユーザーID 例:
1(最小: 1) - application_number (必須): string - 申請No. 例:
2 - status (必須): string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (選択肢: draft, in_progress, approved, rejected, feedback) 例:
draft - request_items (必須): array[object] - 各種申請の項目一覧(配列)
- form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - current_step_id (必須): integer(int64) - 現在承認ステップID 例:
1 - current_round (必須): integer(int64) - 現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例:
1(最小: 0, 最大: 2147483647) - deal_id (必須): integer(int64) - 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) 例:
1(最小: 1) - manual_journal_id (必須): integer(int64) - 振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)
<a href="https://support.freee.co.jp/hc/ja/articles/115003827683-#5" target="_blank">承認された各種申請から支払依頼等を作成する</a> 例: 1 (最小: 1)
- deal_status (必須): string - 取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済) (選択肢: settled, unsettled) 例:
settled
POST /api/1/approval_requests
操作: 各種申請の作成
説明: 概要 指定した事業所の各種申請を作成する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 本APIでは、各種申請を作成することができます。 申請項目(request_items)については、申請フォームで設定された項目のIDとそれに対応する値を入力してください。 タイトル(title):文字列(必須項目, 255文字まで, 改行なし) 例)予算申請 1行コメント(single_line):文字列(255文字まで, 改行なし) 例)予算に関する申請 複数行コメント(multi_line):文字列(1000文字まで, 改行あり) 例) 予算に関する申請 申請日 2019-12-17 プルダウン(select): プルダウンの選択肢の名前(改行なし) 例)開発部 日付(date): 日付形式 例)2019-12-17 金額(amount): 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000 添付ファイル(receipt): ファイルボックス(...
リクエストボディ
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (任意): string - 申請日 (yyyy-mm-dd)<br>
指定しない場合は当日の日付が登録されます。 例: 2019-12-17
- approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - approver_id (任意): integer(int64) - 承認者のユーザーID 例:
1(最小: 1) - draft (必須): boolean - 各種申請のステータス<br>
falseを指定した時は申請中(in_progress)で各種申請を作成します。<br> trueを指定した時は下書き(draft)で各種申請を作成します。 例: true
- parent_id (任意): integer(int64) - 親申請ID(既存各種申請IDのみ指定可能です。) 例:
2(最小: 1) - request_items (必須): array[object]
配列の要素:
- id (任意): integer(int64) - 項目ID 例:
1(最小: 1) - type (任意): string - 項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID) (選択肢: title, single_line, multi_line, select, date, amount, receipt, section, partner)
- value (任意): string - 項目の値 例:
申請理由
レスポンス (201)
- approval_request (必須): object
- id (必須): integer(int64) - 各種申請ID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (必須): string - 申請日 (yyyy-mm-dd) 例:
2019-12-17 - title (必須): string - 申請タイトル 例:
大阪出張 - applicant_id (必須): integer(int64) - 申請者のユーザーID 例:
1(最小: 1) - approvers (必須): array[object] - 承認者(配列)
承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。 しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、 approversはレスポンスに含まれるようになります。 その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。
- application_number (必須): string - 申請No. 例:
2 - status (必須): string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (選択肢: draft, in_progress, approved, rejected, feedback) 例:
draft - request_items (必須): array[object] - 各種申請の項目一覧(配列)
- form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - comments (必須): array[object] - 各種申請のコメント一覧(配列)
- approval_flow_logs (必須): array[object] - 各種申請の承認履歴(配列)
- current_step_id (必須): integer(int64) - 現在承認ステップID 例:
1(最小: 1) - current_round (必須): integer(int64) - 現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例:
1(最小: 0, 最大: 2147483647) - approval_request_form (必須): object
- deal_id (必須): integer(int64) - 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) 例:
1(最小: 1) - manual_journal_id (必須): integer(int64) - 振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)
<a href="https://support.freee.co.jp/hc/ja/articles/115003827683-#5" target="_blank">承認された各種申請から支払依頼等を作成する</a> 例: 1 (最小: 1)
- deal_status (必須): string - 取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済) (選択肢: settled, unsettled) 例:
settled
GET /api/1/approval_requests/{id}
操作: 各種申請の取得
説明: 概要 指定した事業所の各種申請を取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定(申請者の所属部門) 役職指定(申請時に部門指定) 部門および役職指定 申請フォームの項目に契約書(freeeサイン連携)が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 各種申請ID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (200)
- approval_request (必須): object
- id (必須): integer(int64) - 各種申請ID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (必須): string - 申請日 (yyyy-mm-dd) 例:
2019-12-17 - title (必須): string - 申請タイトル 例:
大阪出張 - applicant_id (必須): integer(int64) - 申請者のユーザーID 例:
1(最小: 1) - approvers (必須): array[object] - 承認者(配列)
承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。 しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、 approversはレスポンスに含まれるようになります。 その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。
- application_number (必須): string - 申請No. 例:
2 - status (必須): string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (選択肢: draft, in_progress, approved, rejected, feedback) 例:
draft - request_items (必須): array[object] - 各種申請の項目一覧(配列)
- form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - comments (必須): array[object] - 各種申請のコメント一覧(配列)
- approval_flow_logs (必須): array[object] - 各種申請の承認履歴(配列)
- current_step_id (必須): integer(int64) - 現在承認ステップID 例:
1(最小: 1) - current_round (必須): integer(int64) - 現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例:
1(最小: 0, 最大: 2147483647) - approval_request_form (必須): object
- deal_id (必須): integer(int64) - 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) 例:
1(最小: 1) - manual_journal_id (必須): integer(int64) - 振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)
<a href="https://support.freee.co.jp/hc/ja/articles/115003827683-#5" target="_blank">承認された各種申請から支払依頼等を作成する</a> 例: 1 (最小: 1)
- deal_status (必須): string - 取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済) (選択肢: settled, unsettled) 例:
settled
PUT /api/1/approval_requests/{id}
操作: 各種申請の更新
説明: 概要 指定した事業所の各種申請を更新する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 本APIでは、各種申請を更新することができます。 申請項目(request_items)については、各種申請の取得APIで取得したrequest_items.idとそれに対応する値を入力してください。 タイトル(title):文字列(必須項目, 255文字まで, 改行なし) 例)予算申請 1行コメント(single_line):文字列(255文字まで, 改行なし) 例)予算に関する申請 複数行コメント(multi_line):文字列(1000文字まで, 改行あり) 例) 予算に関する申請 申請日 2019-12-17 プルダウン(select): プルダウンの選択肢の名前(改行なし) 例)開発部 日付(date): 日付形式 例)2019-12-17 金額(amount): 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000 添付ファイル(recei...
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 各種申請ID |
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (任意): string - 申請日 (yyyy-mm-dd)<br>
指定しない場合は当日の日付が登録されます。 例: 2019-12-17
- approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - approver_id (任意): integer(int64) - 承認者のユーザーID 例:
1(最小: 1) - draft (必須): boolean - 各種申請のステータス<br>
falseを指定した時は申請中(in_progress)で各種申請を更新します。<br> trueを指定した時は下書き(draft)で各種申請を更新します。 例: true
- request_items (必須): array[object]
配列の要素:
- id (任意): integer(int64) - 項目ID 例:
1(最小: 1) - type (任意): string - 項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID) (選択肢: title, single_line, multi_line, select, date, amount, receipt, section, partner)
- value (任意): string - 項目の値 例:
申請理由
レスポンス (200)
- approval_request (必須): object
- id (必須): integer(int64) - 各種申請ID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (必須): string - 申請日 (yyyy-mm-dd) 例:
2019-12-17 - title (必須): string - 申請タイトル 例:
大阪出張 - applicant_id (必須): integer(int64) - 申請者のユーザーID 例:
1(最小: 1) - approvers (必須): array[object] - 承認者(配列)
承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。 しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、 approversはレスポンスに含まれるようになります。 その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。
- application_number (必須): string - 申請No. 例:
2 - status (必須): string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (選択肢: draft, in_progress, approved, rejected, feedback) 例:
draft - request_items (必須): array[object] - 各種申請の項目一覧(配列)
- form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - comments (必須): array[object] - 各種申請のコメント一覧(配列)
- approval_flow_logs (必須): array[object] - 各種申請の承認履歴(配列)
- current_step_id (必須): integer(int64) - 現在承認ステップID 例:
1(最小: 1) - current_round (必須): integer(int64) - 現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例:
1(最小: 0, 最大: 2147483647) - approval_request_form (必須): object
- deal_id (必須): integer(int64) - 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) 例:
1(最小: 1) - manual_journal_id (必須): integer(int64) - 振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)
<a href="https://support.freee.co.jp/hc/ja/articles/115003827683-#5" target="_blank">承認された各種申請から支払依頼等を作成する</a> 例: 1 (最小: 1)
- deal_status (必須): string - 取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済) (選択肢: settled, unsettled) 例:
settled
DELETE /api/1/approval_requests/{id}
操作: 各種申請の削除
説明: 概要 指定した事業所の各種申請を削除する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 申請ステータス(下書き、申請中)の指定と変更、及び承認操作(承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す)は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成(POST) 作成済みの申請の申請ステータス変更・更新する場合 申請の更新(PUT) 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行(POST) 申請の削除(DELETE)が可能なのは申請ステータスが下書き、差戻しの場合のみです
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 各種申請ID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (204)
POST /api/1/approval_requests/{id}/actions
操作: 各種申請の承認操作
説明: 概要 指定した事業所の各種申請の承認操作を行う 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください 注意点 本APIでは、各種申請の承認操作(承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す)を行うことができます。 申請ステータス(下書き、申請中)の指定と変更、及び承認操作(承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す)は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成(POST) 作成済みの申請の申請ステータス変更・更新する場合 申請の更新(PUT) 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行(POST) 申請の削除(DELETE)が可能なのは申請ステータスが下書き、差戻しの場合のみです 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請はAPI経由で承認ステータスの変更ができません。 役職指定(申請者の所属部門) 役職指定(申請時に...
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 各種申請ID |
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - approval_action (必須): string - 操作(approve: 承認する、force_approve: 特権承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す) (選択肢: approve, force_approve, cancel, reject, feedback, force_feedback) 例:
approve - target_step_id (必須): integer(int64) - 対象承認ステップID 各種申請の取得APIレスポンス.current_step_idを送信してください。 例:
1(最小: 1) - target_round (必須): integer - 対象round。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。各種申請の取得APIレスポンス.current_roundを送信してください。 例:
1(最小: 0, 最大: 2147483647) - next_approver_id (任意): integer(int64) - 次ステップの承認者のユーザーID 例:
1(最小: 1)
レスポンス (201)
- approval_request (必須): object
- id (必須): integer(int64) - 各種申請ID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - application_date (必須): string - 申請日 (yyyy-mm-dd) 例:
2019-12-17 - title (必須): string - 申請タイトル 例:
大阪出張 - applicant_id (必須): integer(int64) - 申請者のユーザーID 例:
1(最小: 1) - approvers (必須): array[object] - 承認者(配列)
承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。 しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、 approversはレスポンスに含まれるようになります。 その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。
- application_number (必須): string - 申請No. 例:
2 - status (必須): string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (選択肢: draft, in_progress, approved, rejected, feedback) 例:
draft - request_items (必須): array[object] - 各種申請の項目一覧(配列)
- form_id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - approval_flow_route_id (必須): integer(int64) - 申請経路ID 例:
1(最小: 1) - comments (必須): array[object] - 各種申請のコメント一覧(配列)
- approval_flow_logs (必須): array[object] - 各種申請の承認履歴(配列)
- current_step_id (必須): integer(int64) - 現在承認ステップID 例:
1(最小: 1) - current_round (必須): integer(int64) - 現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例:
1(最小: 0, 最大: 2147483647) - approval_request_form (必須): object
- deal_id (必須): integer(int64) - 取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます) 例:
1(最小: 1) - manual_journal_id (必須): integer(int64) - 振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)
<a href="https://support.freee.co.jp/hc/ja/articles/115003827683-#5" target="_blank">承認された各種申請から支払依頼等を作成する</a> 例: 1 (最小: 1)
- deal_status (必須): string - 取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済) (選択肢: settled, unsettled) 例:
settled
GET /api/1/approval_requests/forms
操作: 各種申請の申請フォーム一覧の取得
説明: 概要 指定した事業所の各種申請の申請フォーム一覧を取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (200)
- approval_request_forms (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 申請フォームの名前 例:
申請フォームの名前 - description (必須): string - 申請フォームの説明 例:
申請フォームの説明 - status (必須): string - ステータス(draft: 申請で使用しない、active: 申請で使用する) (選択肢: draft, active) 例:
active - created_date (必須): string - 作成日時 例:
2019-12-17T13:47:24+09:00 - form_order (必須): integer(int64) - 表示順(申請者が選択する申請フォームの表示順を設定できます。小さい数ほど上位に表示されます。(0を除く整数のみ。マイナス不可)未入力の場合、表示順が後ろになります。同じ数字が入力された場合、登録順で表示されます。) 例:
1(最小: 1, 最大: 1000) - route_setting_count (必須): integer(int64) - 適用された経路数(ユーザーが利用できない経路を除く) 例:
1(最小: 0, 最大: 2147483647)
GET /api/1/approval_requests/forms/{id}
操作: 各種申請の申請フォームの取得
説明: 概要 指定した事業所の各種申請の申請フォームを取得する 各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 申請フォームID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (200)
- approval_request_form (必須): object
- id (必須): integer(int64) - 申請フォームID 例:
1(最小: 1) - company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 申請フォームの名前 例:
申請フォームの名前 - description (必須): string - 申請フォームの説明 例:
申請フォームの説明 - status (必須): string - ステータス(draft: 申請で使用しない、active: 申請で使用する) (選択肢: draft, active) 例:
active - created_date (必須): string - 作成日時 例:
2019-12-17T13:47:24+09:00 - form_order (必須): integer(int64) - 表示順(申請者が選択する申請フォームの表示順を設定できます。小さい数ほど上位に表示されます。(0を除く整数のみ。マイナス不可)未入力の場合、表示順が後ろになります。同じ数字が入力された場合、登録順で表示されます。) 例:
1(最小: 1, 最大: 1000) - parts (任意): array[object] - 申請フォームの項目
- route_setting_count (必須): integer(int64) - 適用された経路数(ユーザーが利用できない経路を除く) 例:
1(最小: 0, 最大: 2147483647)
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Banks
概要
連携サービス
エンドポイント一覧
GET /api/1/banks
操作: 連携サービス一覧の取得
説明: 概要 連携しているサービス一覧を取得する 定義 type bank_account : 銀行口座 credit_card : クレジットカード wallet : その他の決済口座
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| offset | query | いいえ | integer(int64) | 取得レコードのオフセット (デフォルト: 0) |
| limit | query | いいえ | integer(int64) | 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) |
| type | query | いいえ | string | サービス種別 (選択肢: bank_account, credit_card, wallet) |
レスポンス (200)
- banks (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 連携サービスID 例:
1(最小: 1) - name (任意): string - 連携サービス名 例:
フリー銀行 - type (任意): string - 連携サービス種別: (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) (選択肢: bank_account, credit_card, wallet) 例:
bank_account - name_kana (任意): string - 連携サービス名(カナ) 例:
フリーギンコウ
GET /api/1/banks/{id}
操作: 連携サービスの取得
説明: 概要 連携しているサービスを取得する 定義 type bank_account : 銀行口座 credit_card : クレジットカード wallet : その他の決済口座
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 連携サービスID |
レスポンス (200)
- bank (必須): object
- id (必須): integer(int64) - 連携サービスID 例:
1(最小: 1) - name (任意): string - 連携サービス名 例:
フリー銀行 - type (任意): string - 連携サービス種別: (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) (選択肢: bank_account, credit_card, wallet) 例:
bank_account - name_kana (任意): string - 連携サービス名(カナ) 例:
フリーギンコウ
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Companies
概要
事業所
エンドポイント一覧
GET /api/1/companies
操作: 事業所一覧の取得
説明: 概要 ユーザーが所属する事業所一覧を取得する
レスポンス (200)
- companies (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 事業所名 例:
freee事務所 - name_kana (必須): string - 事業所名(カナ) 例:
フリージムショ - display_name (必須): string - 事業所名 例:
freee事務所 - company_number (必須): string - 事業所番号(ハイフン無し)(半角英数字10桁) 例:
97e576421b - role (必須): string - ユーザーの権限
- admin - 管理者
- simple_accounting - 一般(経理)
- read_only - 取引登録のみ
- self_only - 閲覧のみ
- workflow - 申請・承認 (選択肢: admin, simple_accounting, self_only, read_only, workflow) 例:
admin
GET /api/1/companies/{id}
操作: 事業所の取得
説明: 概要 ユーザーが所属する事業所を取得する
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 事業所ID |
| details | query | いいえ | boolean | 取得情報に勘定科目・税区分コード・品目・取引先・部門・メモタグ・口座の一覧を含める (選択肢: true) |
| account_items | query | いいえ | boolean | 取得情報に勘定科目一覧を含める (選択肢: true) |
| taxes | query | いいえ | boolean | 取得情報に税区分コード一覧を含める (選択肢: true) |
| items | query | いいえ | boolean | 取得情報に品目一覧を含める (選択肢: true) |
| partners | query | いいえ | boolean | 取得情報に取引先一覧を含める (選択肢: true) |
| sections | query | いいえ | boolean | 取得情報に部門一覧を含める (選択肢: true) |
| tags | query | いいえ | boolean | 取得情報にメモタグ一覧を含める (選択肢: true) |
| walletables | query | いいえ | boolean | 取得情報に口座一覧を含める (選択肢: true) |
レスポンス (200)
- company (必須): object
- id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 事業所の正式名称 (100文字以内) 例:
freee事務所 - name_kana (必須): string - 正式名称フリガナ (100文字以内) 例:
フリージムショ - display_name (必須): string - 事業所名 例:
freee事務所 - tax_at_source_calc_type (必須): integer(int64) - 源泉徴収税計算(0: 消費税を含める、1: 消費税を含めない) 例:
0(最小: 0, 最大: 1) - contact_name (必須): string - 担当者名 (50文字以内) 例:
user1 - head_count (必須): integer(int64) - 従業員数(0: 経営者のみ、1: 2〜5人、2: 6〜10人、3: 11〜20人、4: 21〜30人、5: 31〜40人、6: 41〜100人、7: 100人以上、13: 21〜50人、14: 51〜100人、15: 101〜300人、16: 501〜1000人、17: 1001人以上、18: 301〜500人 例:
1(最小: 0, 最大: 99) - corporate_number (必須): string - 法人番号 (半角数字13桁、法人のみ) 例:
1234567890123 - txn_number_format (必須): string - 仕訳番号形式(not_used: 使用しない、digits: 数字(例:5091824)、alnum: 英数字(例:59J0P)) (選択肢: not_used, digits, alnum) 例:
not_used - default_wallet_account_id (任意): integer(int64) - デフォルトの決済口座が紐づく勘定科目ID 例:
1(最小: 1) - private_settlement (必須): boolean - プライベート資金/役員資金(false: 使用しない、true: 使用する) 例:
true - minus_format (必須): integer(int64) - マイナスの表示方法(0: -、 1: △) 例:
0(最小: 0, 最大: 1) - org_code (必須): integer - 事業所種別コード(1: 法人、 2: 個人事業主) 例:
1(最小: 1, 最大: 2) - company_number (必須): string - 事業所番号(ハイフン無し)(半角英数字10桁) 例:
97e576421b - role (必須): string - ユーザーの権限
- admin - 管理者
- simple_accounting - 一般(経理)
- read_only - 取引登録のみ
- self_only - 閲覧のみ
- workflow - 申請・承認 (選択肢: admin, simple_accounting, self_only, read_only, workflow) 例:
admin - phone1 (必須): string - 電話番号1 例:
03-1234-xxxx - phone2 (必須): string - 電話番号2 例:
090-1234-xxxx - fax (必須): string - FAX 例:
03-1234-xxxx - zipcode (必須): string - 郵便番号 例:
000-0000 - prefecture_code (必須): integer(int64) - 都道府県コード(-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄 例:
4(最小: -1, 最大: 46) - street_name1 (必須): string - 市区町村・番地 例:
XX区YY1−1−1 - street_name2 (必須): string - 建物名・部屋番号など 例:
ビル1F - invoice_layout (必須): string - 請求書レイアウト
default_classic- レイアウト1/クラシック (デフォルト)
standard_classic- レイアウト2/クラシック
envelope_classic- 封筒1/クラシック
carried_forward_standard_classic- レイアウト3(繰越金額欄あり)/クラシック
carried_forward_envelope_classic- 封筒2(繰越金額欄あり)/クラシック
default_modern- レイアウト1/モダン
standard_modern- レイアウト2/モダン
envelope_modern- 封筒/モダン (選択肢: default_classic, standard_classic, envelope_classic, carried_forward_standard_classic, carried_forward_envelope_classic, default_modern, standard_modern, envelope_modern) 例:default_classic- amount_fraction (必須): integer(int64) - 金額端数処理方法(0: 切り捨て、1: 切り上げ、2: 四捨五入) 例:
0(最小: 0, 最大: 2) - use_partner_code (必須): boolean - 取引先コードの利用設定(true: 有効、 false: 無効) 例:
true - industry_class (必須): string - 種別(agriculture_forestry_fisheries_ore: 農林水産業/鉱業,construction: 建設,manufacturing_processing: 製造/加工,it: IT,transportation_logistics: 運輸/物流,retail_wholesale: 小売/卸売,finance_insurance: 金融/保険,real_estate_rental: 不動産/レンタル,profession: 士業/学術/専門技術サービス,design_production: デザイン/制作,food: 飲食,leisure_entertainment: レジャー/娯楽,lifestyle: 生活関連サービス,education: 教育/学習支援,medical_welfare: 医療/福祉,other_services: その他サービス,other_association: NPO、一般社団法人等,other: その他, "": 未選択) (選択肢: agriculture_forestry_fisheries_ore, construction, manufacturing_processing, it, transportation_logistics, retail_wholesale, finance_insurance, real_estate_rental, profession, design_production, food, leisure_entertainment, lifestyle, education, medical_welfare, other_services, other_association, other, ) 例:
agriculture_forestry_fisheries_ore - industry_code (必須): string - ### 業種 法人<br>
- '': 未選択
- agriculture: 農業
- forestry: 林業
- fishing_industry: 漁業、水産養殖業
- mining: 鉱業、採石業、砂利採取業
- civil_contractors: 土木工事業
- pavement: 舗装工事業
- carpenter: とび、大工、左官等の建設工事業
- renovation: リフォーム工事業
- electrical_plumbing: 電気、管工事等の設備工事業
- grocery: 食料品の製造加工業
- machinery_manufacturing: 機械器具の製造加工業
- printing: 印刷業
- other_manufacturing: その他の製造加工業
- software_development: 受託:ソフトウェア、アプリ開発業
- system_development: 受託:システム開発業
- survey_analysis: 受託:調査、分析等の情報処理業
- server_management: 受託:サーバー運営管理
- website_production: 受託:ウェブサイト制作
- online_service_management: オンラインサービス運営業
- online_advertising_agency: オンライン広告代理店業
- online_advertising_planning_production: オンライン広告企画・制作業
- online_media_management: オンラインメディア運営業
- portal_site_management: ポータルサイト運営業
- other_it_services: その他、IT サービス業
- transport_delivery: 輸送業、配送業
- delivery: バイク便等の配達業
- other_transportation_logistics: その他の運輸業、物流業
- other_wholesale: 卸売業:その他
- clothing_wholesale_fiber: 卸売業:衣類卸売/繊維
- food_wholesale: 卸売業:飲食料品
- entrusted_development_wholesale: 卸売業:機械器具
- online_shop: 小売業:無店舗 オンラインショップ
- fashion_grocery_store: 小売業:店舗あり ファッション、雑貨
- food_store: 小売業:店舗あり 生鮮食品、飲食料品
- entrusted_store: 小売業:店舗あり 機械、器具
- other_store: 小売業:店舗あり その他
- financial_instruments_exchange: 金融業:金融商品取引
- commodity_futures_investment_advisor: 金融業:商品先物取引、商品投資顧問
- other_financial: 金融業:その他
- brokerage_insurance: 保険業:仲介、代理
- other_insurance: 保険業:その他
- real_estate_developer: 不動産業:ディベロッパー
- real_estate_brokerage: 不動産業:売買、仲介
- rent_coin_parking_management: 不動産業:賃貸、コインパーキング、管理
- rental_office_co_working_space: 不動産業:レンタルオフィス、コワーキングスペース
- rental_lease: レンタル業、リース業
- cpa_tax_accountant: 士業:公認会計士事務所、税理士事務所
- law_office: 士業:法律事務所
- judicial_and_administrative_scrivener: 士業:司法書士事務所/行政書士事務所
- labor_consultant: 士業:社会保険労務士事務所
- other_profession: 士業:その他
- business_consultant: 経営コンサルタント
- academic_research_development: 学術・開発研究機関
- advertising_agency: 広告代理店
- advertising_planning_production: 広告企画/制作
- design_development: ソフトウェア、アプリ開発業(受託)
- apparel_industry_design: 服飾デザイン業、工業デザイン業
- website_design: ウェブサイト制作(受託)
- advertising_planning_design: 広告企画/制作業
- other_design: その他、デザイン/制作
- restaurants_coffee_shops: レストラン、喫茶店等の飲食店業
- sale_of_lunch: 弁当の販売業
- bread_confectionery_manufacture_sale: パン、菓子等の製造販売業
- delivery_catering_mobile_catering: デリバリー業、ケータリング業、移動販売業
- hotel_inn: 宿泊業:ホテル、旅館
- homestay: 宿泊業:民泊
- travel_agency: 旅行代理店業
- leisure_sports_facility_management: レジャー、スポーツ等の施設運営業
- show_event_management: ショー、イベント等の興行、イベント運営業
- barber: ビューティ、ヘルスケア業:床屋、理容室
- beauty_salon: ビューティ、ヘルスケア業:美容室
- spa_sand_bath_sauna: ビューティ、ヘルスケア業:スパ、砂風呂、サウナ等
- este_ail_salon: ビューティ、ヘルスケア業:その他、エステサロン、ネイルサロン等
- bridal_planning_introduce_wedding: 冠婚葬祭業:ブライダルプランニング、結婚式場紹介等
- memorial_ceremony_funeral: 冠婚葬祭業:メモリアルセレモニー、葬儀等
- moving: 引っ越し業
- courier_industry: 宅配業
- house_maid_cleaning_agency: 家事代行サービス業:無店舗 ハウスメイド、掃除代行等
- re_tailoring_clothes: 家事代行サービス業:店舗あり 衣類修理、衣類仕立て直し等
- training_institute_management: 研修所等の施設運営業
- tutoring_school: 学習塾、進学塾等の教育・学習支援業
- music_calligraphy_abacus_classroom: 音楽教室、書道教室、そろばん教室等の教育・学習支援業
- english_school: 英会話スクール等の語学学習支援業
- tennis_yoga_judo_school: テニススクール、ヨガ教室、柔道場等のスポーツ指導、支援業
- culture_school: その他、カルチャースクール等の教育・学習支援業
- seminar_planning_management: セミナー等の企画、運営業
- hospital_clinic: 医療業:病院、一般診療所、クリニック等
- dental_clinic: 医療業:歯科診療所
- other_medical_services: 医療業:その他、医療サービス等
- nursery: 福祉業:保育所等、児童向け施設型サービス
- nursing_home: 福祉業:老人ホーム等、老人向け施設型サービス
- rehabilitation_support_services: 福祉業:療育支援サービス等、障害者等向け施設型サービス
- other_welfare: 福祉業:その他、施設型福祉サービス
- visit_welfare_service: 福祉業:訪問型福祉サービス
- recruitment_temporary_staffing: 人材紹介業、人材派遣業
- life_related_recruitment_temporary_staffing: 生活関連サービスの人材紹介業、人材派遣業
- car_maintenance_car_repair: 自動車整備業、自動車修理業
- machinery_equipment_maintenance_repair: 機械機器類の整備業、修理業
- cleaning_maintenance_building_management: 清掃業、メンテナンス業、建物管理業
- security: 警備業
- other_services: その他のサービス業
- npo: 'NPO'
- general_incorporated_association: '一般社団法人'
- general_incorporated_foundation: '一般財団法人'
- other_association: 'その他組織'
<br> <br>
業種 個人<br>
- '': 未選択
- manufacturing: 製造業
- education: 教育
- medical: 医療/福祉
- ict: ソフトウェア・情報サービス業
- food: 飲食業
- construction: 建設業
- transportation: 運送業
- trading: 卸売業
- retail: 小売業
- finance: 金融/保険業
- real_estate: 不動産業
- agriculture: 農業
- travel: 旅行・宿泊業
- accountant: 専門業(税理士・会計士)
- lawer: その他専門業(法律など)
- consultant: サービス業(コンサルティング)
- recruit: サービス業(人材)
- publication: サービス業(出版)
- design: サービス業(デザイン)
- barber: サービス業(理容・美容)
- others: その他サービス業
- company_employee: 会社員
- others_side_business: その他(副業や株取引のみなど)
- others_deduction: その他(医療費などの控除のみ)
- default: 未定 (選択肢: , agriculture, forestry, fishing_industry, mining, civil_contractors, pavement, carpenter, renovation, electrical_plumbing, grocery, machinery_manufacturing, printing, other_manufacturing, software_development, system_development, survey_analysis, server_management, website_production, online_service_management, online_advertising_agency, online_advertising_planning_production, online_media_management, portal_site_management, other_it_services, transport_delivery, delivery, other_transportation_logistics, other_wholesale, clothing_wholesale_fiber, food_wholesale, entrusted_development_wholesale, online_shop, fashion_grocery_store, food_store, entrusted_store, other_store, financial_instruments_exchange, commodity_futures_investment_advisor, other_financial, brokerage_insurance, other_insurance, real_estate_developer, real_estate_brokerage, rent_coin_parking_management, rental_office_co_working_space, rental_lease, cpa_tax_accountant, law_office, judicial_and_administrative_scrivener, labor_consultant, other_profession, business_consultant, academic_research_development, advertising_agency, advertising_planning_production, design_development, apparel_industry_design, website_design, advertising_planning_design, other_design, restaurants_coffee_shops, sale_of_lunch, bread_confectionery_manufacture_sale, delivery_catering_mobile_catering, hotel_inn, homestay, travel_agency, leisure_sports_facility_management, show_event_management, barber, beauty_salon, spa_sand_bath_sauna, este_ail_salon, bridal_planning_introduce_wedding, memorial_ceremony_funeral, moving, courier_industry, house_maid_cleaning_agency, re_tailoring_clothes, training_institute_management, tutoring_school, music_calligraphy_abacus_classroom, english_school, tennis_yoga_judo_school, culture_school, seminar_planning_management, hospital_clinic, dental_clinic, other_medical_services, nursery, nursing_home, rehabilitation_support_services, other_welfare, visit_welfare_service, recruitment_temporary_staffing, life_related_recruitment_temporary_staffing, car_maintenance_car_repair, machinery_equipment_maintenance_repair, cleaning_maintenance_building_management, security, other_services, npo, general_incorporated_association, general_incorporated_foundation, other_association, manufacturing, education, medical, ict, food, construction, transportation, trading, retail, finance, real_estate, travel, accountant, lawer, consultant, recruit, publication, design, others, company_employee, others_side_business, others_deduction, default)
- workflow_setting (必須): string - 仕訳承認フロー(enable: 有効、 disable: 無効) (選択肢: enable, disable) 例:
disabled - fiscal_years (必須): array[object]
- account_items (任意): array[object]
- tax_codes (任意): array[object]
- items (任意): array[object]
- partners (任意): array[object]
- sections (任意): array[object]
- tags (任意): array[object]
- walletables (任意): array[object]
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
Expense application line templates
概要
経費科目
エンドポイント一覧
GET /api/1/expense_application_line_templates
操作: 経費科目一覧の取得
説明: 概要 指定した事業所の経費科目一覧を取得する
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer(int64) | 事業所ID |
| offset | query | いいえ | integer(int64) | 取得レコードのオフセット (デフォルト: 0) |
| limit | query | いいえ | integer(int64) | 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) |
レスポンス (200)
- expense_application_line_templates (必須): array[object]
配列の要素:
- id (必須): integer(int64) - 経費科目ID 例:
1(最小: 1) - source_line_template_id (必須): integer(int64) - 経費科目の元となるテンプレートを識別するID。経費科目の設定を変更しても変わらない固定値 例:
1(最小: 0) - name (必須): string - 経費科目名 例:
交通費 - account_item_id (任意): integer(int64) - 勘定科目ID 例:
1(最小: 1) - account_item_name (必須): string - 勘定科目名 例:
旅費交通費 - tax_code (任意): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - tax_name (必須): string - 税区分名 例:
課対仕入 - description (任意): string - 経費科目の説明 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意 例:
true
POST /api/1/expense_application_line_templates
操作: 経費科目の作成
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 経費科目名 (100文字以内) 例:
交通費 - account_item_id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - item_id (任意): integer(int64) - 品目ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード(税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。税区分のdisplay_categoryは /taxes/companies/{:company_id}のAPIから取得可能です。) 例:
1(最小: 0, 最大: 2147483647) - description (任意): string - 経費科目の説明 (1000文字以内) 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 (1000文字以内) 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意<br>
falseを指定した時は申請時の領収書の添付を任意とします。<br> trueを指定した時は申請時の領収書の添付を必須とします。<br> 未指定の時は申請時の領収書の添付を任意とします。 例: true
レスポンス (201)
- expense_application_line_template (必須): object
- id (必須): integer(int64) - 経費科目ID 例:
1(最小: 1) - source_line_template_id (必須): integer(int64) - 経費科目の元となるテンプレートを識別するID。経費科目の設定を変更しても変わらない固定値 例:
1(最小: 0) - name (必須): string - 経費科目名 例:
交通費 - account_item_id (任意): integer(int64) - 勘定科目ID 例:
1(最小: 1) - account_item_name (必須): string - 勘定科目名 例:
旅費交通費 - tax_code (任意): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - tax_name (必須): string - 税区分名 例:
課対仕入 - description (任意): string - 経費科目の説明 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意 例:
true
GET /api/1/expense_application_line_templates/{id}
操作: 経費科目の取得
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 経費科目ID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (200)
- expense_application_line_template (必須): object
- id (必須): integer(int64) - 経費科目ID 例:
1(最小: 1) - source_line_template_id (必須): integer(int64) - 経費科目の元となるテンプレートを識別するID。経費科目の設定を変更しても変わらない固定値 例:
1(最小: 0) - name (必須): string - 経費科目名 例:
交通費 - account_item_id (任意): integer(int64) - 勘定科目ID 例:
1(最小: 1) - account_item_name (必須): string - 勘定科目名 例:
旅費交通費 - tax_code (任意): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - tax_name (必須): string - 税区分名 例:
課対仕入 - description (任意): string - 経費科目の説明 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意 例:
true
PUT /api/1/expense_application_line_templates/{id}
操作: 経費科目の更新
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 経費科目ID |
リクエストボディ
(必須)
- company_id (必須): integer(int64) - 事業所ID 例:
1(最小: 1) - name (必須): string - 経費科目名 (100文字以内) 例:
交通費 - account_item_id (必須): integer(int64) - 勘定科目ID 例:
1(最小: 1) - item_id (任意): integer(int64) - 品目ID 例:
1(最小: 1) - tax_code (必須): integer(int64) - 税区分コード(税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。税区分のdisplay_categoryは /taxes/companies/{:company_id}のAPIから取得可能です。) 例:
1(最小: 0, 最大: 2147483647) - description (任意): string - 経費科目の説明 (1000文字以内) 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 (1000文字以内) 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意<br>
falseを指定した時は申請時の領収書の添付を任意とします。<br> trueを指定した時は申請時の領収書の添付を必須とします。<br> 未指定の時は申請時の領収書の添付を任意とします。 例: true
レスポンス (200)
- expense_application_line_template (必須): object
- id (必須): integer(int64) - 経費科目ID 例:
1(最小: 1) - source_line_template_id (必須): integer(int64) - 経費科目の元となるテンプレートを識別するID。経費科目の設定を変更しても変わらない固定値 例:
1(最小: 0) - name (必須): string - 経費科目名 例:
交通費 - account_item_id (任意): integer(int64) - 勘定科目ID 例:
1(最小: 1) - account_item_name (必須): string - 勘定科目名 例:
旅費交通費 - tax_code (任意): integer(int64) - 税区分コード 例:
1(最小: 0, 最大: 2147483647) - tax_name (必須): string - 税区分名 例:
課対仕入 - description (任意): string - 経費科目の説明 例:
電車、バス、飛行機などの交通費 - line_description (任意): string - 内容の補足 例:
移動区間 - required_receipt (任意): boolean - 添付ファイルの必須/任意 例:
true
DELETE /api/1/expense_application_line_templates/{id}
操作: 経費科目の削除
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| id | path | はい | integer(int64) | 経費科目ID |
| company_id | query | はい | integer(int64) | 事業所ID |
レスポンス (204)
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: accounting-api-schema.json
従業員のカスタム項目
概要
従業員のカスタム項目の操作
エンドポイント一覧
GET /api/v1/employees/{employee_id}/profile_custom_fields
操作: 従業員のカスタム項目の取得
説明: 概要 指定した従業員・日付のカスタム項目情報を返します。 注意点 管理者権限を持ったユーザーのみ実行可能です。 指定年月に在籍していない従業員および給与計算対象外の従業員ではデータが存在しないため、空の配列が返ります。
パラメータ
| 名前 | 位置 | 必須 | 型 | 説明 |
|---|---|---|---|---|
| company_id | query | はい | integer | 事業所ID |
| year | query | はい | integer | 従業員情報を取得したい年 |
| month | query | はい | integer | 従業員情報を取得したい月<br> |
締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が検索結果として返します。<br> 翌月払いの従業員の2022/01の従業員情報を取得する場合は、year=2021,month=12を指定してください。<br> | | employee_id | path | はい | integer | 従業員ID |
レスポンス (200)
successful operation
- profile_custom_field_groups (任意): array[object]
配列の要素:
- id (任意): integer(int32) - グループID 例:
1 - name (任意): string - グループ名 例:
資格取得結果 - profile_custom_field_rules (任意): array[object] - カスタム項目
参考情報
- freee API公式ドキュメント: https://developer.freee.co.jp/docs
- OpenAPIスキーマ: hr-api-schema.json