目次

• Visual Basic for Applications(VBA)について

• Excelとの連携の活用例
  - 各種データのインポート・エクスポートをファイルから直接行う
  - Excelの帳票データをfreeeへ送信する

• サンプルコード
  - GETリクエスト
  - POSTリクエスト

• サンプルファイル
  - [freee]連携お試しファイル
  - [freee]取引を送信
  - ファイル

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

詳しくはfreee APIドキュメントをご参照ください。

 

サンプルコード

VBAからfreee APIへリクエストするサンプルコードです。freee APIドキュメントを参照し、任意の機能をお使いください。

アクセストークン取得のサンプルコードはこちら

GETリクエスト

GETリクエストのサンプルコードです。
外部のJSONパーサーを使用しています。

下記の要素については、開発するアプリケーションの環境に合わせ、適宜置き換えて用いてください。

要素	内容	例 （事業所一覧の場合）
ACCESS_TOKEN	取得した有効なアクセストークン （アクセストークンの取得についてはこちら）	"XXXXXXXXXXXXXXXXXXXXXXXX"
ENDPOINT	GETリクエストするURIエンドポイント	"https://api.freee.co.jp/api/1/companies"
TARGET_SHEET	取得データを保存する任意のシート名	（例）"口座一覧"
ARRAY_NAME	取得データの配列名	"companies"
PARAM_NAME	取得データのパラメーター名	"id","name","name_kana","display_name","role"

Public Sub GETサンプルコード()
    Dim msxml2Object As Object
    Set msxml2Object = CreateObject("MSXML2.XMLHTTP")
    
    Dim accessToken As String
    accessToken = ACCESS_TOKEN
    REQUEST_URL = ENDPOINT
    
    'freeeAPIにアクセスし、GETリクエストを送信
    With msxml2Object
        .Open "GET", REQUEST_URL, False
        .setRequestHeader "Authorization", "Bearer " & accessToken
        .setRequestHeader "Content-Type", "application/json"
        .send
        Select Case .Status
          Case 200
               Dim response As String
               response = .responsetext
          Case 400
               MsgBox ("エラー" & vbCrLf & "不正なリクエストです")
               Exit Sub
          Case 401
               MsgBox ("エラー" & vbCrLf & "アクセス権限がありません")
               Exit Sub
          Case 404
               MsgBox ("エラー" & vbCrLf & "リクエストを送信したAPIが存在しません")
               Exit Sub
          Case Else
               MsgBox ("エラー" & vbCrLf & "その他のエラー")
               Exit Sub
        End Select
    End With
    
    'シートにレスポンスを保存
    targetSheetName = TARGET_SHEET
    targetSheet = WorkSheets(targetSheetName)
    Dim responseJson As Object
    Set responseJson = JsonConverter.ParseJson(response)
    Dim responseDictionary As Dictionary

    rowNumber = 1
    For Each companyDictionary In responseJson(ARRAY_NAME)
      targetSheetCompanies.Cells(rowNumber, 1) = responseDictionary(PARAM_NAME1)
      targetSheetCompanies.Cells(rowNumber, 2) = responseDictionary(PARAM_NAME2)
      targetSheetCompanies.Cells(rowNumber, 3) = responseDictionary(PARAM_NAME3)
      targetSheetCompanies.Cells(rowNumber, 4) = responseDictionary(PARAM_NAME4)
      targetSheetCompanies.Cells(rowNumber, 5) = responseDictionary(PARAM_NAME5)
    rowNumber = rowNumber + 1
    Next responseDictionary
    Set msxml2Object = Nothing
End Sub

※動作保証対象外

 

POSTリクエスト

POSTリクエストのサンプルコードです。
下記の要素については、開発するアプリケーションの環境に合わせ、適宜置き換えて用いてください。

要素	内容	例 （勘定科目作成の場合）
ACCESS_TOKEN	取得した有効なアクセストークン （アクセストークンの取得についてはこちら）	"XXXXXXXXXXXXXXXXXXXXXXXX"
ENDPOINT	POSTリクエストするURIエンドポイント	"https://api.freee.co.jp/api/1/account_items"
REQUEST_BODY	POSTするデータ	"{ "company_id" : XXXXXXX, "account_item" : { "name" : "新しい勘定科目", "shortcut" : "NEWACCOUNTITEM", "shortcut_num" : "999", "tax_name" : "課税売上", "group_name" : "その他預金", "account_category" : "現金・預金", "corresponding_income_name" : "売掛金", "corresponding_expense_name" : "買掛金" } }" ※XXXXXXX= 任意の事業所のcompany_id

Public Sub POSTサンプルコード()
    Dim accessToken as String
    accessToken = ACCESS_TOKEN
    REQUEST_URL = ENDPOINT
    requestBody = REQUEST_BODY
    
    Dim msxml2Object As Object
    Set msxml2Object = CreateObject("MSXML2.XMLHTTP")
    
    'freeeAPIにアクセスし、POSTリクエストを送信
    With msxml2Object
        .Open "POST", REQUEST_URL, False
        .setRequestHeader "Authorization", "Bearer " & accessToken
        .setRequestHeader "Content-Type", "application/json"
        .send requestBody
        Select Case .Status
          Case 201
               MsgBox ("リクエスト成功"）
               Exit Sub
          Case 400
               MsgBox ("エラー" & vbCrLf & "不正なリクエストです")
               Exit Sub
          Case 401
               MsgBox ("エラー" & vbCrLf & "アクセス権限がありません")
               Exit Sub
          Case 404
               MsgBox ("エラー" & vbCrLf & "リクエストを送信したAPIが存在しません")
               Exit Sub
          Case Else
               MsgBox ("エラー" & vbCrLf & "その他のエラー")
               Exit Sub
        End Select
    End With
End Sub

※動作保証対象外

 

サンプルファイル

 [freee]連携お試しファイル

Excel×freeeの連携の概要を確認できます。具体的には認証・事業所一覧の取得・勘定科目の作成を行えます。
コード公開verを利用する際はfreee APIへのアプリケーションの登録が必要です。

[freee]取引を送信

取引インポート形式で入力されたデータをfreeeに送信するファイルです。
このファイルで登録された取引は、会計freee側で手動で登録された取引として扱われます。
※freeeログインURLの変更に伴い、2018-02-05以前のバージョンでは連携機能がご使用になれません。最新版をダウンロードし、お使いください。

 

ファイル