freee APIとGASを使って商品が購入されたら自動で仕訳登録する (中編) #GAS

はじめに

bocci bocciを運営している@shoji-kaiです。
前編ではfreee APIのセットアップと基本的な使い方を確認しました。
今回は、GAS(Google Apps Scripts)を使って商品購入メールが届いていたらfreee APIを叩くところまでをやってみたいと思います。

GAS(Google Apps Script)とは

GASは、GmailやGoogle SpreadsheetsなどGoogle Workspaceの一連のアプリケーションを操作できるスクリプトの総称になります。
GASは下記URLより誰でも使うことができます。

Google Appsの承認

GASからGoogle Apps(Gmail, Google Spreadsheetsなど)にアクセスしようとすると承認が求められます。
下記のステップで承認を許可してください。

1. 承認ダイアログが出てきたら「権限を確認」を押す

2. アカウントを選択する

3. 左下にある「詳細」を開く

4. 「無題のプロジェクト (安全ではないページ) に移動」をクリックする

5. アクセスリクエストを許可する

GASからfreee APIを叩いてみる

それでは、早速GASからfreee APIを叩いてみたいと思います。
GASでプロジェクトを新規作成し、以下のコードを貼り付けて実行します。

コード.gs

function postDeal() {
  const accessToken = '<ACCESS_TOKEN>'; // 自分のアクセストークンに置き換えてください
  const companyId = <COMPANY_ID>;       // 自分の事業所IDに置き換えてください
  const data = {
    "issue_date": "2020-11-01",
    "type": "expense",
    "company_id": companyId,
    "details": [
      {
        "tax_code": 136,
        "account_item_id": 538987945,
        "amount": 1100,
        "description": "ノートとボールペンをコンビニで購入"
      }
    ]
  };

  const url = 'https://api.freee.co.jp/api/1/deals';
  const options = {
    'method': 'post',
    'contentType': 'application/json',
    'payload': JSON.stringify(data),
    'headers': {
      'Authorization': 'Bearer ' + accessToken
    }
  };
  const res = UrlFetchApp.fetch(url, options);
  Logger.log(res.getResponseCode());
}

エラーが発生せずに正常終了していれば成功です。

GASからGmailに商品購入メールが届いているか確認する

まずはダミーの商品購入メールを自分のGmail宛てに送信します。

cat <<. | sendmail -t
Subject: 商品が購入されました。
To: <メールアドレス>

テスト
.

GASに以下のコードを追記します。

コード.gs

function checkOrderMail() {
  const query = 'subject:(商品が購入されました) in:anywhere';
  const threads = GmailApp.search(query).reverse();
  for (let i = 0; i < threads.length; i++) {
    const messages = threads[i].getMessages();
    for (let j = 0; j < messages.length; j++) {
      const date = messages[j].getDate();
      const orderedAt = date.getFullYear() + '-' + (date.getMonth() + 1) + '-' + date.getDate();
      Logger.log('ordered at ' + orderedAt);
    }
  }
}

実行する関数を checkOrderMail に変更して実行します。
実行ログに'ordered at'のログが記録されていれば成功です。

メールが届いていたら仕訳登録する

続いて、メールが届いていたらpostDeal()を呼び出して仕訳登録する処理を追加します。
ここではメール受信〜仕訳登録の一連のながれをテストしたいだけなので、先ほどのサンプル取引データをそのまま流用します。
ただし、取引発生時刻はメール受信時刻とすることにします。

コードは以下のようになります。

コード.gs

function postDeal(orderedAt) {          // <= 引数にorderedAtを受け取る
  const accessToken = '<ACCESS_TOKEN>';
  const companyId = <COMPANY_ID>;
  const data = {
    "issue_date": orderedAt,            // <= issue_dateのvalueをorderedAtに変更
  :
  (snip)
  :
}

function checkOrderMail() {
  const query = 'subject:(商品が購入されました) in:anywhere';
  const threads = GmailApp.search(query).reverse();
  for (let i = 0; i < threads.length; i++) {
    const messages = threads[i].getMessages();
    for (let j = 0; j < messages.length; j++) {
      const date = messages[j].getDate();
      const orderedAt = date.getFullYear() + '-' + (date.getMonth() + 1) + '-' + date.getDate();
      Logger.log('ordered at ' + orderedAt);

      postDeal(orderedAt);  // <= postDeal()の呼び出しを追加
    }
  }
}