こんにちは、もりです！
freee取引画面の「取引データのエクスポート」で出力できる取引データのcsvを、スプレッドシートに直接出力できるツールを作ってみました。
ポイントは2点、
- csvをダウンロードすることなく、スプレッドシートに直接データを取得できる
- スプレッドシート上で「事業所切り替え」ができる
複数事業所を使用していて、他の事業所の取引データを取得する場合、画面上で「事業所切り替え → 取引画面を開く → 条件を指定してcsvダウンロード」の操作が必要ですが、このツールでは、スプレッドシート上で事業所を指定（切り替え）することができます。
Contents
取引データをスプレッドシートに出力する
スプレッドシート全体の構成です。
- スプレッドシート上で、取得したいデータの条件を設定する
- スクリプトを実行する
- データが出力される
データ取得イメージです（取引データは架空のものです）
このように、csvと同じ形式のデータをスプレッドシートに出力できます。
すぐに使えるツールを無料で配布してますので、ご希望の方はこちら（記事の末尾に移動）をご覧ください。今お使いのスプレッドシートに組み込みたい、という方は、次項の手順に沿って作ってみてくださいね。
スプレッドシートの準備
A列～R列の１行目にヘッダーを用意します（※csvファイルと一部項目が異なります。詳細は後述します）
U列・V列にパラメータ設定欄を用意します。
- 事業所名
- 収支区分（すべて / 収入 / 支出）
- 決済状況（すべて / 完了 / 未決済）
- 発生日：開始日
- 発生日：終了日
パラメータの「事業所名」は下記のいずれかの方法で作成してください。
- 名称を手入力する
- 「データの入力規則」でリストを作成する
- GASでリストを作成する
GASでリストを作成する方法はこちらを参照してください。
【freeeAPI×GAS】スプレッドシートに事業所名リスト(プルダウン)を作ってfreeeAPIの事業所切り替えをラクにするGASを使って「クラウド会計ソフトfreee」のAPIを操作するシリーズ。スプレッドシートのリストで選択した事業所名を事業所IDに変換してfreeeAPIにアクセスする方法を紹介しています。...
csvファイルとの相違点
freeeの画面で出力するcsvファイルと、下記の点が異なります。
- 「取引ID」を出力する
→「どの行が1つの取引か」が、わかるように取引IDを出力します。同一IDは1つの取引です。
- 「決済状況」を出力する
→「完了 or 未決済」を出力します。
- 「税計算区分」を出力しない
→ APIでは取得できない（？）ようです。
- 取得可能件数は100件まで
→ 対象データが100件以上ある場合、最新の100件のみを取得します。
- 1つの取引に複数行のデータがある場合の出力
→ 空欄は作らず、取引ID(A列)～取引先(G列)まで、すべて同じ値で埋めるようにしています。
取引データを取得するスクリプト
1行目の変数sheetnameにシート名を設定して、exportDeals関数を実行します。
※このスクリプトを動作させるには、同じプロジェクト内に「getService」関数と、連携アプリで発行された「Client_ID」「Client_Secret」の値を書いておく必要があります（詳細は下記記事を参照）
【freee×GAS】GoogleAppsScriptでfreeeAPIと連携認証する（サンプルコードあり）
|
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 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 |
const sheetname = '取引'; //シート名を設定 const companycell = 'V2'; //事業所名を設定するセル番地 const deals_index = { //0スタート status: 1, type: 2, partner: 6, account_item: 7, tax: 8, amount: 9, vat: 10, item: 12, section: 13, tags: 14, wallet: 16, param: 21 }; //エントリポイント function exportDeals() { const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName(sheetname); const END_COL = sheet.getRange('A1') .getNextDataCell(SpreadsheetApp.Direction.NEXT) .getColumn(); //前回取得値のクリア sheet.getRange(2, 1, sheet.getLastRow(), END_COL).clearContent(); //パラメーターの設定値を取得 const parameters = sheet.getRange(2, deals_index.param+1, 5, 1).getValues(); //リストで選択されている事業所の事業所IDを取得 const company_name = sheet.getRange(companycell).getValue(); const company_id = getCompanyId_(company_name); const obj = getDeals_(parameters,company_id); if (obj.meta.total_count) { //対象データあり if (obj.meta.total_count >= 100) { const ui = SpreadsheetApp.getUi(); ui.alert('取得結果','対象データが100件以上あります。最新100件を出力します',ui.ButtonSet.OK); } //freeeAPIから各種マスタを取得 const arrMasterData = getfreeeMasterData_(company_id); //スプレッドシートに出力 OutputDeals_(sheet, obj.deals, arrMasterData); } else { //対象データなし const ui = SpreadsheetApp.getUi(); ui.alert('取得結果','対象データが存在しません',ui.ButtonSet.OK); } } /** * 事業所名から事業所IDを返す * * @param {string} 事業所名 * @return {string} 事業所ID */ function getCompanyId_(company_name) { const accessToken = getService().getAccessToken(); const requestUrl = 'https://api.freee.co.jp/api/1/companies'; let obj = accessfreeeAPI_(accessToken,requestUrl); obj = obj.companies; let company_id; for (let i in obj) { if (obj[i].name == company_name) { company_id = obj[i].id; break; } } return company_id; } /** * 指定のURLにリクエストを送信してレスポンスを返す * * @param {string} アクセストークン * @param {string} リクエストURL * @return {object} freeeAPIのレスポンス */ function accessfreeeAPI_(accessToken,url) { Utilities.sleep(1000); //短時間の連続アクセスを回避するため待機 const params = { method : 'get', headers : {'Authorization':'Bearer ' + accessToken} }; const response = UrlFetchApp.fetch(url,params); const obj = JSON.parse(response); return obj; } /** * freeeAPIから取引データを取得する * * @param {object} リクエストURLに指定するパラメータ * @return {object} freeeAPIからのレスポンス */ function getDeals_(parameters,company_id) { let type = parameters[1][0]; //収支区分 let status = parameters[2][0]; //決済状況 let start_issue_date = parameters[3][0]; //開始日 let end_issue_date = parameters[4][0]; //終了日 if (type === '収入') { type = '&type=income'; } else if (type === '支出') { type = '&type=expense'; } else { //すべて type = ''; } if (status === '未決済') { status = '&status=unsettled'; } else if (status === '完了') { status = '&status=settled'; } else { //すべて status = ''; } start_issue_date = Utilities.formatDate(start_issue_date,'JST','yyyy-MM-dd'); end_issue_date = Utilities.formatDate(end_issue_date,'JST','yyyy-MM-dd'); const accessToken = getService().getAccessToken(); const requestUrl = 'https://api.freee.co.jp/api/1/deals?' + 'company_id=' + company_id + type + status + '&start_issue_date=' + start_issue_date + '&end_issue_date=' + end_issue_date + '&limit=100'; const obj = accessfreeeAPI_(accessToken,requestUrl); return obj; } /** * ID→名称変換用のマスタをfreeeAPIから取得する * * @param {string} 事業所ID * @return {object} ID→名称変換用マスタデータ */ function getfreeeMasterData_(company_id) { const url = 'https://api.freee.co.jp/api/1/'; //勘定科目一覧,取引先一覧,品目一覧,税区分,部門,口座 const accounts = url + 'account_items?company_id=' + company_id; const partners = url + 'partners?company_id=' + company_id; const items = url + 'items?company_id=' + company_id; const taxes = url + 'taxes/codes'; const sections = url + 'sections?company_id=' + company_id; const wallets = url + 'walletables?company_id=' + + company_id; const tags = url + 'tags?company_id=' + + company_id; const arrUrl = [accounts,partners,items,taxes,sections,wallets,tags]; const accessToken = getService().getAccessToken(); let arrObj = []; for (let i = 0; i < arrUrl.length; i++) { let requestUrl = arrUrl[i]; let obj = accessfreeeAPI_(accessToken,requestUrl); arrObj.push(obj); } const arrMasterData = [ arrObj[0].account_items, arrObj[1].partners, arrObj[2].items, arrObj[3].taxes, arrObj[4].sections, arrObj[5].walletables, arrObj[6].tags ]; return arrMasterData; } /** * 取引データをスプレッドシートに出力する * * @param {object} 出力先シート * @param {object} freeeAPIで取得した取引データ * @param {object} ID→名称変換用マスタデータ */ function OutputDeals_(sheet,objDeals,arrMasterData) { let arr = []; //スプレッドシート書き込み用の配列 for (let i = 0; i < objDeals.length; i++) { let objDeal = objDeals[i]; //i件目の取引データ /* [memo] 支払データがある場合のみpaymentsプロパティが存在する 通常はdetailsプロパティのlengthより短いが、 もし、detailsプロパティより長い場合は、 paymentsプロパティのlengthでループする */ let length = objDeal.details.length; //paymentsが存在、かつ、detailsのlengthより長ければ if ('payments' in objDeal && length < objDeal.payments.length) { length = objDeal.payments.length; } for(let j = 0; j < length; j++) { let tmp = []; //オブジェクトから必要データを抜き出して格納する一時的な配列 let v1 = objDeal.id; //取引ID let v2 = objDeal.status; //決済状況 let v3 = objDeal.type; //収支区分 let v4 = objDeal.ref_number; //管理番号 let v5 = objDeal.issue_date; //発生日 let v6 = objDeal.due_date; //支払期日 let v7 = objDeal.partner_id; //取引先ID let v8,v9,v10,v11,v12,v13,v14,v15,entry_side; //detailsプロパティ let objDetails = objDeal.details[j]; if (objDetails) { v8 = objDetails.account_item_id; //勘定科目ID v9 = objDetails.tax_code; //税区分コード v10 = objDetails.amount; //金額 v11 = objDetails.vat; //消費税額 v12 = objDetails.description; //備考 v13 = objDetails.item_id; //品目ID v14 = objDetails.section_id; //部門ID v15 = objDetails.tag_ids; //メモタグ[配列] entry_side = objDetails.entry_side; //貸借 } let v16,v17,v18,wallet_type; //paymentsプロパティ if ('payments' in objDeal) { //paymentsプロパティがあれば let objPayment = objDeal.payments[j]; if (objPayment) { v16 = objPayment.date; //支払日 v17 = objPayment.from_walletable_id; //口座ID v18 = objPayment.amount; //金額 wallet_type = objPayment.from_walletable_type; //口座区分 } } //1行分のデータを仮の配列に格納 tmp.push(v1,v2,v3,v4,v5,v6,v7,v8,v9,v10,v11,v12,v13,v14,v15,v16,v17,v18); tmp = convertArrayData_(tmp,arrMasterData,entry_side,wallet_type); //スプレッドシート書き込み用の配列に格納 arr.push(tmp); } } sheet.getRange(2, 1, arr.length, arr[0].length).setValues(arr); } /** * 取引データをスプレッドシート出力用の文字列に変換する * * @param {object} 変換前の取引データ * @param {object} ID→名称変換用マスタデータ * @param {string} 貸借 * @param {string} 口座区分 * @return {object} 変換後の取引データ */ function convertArrayData_(arr,arrMasterData,entry_side,wallet_type) { let type = arr[deals_index.type]; //収入or支出 let status = arr[deals_index.status]; //完了or未決済 /********** マイナス金額に変換 **********/ //支出かつentry_side=creditなら、金額と税額をマイナスにする if (type === 'expense' && entry_side === 'credit') { arr[deals_index.amount] = -(arr[deals_index.amount]); arr[deals_index.vat] = -(arr[deals_index.vat]); } //収入かつentry_side=debitなら、金額と税額をマイナスにする if (type === 'income' && entry_side === 'debit') { arr[deals_index.amount] = -(arr[deals_index.amount]); arr[deals_index.vat] = -(arr[deals_index.vat]); } /***** アルファベット表記を日本語に変換 *****/ if (type === 'income') { arr[deals_index.type] = '収入'; } else if (type === 'expense') { arr[deals_index.type] = '支出'; } if (status === 'settled') { arr[deals_index.status] = '完了'; } else if (status === 'unsettled') { arr[deals_index.status] = '未決済'; } /********** IDを名称に変換 **********/ //勘定科目ID -> 勘定科目名 const objAccountItems = arrMasterData[0]; let account_item_id = arr[deals_index.account_item]; let account_item_name = fromIdToName_(objAccountItems,account_item_id); arr[deals_index.account_item] = account_item_name; //取引先ID -> 取引先名 const objPartners = arrMasterData[1]; let partner_id = arr[deals_index.partner]; let partner_name = fromIdToName_(objPartners,partner_id); arr[deals_index.partner] = partner_name; //品目ID -> 品目名 const objItems = arrMasterData[2]; let item_id = arr[deals_index.item]; let item_name = fromIdToName_(objItems,item_id); arr[deals_index.item] = item_name; //税区分コード -> 名称 const objTaxes = arrMasterData[3]; let tax_code = arr[deals_index.tax]; let tax_name = fromTaxCodeToName_(objTaxes,tax_code); arr[deals_index.tax] = tax_name; //部門ID -> 部門名 const objSections = arrMasterData[4]; let section_id = arr[deals_index.section]; let section_name = fromIdToName_(objSections,section_id); arr[deals_index.section] = section_name; //口座ID -> 口座名 const objWalletables = arrMasterData[5]; let walletable_id = arr[deals_index.wallet]; let walletable_name; //口座IDがprivate_account_itemの場合はwalletable_idに勘定科目IDが入ってる if (wallet_type == 'private_account_item') { walletable_name = fromIdToName_(objAccountItems,walletable_id); } else { walletable_name = fromIdToName_(objWalletables,walletable_id); } arr[deals_index.wallet] = walletable_name; //メモタグID -> メモタグ const objTags = arrMasterData[6]; const tagIds = arr[deals_index.tags]; const tagNames = convertTagIdsToTagNames_(objTags, tagIds); arr[deals_index.tags] = tagNames; return arr; } /** * メモタグID(配列)をひとつずつ名称に変換してカンマ区切り文字列で返す * * @param {object} メモタグ一覧 * @param {object} メモタグIDの配列 * @return {string} メモタグの文字列(カンマ区切り) */ function convertTagIdsToTagNames_(objTags, tagIds) { let tagNames = []; for (let i in tagIds) { let tag_id = tagIds[i]; let name = fromIdToName_(objTags,tag_id); tagNames.push(name); } tagNames = tagNames.join(','); return tagNames; } /** * IDから名称を返す(例:勘定科目ID -> 勘定科目名) * * @param {string} ID * @return {string} 日本語名 */ function fromIdToName_(obj,id) { let name = ''; for (let i in obj) { if (obj[i].id == id) { //税区分コード以外 name = obj[i].name; break; } } return name; } /** * 税区分コードから日本語名を返す * * @param {string} 税区分コード * @return {string} 税区分名称 */ function fromTaxCodeToName_(obj,code) { let name = ''; for (let i in obj) { if (obj[i].code == code) { name = obj[i].name_ja; break; } } return name; } |
独自メニューを追加するスクリプト
スクリプトエディタを開かずに、スプレッドシートでスクリプトを実行できるよう「独自メニュー」を追加しておくとよいでしょう。
スプレッドシートを開いた時に起動するイベントonOpenを、同じプロジェクト内に記述します。
|
1 2 3 4 5 6 7 8 9 |
function onOpen(){ const menu = [ {name: '取引データのエクスポート', functionName: 'exportDeals'} ]; SpreadsheetApp.getActiveSpreadsheet().addMenu('freeeメニュー', menu); } |
【無料】スプレッドシートを配布してます
すぐに使えるスプレッドシート【スクリプト付き】を配布しています。下記のリンクをクリックすると、スプレッドシートに遷移します。「閲覧のみ」に権限設定しているので、コピーしてご利用ください。
※連携アプリの作成、認証はご自身で行っていただく必要があります。手順は下記記事をご覧ください。
【freee×GAS】GoogleAppsScriptでfreeeAPIと連携認証する（サンプルコードあり）GoogleAppsScriptを使用して、クラウド会計ソフトfreeeのAPI連携が可能です。freee連携アプリの登録方法、認証方法、サンプルコードを紹介しています。...
