【freeeAPI×GAS】指定条件の振替伝票をスプレッドシートに取得する【逆仕訳一括作成ツール①】

こんにちは、もりです！

クラウド会計ソフトfreeeのAPIを使って、freeeの操作を自動化するシリーズ。合計2回の連載で「振替伝票の逆仕訳を一括作成するツール」を作ります。

今回は、指定条件の振替伝票を一括取得してスプレッドシートに出力するスクリプトを紹介します。

※この記事で紹介するスクリプトを動作させるには、freeeAPIの連携アプリの作成と認証が済んでいることを前提としています。

詳しくは下記記事をご覧ください。

【freee×GAS】GoogleAppsScriptでfreeeAPIと連携認証する（サンプルコードあり）GoogleAppsScriptを使用して、クラウド会計ソフトfreeeのAPI連携が可能です。freee連携アプリの登録方法、認証方法、サンプルコードを紹介しています。...

Contents

逆仕訳一括作成ツール
- 【動画】ツールの使い方（処理の流れ）
freeeに登録済みの振替伝票をスプレッドシートに出力する

逆仕訳一括作成ツール

逆仕訳（反対仕訳）とは、貸借を逆に起票する仕訳です。伝票仕訳を間違えた時の訂正や、決算整理仕訳の戻入で作りますね。

【動画】ツールの使い方（処理の流れ）

freeeの振替伝票を使用した「逆仕訳」の作成は、下記の流れで行います。

逆仕訳一括作成の流れ

freeeに登録済みの振替伝票をスプレッドシートに出力する【API使用】
スプレッドシート上で日付を書き換える【手作業】
スプレッドシートのデータを貸借入替でfreeeに登録する【API使用】

詳細は操作デモをご覧ください。※再生すると解説の音声が出るのでご注意ください！

freeeに登録済みの振替伝票をスプレッドシートに出力する

この記事では、全体の流れのなかで「freeeに登録済みの振替伝票をスプレッドシートに出力する【API使用】」の部分を作ります。

逆仕訳一括作成の流れ

freeeに登録済みの振替伝票をスプレッドシートに出力する【API使用】←今回はココを作る
スプレッドシート上で日付などを書き換える【手作業】
スプレッドシートのデータを貸借入替でfreeeに登録する【API使用】

【事前準備】スプレッドシートの準備

スプレッドシートに「取得項目」と「パラメータ」を設定する枠を用意します。セルの色は下記の意味をもっています。

黄色セル → パラメータを設定（入力）するセル
水色セル → 取得結果を出力するセル

下記図の①～③の説明です。

①振替伝票作成のPOST処理で使用するkey
②取得項目の日本語名
③パラメータ設定欄（「仕訳の種類」欄はデータの入力規則で作成）

【スクリプト】

このスクリプトと同じプロジェクト内に、下記記事の認証スクリプト（認証用の関数）を書いておく必要があります。

【freee×GAS】GoogleAppsScriptでfreeeAPIと連携認証する（サンプルコードあり）

具体的には、「getService」関数と、その中で使われている「Client_ID」「Client_Secret」の値です。

そして、下記スクリプトの「getJournalMain」関数を実行すると、条件に一致する振替伝票をスプレッドシートに取得できます。

//エントリポイント
function getJournalMain() {
  
  const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('振替伝票');
  const START_ROW = 3;
  const END_COL = 10; //J列
  const PARAM_COL = 13; //M列
  
  //前回データのクリア
  sheet.getRange(START_ROW, 1, sheet.getLastRow(), END_COL).clearContent();
  
  //パラメータ・アクセストークンの取得
  const parameters = sheet.getRange(1, PARAM_COL, 11, 1).getValues();
  const accessToken = getService().getAccessToken();
  
  //振替伝票一覧を取得
  const resJounals = getManualJournals_(accessToken,parameters);
  const objJounals = JSON.parse(resJounals).manual_journals;
  
  if (objJounals.length > 0) {
    
    //勘定科目一覧を取得(勘定科目IDを勘定科目名に変換するため)
    const resItems = getAccountItems_(accessToken,parameters);
    const objItems = JSON.parse(resItems).account_items;
    
    //スプレッドシートに出力
    OutputManualJournals_(sheet,objJounals,objItems,START_ROW);
    
  }
  
}

/*
* freeeAPIで振替伝票一覧を取得する
* /api/1/manual_journals
*
* @param {Object} パラメータ
* @return {Object} freeeAPIからのレスポンス
*/
function getManualJournals_(accessToken,parameters) {
  
  const company_id = parameters[1][0]; //事業所ID 
  let start_issue_date = parameters[4][0]; //伝票日付(開始日)
  let end_issue_date = parameters[5][0]; //伝票日付(終了日)
  let adjustmentType = parameters[6][0]; //仕訳の種類
  
  start_issue_date = Utilities.formatDate(start_issue_date, 'JST', 'yyyy-MM-dd');
  end_issue_date = Utilities.formatDate(end_issue_date, 'JST', 'yyyy-MM-dd');
  
  let adjustment = '';
  
  if (adjustmentType === '決算整理仕訳') {
    adjustment = '&adjustment=only';
  } else if (adjustmentType === '日常仕訳') {  
    adjustment = '&adjustment=without';
  }
  
  const requestUrl = 'https://api.freee.co.jp/api/1/manual_journals?' + 
    'company_id=' + company_id + 
    '&start_issue_date=' + start_issue_date +
    '&end_issue_date=' + end_issue_date + adjustment;
  
  const params = {
    method : 'get',
    headers : {'Authorization':'Bearer ' + accessToken}
  };
  
  const response = UrlFetchApp.fetch(requestUrl,params);  
  
  return response;
  
}

/*
* freeeAPIから勘定科目一覧を取得する
* /api/1/account_items
*
* @param {string} 事業所ID
* @return {Object} freeeAPIからのレスポンス
*/
function getAccountItems_(accessToken,parameters) {
  
  const company_id = parameters[1][0]; //事業所ID 
  const requestUrl = 'https://api.freee.co.jp/api/1/account_items?' + 
    'company_id=' + company_id;
  
  const params = {
    method : 'get',
    headers : {'Authorization':'Bearer ' + accessToken}
  };
  
  const response = UrlFetchApp.fetch(requestUrl,params);  
  
  return response;
  
}

/*
* 振替伝票のデータをスプレッドシートに書き出す
*
* @param {Object} シート
* @param {Object} 振替伝票データ
* @param {Object} 勘定科目データ
* @param {Number} 書き込み開始行
*/
function OutputManualJournals_(sheet,obj,objItems,row) {
  
  let arr = [];
  
  for(let i = 0; i < obj.length; i++){
    
    for(let j = 0; j < obj[i].details.length; j++) {
      
      let val1 = obj[i].id; //振替伝票ID
      let val2 = obj[i].issue_date; //発生日
      let val3 = obj[i].adjustment; //決算整理仕訳（falseまたは未指定の場合: 日常仕訳）
      let val4 = obj[i].details[j].entry_side; //貸借(貸方credit, 借方debit)
      let val5 = obj[i].details[j].account_item_id; //勘定科目ID
      let val6 = fromAccountItemIdToName_(objItems,val5);//勘定科目ID→勘定科目名
      let val7 = obj[i].details[j].tax_code; //税区分
      let val8 = obj[i].details[j].amount; //金額（税込）
      let val9 = obj[i].details[j].vat; //消費税
      let val10 = obj[i].details[j].description; //備考
      
      arr.push([val1,val2,val3,val4,val5,val6,val7,val8,val9,val10]);
      
    }
  }
  
  //配列をスプレッドシートに書き出す
  sheet.getRange(row, 1, arr.length, arr[0].length).setValues(arr);
  
}

/*
* 勘定科目IDから勘定科目名を返す
*
* @param {Object} 勘定科目一覧
* @param {string} 勘定科目ID
* @return {string} 勘定科目名
*/
function fromAccountItemIdToName_(objItems,account_item_id) {
  
  let account_item_name = '';
  
  for(let i = 0; i < objItems.length; i++){
    if (objItems[i].id == account_item_id) {
      account_item_name = objItems[i].name;
      break;
    }
  }

  return account_item_name;

}

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

//エントリポイント

function getJournalMain() {

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('振替伝票');

const START_ROW = 3;

const END_COL = 10; //J列

const PARAM_COL = 13; //M列

//前回データのクリア

sheet.getRange(START_ROW, 1, sheet.getLastRow(), END_COL).clearContent();

//パラメータ・アクセストークンの取得

const parameters = sheet.getRange(1, PARAM_COL, 11, 1).getValues();

const accessToken = getService().getAccessToken();

//振替伝票一覧を取得

const resJounals = getManualJournals_(accessToken,parameters);

const objJounals = JSON.parse(resJounals).manual_journals;

if (objJounals.length > 0) {

//勘定科目一覧を取得(勘定科目IDを勘定科目名に変換するため)

const resItems = getAccountItems_(accessToken,parameters);

const objItems = JSON.parse(resItems).account_items;

//スプレッドシートに出力

OutputManualJournals_(sheet,objJounals,objItems,START_ROW);

}

* freeeAPIで振替伝票一覧を取得する

* /api/1/manual_journals

* @param {Object} パラメータ

* @return {Object} freeeAPIからのレスポンス

function getManualJournals_(accessToken,parameters) {

const company_id = parameters[1][0]; //事業所ID

let start_issue_date = parameters[4][0]; //伝票日付(開始日)

let end_issue_date = parameters[5][0]; //伝票日付(終了日)

let adjustmentType = parameters[6][0]; //仕訳の種類

start_issue_date = Utilities.formatDate(start_issue_date, 'JST', 'yyyy-MM-dd');

end_issue_date = Utilities.formatDate(end_issue_date, 'JST', 'yyyy-MM-dd');

let adjustment = '';

if (adjustmentType === '決算整理仕訳') {

adjustment = '&adjustment=only';

} else if (adjustmentType === '日常仕訳') {

adjustment = '&adjustment=without';

}

const requestUrl = 'https://api.freee.co.jp/api/1/manual_journals?' +

'company_id=' + company_id +

'&start_issue_date=' + start_issue_date +

'&end_issue_date=' + end_issue_date + adjustment;

const params = {

method : 'get',

headers : {'Authorization':'Bearer ' + accessToken}

};

const response = UrlFetchApp.fetch(requestUrl,params);

return response;

}

* freeeAPIから勘定科目一覧を取得する

* /api/1/account_items

* @param {string} 事業所ID

* @return {Object} freeeAPIからのレスポンス

function getAccountItems_(accessToken,parameters) {

const company_id = parameters[1][0]; //事業所ID

const requestUrl = 'https://api.freee.co.jp/api/1/account_items?' +

'company_id=' + company_id;

const params = {

method : 'get',

headers : {'Authorization':'Bearer ' + accessToken}

};

const response = UrlFetchApp.fetch(requestUrl,params);

return response;

}

* 振替伝票のデータをスプレッドシートに書き出す

* @param {Object} シート

* @param {Object} 振替伝票データ

* @param {Object} 勘定科目データ

* @param {Number} 書き込み開始行

function OutputManualJournals_(sheet,obj,objItems,row) {

let arr = [];

for(let i = 0; i < obj.length; i++){

for(let j = 0; j < obj[i].details.length; j++) {

let val1 = obj[i].id; //振替伝票ID

let val2 = obj[i].issue_date; //発生日

let val3 = obj[i].adjustment; //決算整理仕訳（falseまたは未指定の場合: 日常仕訳）

let val4 = obj[i].details[j].entry_side; //貸借(貸方credit, 借方debit)

let val5 = obj[i].details[j].account_item_id; //勘定科目ID

let val6 = fromAccountItemIdToName_(objItems,val5);//勘定科目ID→勘定科目名

let val7 = obj[i].details[j].tax_code; //税区分

let val8 = obj[i].details[j].amount; //金額（税込）

let val9 = obj[i].details[j].vat; //消費税

let val10 = obj[i].details[j].description; //備考

arr.push([val1,val2,val3,val4,val5,val6,val7,val8,val9,val10]);

}

//配列をスプレッドシートに書き出す

sheet.getRange(row, 1, arr.length, arr[0].length).setValues(arr);

}

* 勘定科目IDから勘定科目名を返す

* @param {Object} 勘定科目一覧

* @param {string} 勘定科目ID

* @return {string} 勘定科目名

function fromAccountItemIdToName_(objItems,account_item_id) {

let account_item_name = '';

for(let i = 0; i < objItems.length; i++){

if (objItems[i].id == account_item_id) {

account_item_name = objItems[i].name;

break;

}

return account_item_name;

}

【実行結果】

スクリプトの実行結果です。スプレッドシートに振替伝票のデータを取得できました。

・freeeの画面（3件）

・スプレッドシート出力結果（3件）

次回は、スプレッドシートに出力したデータを使用して「貸借逆の振替伝票」を作成します。

【freeeAPI×GAS】スプレッドシートのデータから振替伝票を一括作成する【逆仕訳一括作成ツール②】GASを使って「クラウド会計ソフトfreee」のAPIを操作するシリーズ。スプレッドシートのデータを使って振替伝票を一括登録するスクリプトを紹介しています。...

freeeAPI Google Apps Script

【freeeAPI×GAS】指定条件の振替伝票をスプレッドシートに取得する【逆仕訳一括作成ツール①】

逆仕訳一括作成ツール

【動画】ツールの使い方（処理の流れ）

freeeに登録済みの振替伝票をスプレッドシートに出力する

【事前準備】スプレッドシートの準備

【スクリプト】

【実行結果】

【GAS】月末日のｎ営業日前（マイナスｎ営業日）を求める

【freeeAPI×GAS】スプレッドシートのデータから振替伝票を一括作成する【逆仕...

【GAS】【Googleドライブ】指定フォルダ内のファイル名一覧を取得する

ノーコード爆速アプリ開発ができるAppSheetで旦那語録を作ってみた

【GAS】スプレッドシート上でChatGPTを再現する（OpenAIのAPI使用）

【GAS×ChatGPT API連携】スプレッドシートで使えるリライトツールの作り方

まるで人間？ChatGPTの日本語翻訳が自然すぎる【ChatGPT活用法#1】

【GAS/JavaScript】While文の条件式にイコール（代入演算子）を使うと「変数代入」と「評価」が同時にできる