freee会計 API相関図 レコード作成編 2022年3月

1. freee会計 API相関図
レコード作成編
2022.03.02

2. 2
取引
振替伝票
請求書
見積書
各種申請
経費精算
支払依頼
この資料に含まれるエンドポイント
01 02 03

3. 3
凡例と読み方
事業所
GET Companies
発生日
issue_date
アクセストークン取得し
たユーザーに取引の作成
権限がない
CompaniesというEndpointをGETメソッドでコールして、情報を取得
します。取得できたIDや値を利用してください。
issue_dateというプロパティにAPIリファレンスにある型に応じた値を
入れてください。
入力必須のパラメータとなります。
エラーの説明と解決策へのリンクを含んでいます。権限には大きくわけ
て二つあり、freeeのアカウント、ユーザーに紐づく権限と、アプリ
（APIをコールするOauthクライアント）のOauth2.0におけるスコープ
による権限があります。
item_idというfreeeをより便利につかうための任意で利用できるプロパ
ティです。APIリファレンスにある型に応じた値を入れてください。
品目
item_id
<freee基本用語>
取引とは 口座とは タグとは
色と記載内容に応じて読み進めてください

4. 4
freee APIで取引の作成をする
deals API
取引作成
POST
詳細>勘定科目
GET Account Items
取引先
partner_id/code
支払行一覧>口座ID
GET Walletables
品目
item_id
メモタグ(Tags)
tag_ids
ファイルボックス
receipts_id
事業所ID？
部門
section_id
セグメントタグ(Segments)
segment_#_tag_id
取引作成
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、取引の参照、
作成がない
アクセストークン取得し
たユーザーに取引の作成
権限がない
事業所
GET Companies
上記エラー別に確認を行い、
リトライしてください
より便利に使
える情報追
加？(任意)
必須項目取
得済？
税区分
GET Taxes
YES
YES
Status code
403
Status code：401
ⓘ 緑四角や最後のアクションのところからAPIリファレンスやWebページにリンクを張っています
発生日
issue_date
収支区分
type
詳細>取引金額
details > amount
支払行一覧>支払金額
payments > amount
支払行一覧>口座区分
GET Walletables
支払行一覧>支払日
payments > date
<freee基本用語>
取引とは 口座とは タグとは
任意情報取
得、追加
取引を作成するまでの流れとAPIリファレンスへのリンク集

5. 5
freee APIで請求書を作成する
invoices API
請求書作成
POST
請求内容>順序
invoice_contents > order
ステータス
invoice_status
請求内容>行の種類
invoice_contents > type
請求書作成
請求書名
title
ⓘ 緑四角や最後のアクションのところからAPIリファレンスやWebページにリンクを張っています
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、請求書の参照、
作成がない
アクセストークン取得し
たユーザーに請求書の作
成権限がない
上記エラー別に確認を行い、
リトライしてください
Status code
403
Status code：401
品目
item_id
メモタグ(Tags)
tag_ids
事業所ID？
セグメントタグ(Segments)
segment_#_tag_id
事業所
GET Companies
より便利に使
える情報追
加？(任意)
必須項目取
得済？
YES
● normal
● discount
右の必須項目取得と指定
type？
YES
text
請求内容>数量
invoice_contents > qty
請求内容>単価
invoice_contents. > unit_price
勘定科目
GET Account Items
税区分
GET Taxes
部門
section_id
取引先
partner_id/code
請求書に表示する取引先名
partner_display_name
敬称
partner_title
任意情報取
得、追加
請求書を作成するまでの流れとAPIリファレンスへのリンク集

6. 6
freee APIで見積書を作成する
quotations API
見積書作成
POST
見積内容>順序
quotation_contents > order
ステータス
quotation_status
見積内容>行の種類
quotation_contents > type
品目
item_id
メモタグ(Tags)
tag_ids
事業所ID？
セグメントタグ(Segments)
segment_#_tag_id
見積書作成
事業所
GET Companies
より便利に使
える情報追
加？(任意)
必須項目取
得済？
見積書名
title
YES
任意情報取
得、追加
ⓘ 緑四角や最後のアクションのところからAPIリファレンスやWebページにリンクを張っています
取引先
partner_id/code
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、見積書の参照、
作成がない
アクセストークン取得し
たユーザーに見積書の作
成権限がない
上記エラー別に確認を行い、
リトライしてください
Status code
403
Status code：401
見積書に表示する取引先名
partner_display_name
敬称
partner_title
type？
YES
text
見積内容>数量
quotation_contents > qty
見積内容>単価
quotation_contents. > unit_price
勘定科目
GET Account Items
税区分
GET Taxes
部門
section_id
● normal
● discount
右の必須項目取得と指定
見積書を作成するまでの流れとAPIリファレンスへのリンク集

7. 7
請求・見積書作成・更新時のデータ補完（1/3）
説明 パラメータ 請求書 見積書 空文字指定 キーごと指定しない 補足
請求日/見積日 issue_date ✔ ✔ 現在日付 現在日付
タイトル title ✔ ✔ 不可 テンプレートのタイトルで補完 ● 請求書、見積書テンプレートのタイトルはユーザーが任意に変更可
● タイトルのデフォルトは、”請求書”、または”見積書”
請求書番号 invoice_number ✔ 不可 自動採番 ● キーに対して空文字を指定するとエラー（400）
見積書番号 quotation_number ✔ 不可 自動採番 ● キーに対して空文字を指定するとエラー（400）
請求書/見積書に表示
する取引先名
partner_display_name ✔ ✔ 不可 不可 ● キーに対して空文字を指定するとエラー（400）
● キーごと指定しないとエラー（400）
敬称 partner_title ✔ ✔ 不可 不可 ● キーに対して空文字を指定するとエラー（400）
● キーごと指定しないとエラー（400）
freee利用者による請求・見積書に関するテンプレート、取引先の設定、共通項目の設定：
- テンプレート
- freeeで[設定 » 請求書の共通設定 » テンプレート編集]で設定
- 取引先の設定
- freeeで[設定 » 取引先の設定 » 編集]で設定
- 共通項目の設定
- freeeで[設定 » 請求書の共通設定 » 共通項目]で設定
ⓘ 次のスライドに続く
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について

8. 8
請求・見積書作成・更新時のデータ補完（2/3）
説明 パラメータ 請求書 見積書 空文字指定 キーごと指定しない 補足
取引先郵便番号 partner_zipcode ✔ ✔ 空文字 取引先の設定の郵便番号で補完
取引先都道府県コー
ド
partner_prefecture_code ✔ ✔ 不可 取引先の設定の都道府県で補完 型がintのため空文字指定不可
取引先市区町村・番
地
partner_address1 ✔ ✔ 空文字 取引先の設定の市区町村・番地で補完
取引先建物名・部屋
番号など
partner_address2 ✔ ✔ 空文字 取引先の設定の建物名・部屋番号などで補完
取引先担当者名 parnter_contact_info ✔ ✔ 空文字 取引先の設定の担当者名で補完
事業所名 company_name ✔ ✔ 不可 事業所設定情報で補完
郵便番号 company_zipcode ✔ ✔ 空文字 事業所設定情報で補完
都道府県コード company_prefecture_code ✔ ✔ 不可 事業所設定情報で補完 型がintのため空文字指定不可
市区町村名・番地 company_address1 ✔ ✔ 空文字 事業所設定情報で補完 事業所設定情報の都道府県と市区町村・番地がスペース区切りで入
る
例）東京都 品川区五反田2-8-1
建物名・部屋番号な
ど
company_address2 ✔ ✔ 空文字 事業所設定情報で補完
事業所担当者名 company_contact_info ✔ ✔ 空文字 テンプレートの連絡先で補完 ● テンプレートの連絡先はユーザーが任意に変更可
● 連絡先のデフォルトは空文字
ⓘ 次のスライドに続く
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について

9. 9
請求・見積書作成・更新時のデータ補完（3/3）
説明 パラメータ 請求書 見積書 空文字指定 キーごと指定しない 補足
支払口座 payment_bank_info ✔ 空文字 テンプレートの振込先で補完 ● テンプレートの振込先はユーザーが任意に変更可
● 振込先のデフォルトは空文字
メッセージ message ✔ ✔ 空文字 テンプレートのメッセージで補完 ● テンプレートのメッセージはユーザーが任意に変更可
● メッセージのデフォルトは”下記の通りご請求申し上げます。”、”下
記の通り御見積もり申し上げます。”
備考 notes ✔ ✔ 空文字 テンプレートの備考で補完 ● テンプレートの備考はユーザーが任意に変更可
● 備考のデフォルトは空文字
請求書レイアウト invoice_layout ✔ 不可 共通項目のレイアウトルで補完 ● キーに対して空文字を指定するとエラー（400）
● 共通項目のレイアウトはユーザーが任意に変更可
● レイアウトのデフォルトは、”レイアウト１/クラシック”
見積書レイアウト quotation_layout ✔ 不可 共通項目のレイアウトで補完 ● キーに対して空文字を指定するとエラー（400）
● 共通項目のレイアウトはユーザーが任意に変更可
● レイアウトのデフォルトは、”レイアウト１/クラシック”
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について

10. 10
freee APIで振替伝票を作成する
manual_journals API
振替伝票
POST
事業所ID？
振替伝票作成
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、振替伝票の参
照、作成がない
アクセストークン取得し
たユーザーに振替伝票の
作成権限がない
上記エラー別に確認を行い、
リトライしてください
より便利に使
える情報追
加？(任意)
必須項目取
得済？
詳細>税区分
GET Taxes
YES
YES
Status code
403
Status code：401
ⓘ 緑四角や最後のアクションのところからAPIリファレンスやWebページにリンクを張っています
取引先
partner_id/code
詳細>勘定科目
GET Account Items
発生日
issue_date
貸借
details > entry_side
詳細>取引金額
details > amount
事業所
GET Companies
品目
item_id
メモタグ(Tags)
tag_ids
部門
section_id
セグメントタグ(Segments)
segment_#_tag_id
任意情報取得、
追加
振替伝票を作成するまでの流れとAPIリファレンスへのリンク集

11. 11
freee APIで各種申請を作成する
approval_requests
API
各種申請作成
POST
申請フォーム
GET Approval_requests/forms
事業所ID？
各種申請作成
事業所
GET Companies
より便利に使
える情報追
加？(任意)
必須項目取
得済？
承認者
GET Approval flow routes
YES
申請経路
GET Approval flow routes
申請中で作成/下書きで作成
draft
親申請
parent_id
項目>項目ID
GET Approval_requests/forms
項目>項目タイプ
GET Approval_requests/forms
項目>項目の値
request_items > value
申請フォーム
別の必須項
目？
YES
承認者の指定
が必要な申請
経路？
承認者を取得
NO
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、各種申請の参
照、作成がない
アクセストークン取得し
たユーザーに各種申請の
作成権限がない
上記エラー別に確認を行い、
リトライしてください
Status code
403
Status code：401
必須項目を取得
[APIで申請レコードを登録する前に]
以下に沿って流れをつかむ、必要情報を理解することを推奨します
1. 会計freee Webで[APIテスト用の]各種申請フォーム作成、申請経路作成、申請レコード作成する
○ APIとレスポンスの関係をつかみやすくするため
2. 各種申請レコードの取得API（Show）：作成した個別の申請をGETして、レスポンスを確認する
○ 申請フォーム、申請経路、承認者などの関係性を把握
3. ここまでのステップで把握できた内容をもとに新しい各種申請レコードを作成してみましょう
任意情報取得、追加
<freee各種申請APIの使い方>
用語とユースケース別の使い方のポイント
法人）エンタープライズプラン、プロフェッショナルプラン
各種申請レコードを作成するまでの流れとAPIリファレンスへのリンク集

12. 12
freee APIで経費申請を作成する
expense_applications API
経費申請作成
POST
事業所ID？
経費申請作成
事業所
GET Companies
より便利に使
える情報追
加？(任意)
必須項目取
得済？
承認者
GET Approval flow routes
YES
申請経路
GET Approval flow routes
親申請
parent_id
下書きステー
タス（draft）
で作成？
YES
承認者の指定
が必要な申請
経路？
承認者を取得
NO
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、経費申請の参
照、作成がない
アクセストークン取得し
たユーザーに各種申請の
作成権限がない
上記エラー別に確認を行い、
リトライしてください
Status code
403
Status code：401
[APIで申請レコードを登録する前に]
以下に沿って流れをつかむ、必要情報を理解することを推奨します
1. 会計freee Webで[APIテスト用の]申請経路作成、申請レコード作成する
○ APIとレスポンスの関係をつかみやすくするため
2. 経費申請レコードの取得API（Show）：作成した個別の申請をGETして、レスポンスを確認する
○ 申請経路、承認者などの関係性を把握
3. ここまでのステップで把握できた内容をもとに新しい経費申請レコードを作成してみましょう
法人）エンタープライズプラン、プロフェッショナルプラン、ベーシックプラン
個人）プレミアムプラン
任意情報取
得、追加
<freee経費申請APIの使い方>
用語とユースケース別の使い方のポイント
申請タイトル (250文字以内)
title
経費申請の項目行一覧（配列）
expense_application_lines
● true
● 未指定
● false
右の必須項目取得と指定
項目>日付 (yyyy-mm-dd)
expense_application_lines > transaction_date
項目>内容 (250文字以内)
expense_application_lines > description
項目>金額
expense_application_lines > amount
申請フォームの設定で「入力の必須化」をした項目
description section_id
tag_ids segment_#_tag_id
expense_application_line_template_id
ファイルボックス
receipts_id
経費申請レコードを作成するまでの流れとAPIリファレンスへのリンク集

13. 13
freee APIで支払依頼を作成する
payment_requests API
支払依頼作成
POST
事業所ID？
支払依頼作成
事業所
GET Companies
より便利に使
える情報追
加？(任意)
必須項目取
得済？
承認者
GET Approval flow routes
YES
申請経路
GET Approval flow routes
親申請
parent_id
YES
承認者の指定
が必要な申請
経路？
承認者を取得
NO
指定した事業所が正しく
ない
アクセストークンが無効/
有効期限切れ
アプリのスコープに事業
所の参照、支払依頼の参
照、作成がない
アクセストークン取得し
たユーザーに各種申請の
作成権限がない
上記エラー別に確認を行い、
リトライしてください
Status code
403
Status code：401
[APIで申請レコードを登録する前に]
以下に沿って流れをつかむ、必要情報を理解することを推奨します
1. 会計freee Webで[APIテスト用の]申請経路作成、申請レコード作成する
○ APIとレスポンスの関係をつかみやすくするため
2. 支払依頼レコードの取得API（Show）：作成した個別の申請をGETして、レスポンスを確認する
○ 申請経路、承認者などの関係性を把握
3. ここまでのステップで把握できた内容をもとに新しい支払依頼レコードを作成してみましょう
申請タイトル (250文字以内)
title
発生日 (yyyy-mm-dd)
issue_date
任意情報取
得、追加
<freee支払依頼APIの使い方>
用語とユースケース別の使い方のポイント
支払依頼の項目行一覧（配列）
payment_requests_lines
description
section_id
tag_ids segment_#_tag_id
receipts_id
法人）エンタープライズプラン、プロフェッショナルプラン
申請フォーム
別の必須項
目？
必須項目を取得
申請中で作成/下書きで作成
draft
項目>金額
payment_requests_lines > amount
partner_id/code
payment_date
tax_code account_item_id item_id
document_code
payment_requests_lines > description
支払依頼レコードを作成するまでの流れとAPIリファレンスへのリンク集

14. スモールビジネスを、
世界の主役に。