More Related Content
PPTX
Computer organization algorithms like addition and subtraction and multiplica... PDF
PPTX
PPTX
Crash recovery in database PDF
PPTX
Trial balance in accountancy PPTX
PPTX
What's hot
PPTX
ASTERIA WARP開発前に知っておくべき10の鉄則 PPTX
Kafka Quotas Talk at LinkedIn PPTX
Business analysis in data warehousing PDF
Static Testing vs Dynamic Testing DOCX
PDF
PPTX
[BurpSuiteJapan]Burp Suite回答編 PPTX
DOC
Error Handling in Compiler Design.typeso PPTX
Web App for Containers + Cosmos DBで コンテナ対応したMEANアプリを作ろう! PPTX
PPT
Compiler Construction introduction PPTX
Similar to 会計freee API相関図 レコード作成編 v20210507
PDF
【Shared】「freeeのapiはこう使え~apiが広げるバックオフィスの未来~」:株式会社beso白木さま・仲田さま・freee佐藤 PDF
収支の把握と共有を圧倒的に楽にする「プロジェクト管理freee」とAPIの活用例 PDF
PDF
PDF
PDF
会計freee/人事労務freeeのプロダクトアップデート PDF
APIで次のFinTechサービスをつくろう! 〜freee Dev Communityのご紹介〜 PPTX
クラウド給与計算ソフト freee (フリー) スタートガイド PDF
PDF
PPTX
Wagbyspec67 120621014818-phpapp02 PDF
PDF
PPTX
業務システムとfreeeをAPI連携する際の課題と工夫 PDF
クラウド見積・請求Office用アプリの詳細機能検討ver1 (Exceedone Cloud Office App System detail) PDF
PDF
[Shared] freee apiとアプリストアのご案内_apipf_fy22q3 PDF
PDF
PPTX
More from freee株式会社
PDF
品目/セグメント/メモタグマスタ連携ガイドライン PDF
PDF
PDF
PDF
PDF
freee会計 x POSレジサービス連携ガイドライン PDF
PDF
freee 試算表APIセミナー 2 試算表APIの活用方法 PDF
freee 試算表APIセミナー 1 freee APIの概要 PDF
【Shared】「顧問先の経理と会計を効率化するためのポイント」:freee尾籠 PDF
【Shared】「freeeの会計事務所向け開発のこれまでと、これから」:税理士法人ブラザシップ松原さま・freee高木・佐々木 PDF
【Shared】「事務所の成長に繋がるアドバイザー制度の活用方法」:荒井会計事務所豊田さま・freee出雲 PDF
【Shared】「freee advisorday2021エンディング」:freee根木 PDF
【Shared】「残業時間50%、売上200%の変革は何故できたのか?」:荒井会計事務所豊田さま PDF
【Shared】「創業50年、記帳代行のリアルタイム化で脱属人化、 何がもたらされたか?」:株式会社宮西計算センター角さま PDF
【Shared】「殺さない「事業承継」の中で変えたこと変えなかったこと」:株式会社セイワホールディングス野見山さま PDF
【Shared】「開業からリアルタイム化を武器に顧問先を急拡大! その方法とは?」:株式会社beso白木さま・仲田さま PDF
【Shared】「創業70年の会計事務所がクラウド会計を活用し、 自計化を進める理由」:ジェイシス税理士法人田中さま PDF
【Shared】「事務所全体でmasを実現し、 1人あたり売上20百万円を実現できたその理由は 」:税理士法人ブラザシップ松原さま PDF
【Shared】「freee advisorday2021オープニング」:freeeceo佐々木 会計freee API相関図 レコード作成編 v20210507
- 1.
- 2.
- 3.
freee APIで取引の作成をする
取引を作成するまでの流れとAPIリファレンスへのリンク集
deals API
取引作成
POST
詳細>勘定科目
GETAccount 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基本用語>
取引とは 口座とは タグとは
任意情報取
得、追加
- 4.
freee APIで請求書を作成する
請求書を作成するまでの流れと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
任意情報取
得、追加
- 5.
freee APIで見積書を作成する
見積書を作成するまでの流れと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
右の必須項目取得と指定
- 6.
請求・見積書作成・更新時のデータ補完(1/3)
説明 パラメータ 請求書見積書 空文字指定 キーごと指定しない 補足
請求日/見積日 issue_date ✔ ✔ 現在日付 現在日付
タイトル title ✔ ✔ 不可 テンプレートのタイトルで補完 ● 請求書、見積書テンプレートのタイトルはユーザーが任意に
変更可
● タイトルのデフォルトは、”請求書”、または”見積書”
請求書番号 invoice_number ✔ 不可 自動採番 ● キーに対して空文字を指定するとエラー(400)
見積書番号 quotation_number ✔ 不可 自動採番 ● キーに対して空文字を指定するとエラー(400)
請求書/見積書に表
示する取引先名
partner_display_na
me
✔ ✔ 不可 不可 ● キーに対して空文字を指定するとエラー(400)
● キーごと指定しないとエラー(400)
敬称 partner_title ✔
✔
不可 不可 ● キーに対して空文字を指定するとエラー(400)
● キーごと指定しないとエラー(400)
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について
freee利用者による請求・見積書に関するテンプレート、取引先の設定、共通項目の設定:
- テンプレート
- freeeで[設定 » 請求書の共通設定 » テンプレート編集]で設定
- 取引先の設定
- freeeで[設定 » 取引先の設定 » 編集]で設定
- 共通項目の設定
- freeeで[設定 » 請求書の共通設定 » 共通項目]で設定
ⓘ 次のスライドに続く
- 7.
請求・見積書作成・更新時のデータ補完(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 ✔
✔
空文字 テンプレートの連絡先で補完 ● テンプレートの連絡先はユーザーが任意に変更可
● 連絡先のデフォルトは空文字
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について
ⓘ 次のスライドに続く
- 8.
請求・見積書作成・更新時のデータ補完(3/3)
説明 パラメータ 請求書見積書 空文字指定 キーごと指定しない 補足
支払口座 payment_bank_info ✔ 空文字 テンプレートの振込先で補完 ● テンプレートの振込先はユーザーが任意に変更可
● 振込先のデフォルトは空文字
メッセージ message ✔
✔
空文字 テンプレートのメッセージで補完 ● テンプレートのメッセージはユーザーが任意に変更可
● メッセージのデフォルトは”下記の通りご請求申し上げま
す。”、”下記の通り御見積もり申し上げます。”
備考 notes ✔
✔
空文字 テンプレートの備考で補完 ● テンプレートの備考はユーザーが任意に変更可
● 備考のデフォルトは空文字
請求書レイアウト invoice_layout ✔ 不可 共通項目のレイアウトルで補完 ● キーに対して空文字を指定するとエラー(400)
● 共通項目のレイアウトはユーザーが任意に変更可
● レイアウトのデフォルトは、”レイアウト1/クラシック”
見積書レイアウト quotation_layout ✔ 不可 共通項目のレイアウトで補完 ● キーに対して空文字を指定するとエラー(400)
● 共通項目のレイアウトはユーザーが任意に変更可
● レイアウトのデフォルトは、”レイアウト1/クラシック”
リクエストパラメータと空文字指定・キーを指定しない場合のデータ補完について
- 9.
- 10.
freee APIで各種申請を作成する
各種申請レコードを作成するまでの流れとAPIリファレンスへのリンク集
approval_requests
API
各種申請作成
POST
申請日
application_date
申請フォーム
GET Approval_requests/forms
事業所ID?
各種申請作成
事業所
GETCompanies
より便利に使え
る情報追加?
(任意)
必須項目取
得済?
承認者
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の使い方>
用語とユースケース別の使い方のポイント
法人)エンタープライズプラン、プロフェッショナルプラン
- 11.
freee APIで経費申請を作成する
経費申請レコードを作成するまでの流れとAPIリファレンスへのリンク集
expense_applications API
経費申請作成
POST
申請日(yyyy-mm-dd)
issue_date
事業所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
- 12.
freee APIで支払依頼を作成する
支払依頼レコードを作成するまでの流れとAPIリファレンスへのリンク集
payment_requests API
支払依頼作成
POST
申請日(yyyy-mm-dd)
application_date
事業所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. ここまでのステップで把握できた内容をもとに新しい支払依頼レコードを作成してみましょう
任意情報取
得、追加
<freee支払依頼APIの使い方>
用語とユースケース別の使い方のポイント
申請タイトル (250文字以内)
title
支払依頼の項目行一覧(配列)
payment_requests_lines
description
section_id
tag_ids segment_#_tag_id
receipts_id
法人)エンタープライズプラン、プロフェッショナルプラン
申請フォーム別
の必須項目?
必須項目を取得
申請中で作成/下書きで作成
draft
発生日 (yyyy-mm-dd)
issue_date
項目>金額
payment_requests_lines > amount
partner_id/code
payment_date
tax_code account_item_id item_id
document_code
payment_requests_lines > description
- 13.