ページを印刷|
対象プラン
|
法人プラン | ✓ミニマム | ✓ベーシック | ✓プロフェッショナル | ✓エンタープライズ |
| 個人プラン | ✓スターター | ✓スタンダード | ✓プレミアム |
【注意】本ページはソフトウェア開発者向けのページです
freee APIは、freeeの機能を外部のプログラムから利用するためのインターフェースです。Visual Basic for Applications(VBA)からfreee APIを利用し、Excelと連携することが可能です。
最新のAPI仕様は「 会計APIリファレンス Version: 2020-06-15 」で公開しています。（検証用のfreeeアカウントについては「 freee API スタートガイド 」をご確認ください。）
freee API
目次
- Visual Basic for Applications(VBA)について
- Excelとの連携の活用例
- 各種データのインポート・エクスポートをファイルから直接行う
- Excelの帳票データをfreeeへ送信する - Excelとの連携を開発する
- 開発の全体像
- freee APIと通信する機能の仕様
- 3. リクエストに必要な情報
Visual Basic for Applications(VBA)について
Visual Basic for Applications(VBA)はExcelなどのMicrosoft Officeアプリケーションを操作できるプログラミング言語です。Microsoft OfficeアプリケーションにはVBAのコード作成・編集ソフトが最初から付属しているため、環境設定の必要がなく簡単にプログラムを作成できます。
VBAからfreee APIにリクエストを送信することで、Excelとfreeeの間でデータのやりとりが可能です。
※VBAで記述されたExcel操作機能をExcelマクロといいます。
Excelとの連携の活用例
各種データのインポート・エクスポートをファイルから直接行う
freeeでは勘定科目・口座・取引先・部門といったデータをCSV形式でインポート・エクスポートすることができますが、CSV形式に変換せずにExcelとfreeeの間で直接データのやりとりができます。
現在、勘定科目・補助科目（取引先・品目）・部門をインポートするfreeeのExcelアドインがあります。（Excelからfreeeに勘定科目・補助科目・部門を取り込む）
Excelの帳票データをfreeeへ送信する
Excelで作成している帳票がfreeeに直接インポートできない形式の場合、通常は帳票を見ながらfreeeに転記する作業が必要になります。
Excelの帳票データから必要な情報を抽出し、「取引」や「明細」としてfreeeへ送信することで、帳票データの送信が可能です。今まで使用していたExcelの帳票をそのまま使用しながら、データをfreeeへ送信できます。
Excelとの連携を開発する
開発の全体像
Excelとの連携は大きく２つの機能に分けられます。１つは、freee APIと通信し、freee形式のデータをやりとりする機能。もう１つは、Excelのデータ/freee形式のデータを変換する機能です。
freee APIと通信する機能はデータ形式が定められているため、以下のページを参考に開発することができます。一方、Excelのデータは用途などにより形式が異なるため、Excelのデータ/freee形式のデータ間の変換は個別に開発する必要があります。
freee APIと通信する機能の仕様
Excelとの連携の基本となるfreee APIと通信する機能は、主に以下の手順で行います。
1. freee APIへアプリケーションを登録
2. 認証
3. アクセストークンを取得
4. トークンの有効期限(発行後24h)が切れた場合トークンをリフレッシュ
5. リクエストに必要な情報を事前に取得
※「3. アクセストークンを取得」まではヘルプページ「 freee APIのアクセストークンを取得する 」を参考にしてください。
（例）取引の登録の場合
取引の登録(deals,POST)の場合、アクセストークンの他に事業所ID・勘定科目ID・取引先ID・品目ID・部門ID・メモタグID・口座IDが必要になるため、事前にそれらの情報を取得します。
3. リクエストに必要な情報
freee APIの各リクエストに事前に取得する必要がある情報は以下の通りです。
|
リクエスト |
リクエスト内容 |
事前に取得する必要のある情報 |
|
|
Account items |
GET /api/1/account_items |
勘定科目一覧の取得 |
事業所ID |
|
POST /api/1/account_items |
勘定科目の作成 |
事業所ID・税区分・相手勘定科目・勘定科目カテゴリー |
|
|
Banks |
GET /api/1/banks |
連携サービス一覧の取得 |
なし |
|
Companies |
GET /api/1/companies |
事業所一覧の取得 |
なし |
|
GET /api/1/companies/:id |
事業所の詳細情報の取得 |
事業所ID |
|
|
PUT /api/1/companies/:id |
事業所情報の更新 |
事業所ID |
|
|
Deals |
GET /api/1/deals |
取引（収入／支出）一覧の取得 |
事業所ID |
|
POST /api/1/deals |
取引（収入／支出）の作成 |
事業所ID・取引先ID・勘定科目ID・税区分コード・品目ID・部門ID・メモタグID・口座ID |
|
|
Items |
GET /api/1/items |
品目一覧の取得 |
事業所ID |
|
POST /api/1/items |
品目の作成 |
事業所ID |
|
|
Jounals |
GET /api/1/journals |
ダウンロード要求 |
事業所ID |
|
GET /api/1/journals/reports/:id/status |
ステータス確認 |
事業所ID |
|
|
GET /api/1/journals/reports/:id/download |
ダウンロード実行 |
事業所ID |
|
|
Partners |
GET /api/1/partners |
取引先一覧の取得 |
事業所ID |
|
POST /api/1/partners |
取引先の作成 |
事業所ID |
|
|
Sections |
GET /api/1/sections |
部門一覧の取得 |
事業所ID |
|
POST /api/1/sections |
部門の作成 |
事業所ID |
|
|
Selectables |
GET /api/1/forms/selectables |
フォーム用選択項目情報の取得 |
事業所ID |
|
Tags |
GET /api/1/tags |
メモタグ一覧の取得 |
事業所ID |
|
POST /api/1/tags |
メモタグの作成 |
事業所ID |
|
| Taxes |
GET /api/1/taxes/codes |
税区分コード一覧の取得 |
なし |
|
Transfers |
GET /api/1/transfers |
取引（振替）一覧の取得 |
事業所ID |
|
POST /api/1/transfers |
取引（振替）の作成 |
事業所ID・口座ID |
|
|
Users |
GET /api/1/users/me |
ログインユーザ情報の取得 |
なし |
|
GET /api/1/users/capabilities |
ログインユーザの権限の取得 |
事業所ID |
|
|
Wallet txns |
GET /api/1/wallet_txns |
明細一覧の取得 |
事業所ID・口座ID |
|
POST /api/1/wallet_txns |
明細の作成 |
事業所ID・口座ID |
|
|
Walletables |
GET /api/1/walletables |
口座一覧の取得 |
事業所ID |
|
POST /api/1/walletables |
口座の作成 |
事業所ID |
|
詳しくは「 会計APIリファレンス Version: 2020-06-15 」をご参照ください。