freee API スタートガイド 最初のGET/POSTリクエストを行う

最初のGET/POSTリクエストを行う

アクセストークン取得後のステップ

ここでは「アクセストークンを取得する」で取得したアクセストークンを用いて、実際にGET/POSTリクエストを行います。

以下の手順で段階的にGET/POSTリクエストを行っていきます。

  • APIリファレンスからAPIコール（GET）を行う
    • 会計
      1. 事業所ID(company_id)を確認する。
    • 人事労務
      1. ユーザー情報を取得、仕様を確認する。
  • 情報登録（POSTリクエスト）まで行う。
    • 会計
      1. [GET] 事業所情報以外に必要な情報を取得
      2. [POST] 新規取引を作成する
    • 人事労務
      1. [GET] ユーザー情報を取得
      2. [POST] 勤怠を記録する

（参考）freee会計で取引を登録するまでの流れ

APIリファレンスからAPIコールを行う

  • アクセストークンを用いて、情報参照を行うAPIコールを行います。
  • APIリファレンス（ブラウザ）ではなく、curlコマンドなど別の方法でAPIコールを行う場合でも、途中までのSTEPは共通で、APIレスポンスを得る際に合わせてcurlコマンドで実行するための情報も取得できます。

freee会計

  1. 会計APIリファレンスページのServers付近までスクロールしてAuthorizeを押下します
    • APIをブラウザから呼び出すための準備です
  2. アクセストークンを入力して もう一度Authorizeを押下してCloseを押下します
  3. リファレンス内のCompanies（事業所）に移動し、Try it outを押下し、Executeを押下します
    • 多くのAPIで事業所IDは必須となりますので、その情報を取得します
  4. Response > Server response > response bodyを参照し、事業所ID(id属性)を記録しておきます
    1. ResponseにはブラウザからではなくcurlコマンドでAPIコールをするための情報も取得できるので、今後の調査やテストにご活用ください
  5. Responseの右下にDownloadというボタンがあり、.jsonの拡張子のファイルをダウンロードできます。あとで参照ができて便利です。テキストエディタなどで参照することができます。
    • エラーが出たら？
      • APIを試す中でアクセス権限がない旨のエラーが出た場合、アプリ管理 > アプリ詳細でアプリの権限設定で権限を変更（勘定科目の参照や更新を可能にするなど）します。そのあと、上記の2-1の手順でアクセストークンを再発行して再度Authorizeを実行してみましょう

freee人事労務

  • developerサイトのfreee人事労務のAPI仕様書を開きます。
  • スクロールしてAuthorizeを押下します。APIをブラウザから呼び出すための準備です。
  • アクセストークンを入力して、もう一度Authorizeを押下してCloseを押下します
  • リファレンス内のログインユーザを選び「Try it out」をクリックします。
  • Parametersの設定エリアが開きます。ログインユーザーの取得にはParameterは不要ですので、そのまま「Excute」をクリックします。
  • リクエスト結果（レスポンス）が表示されます。あわせてcurlの内容もでるので、今後の調査や実装時の参考にすることができます。

情報登録（POSTリクエスト）まで行う

freee会計

developerサイトのfreee会計のAPIリファレンスを参照しながら以下のステップで取引登録を行います。

（再掲）freee会計で取引を登録するまでの流れ

  1. [POST] 新規取引を作成する
        • ここまで流れで、上図の事業所を取得のcompany_idを取得・記録しました。ここからは追加で5つの必須情報を取得したのちに取引を作成するまでの流れです（上図はさらに多くの項目を取得して取引登録する図）。freeeで取引を作成する流れをfreeeの画面でイメージをつかみたい場合はヘルプページをあわせて参照しましょう。
        • 2020年11月1日に1,000円の文具を購入するというケースで、勘定科目は事務用品費、税区分は消費税10%の課対仕入で取引登録します。
            1. 勘定科目を指定するために勘定科目ID(account_item_id)を取得・記録します。勘定科目一覧の取得まで移動し、company_idを指定してaccount_item_idを参照・記録します。Responseの右下のダウンロードボタンでファイルをダウンロードしておくことをお勧めします。
            2. 税区分情報を指定するために税区分コード(tax_code)を取得・記録しましょう。税区分（Taxes）まで移動し、GET /taxes/codesから消費税10%の課対仕入のtax_codeを取得・記録します。
            3. 取得した情報に加えて以下の必須項目の情報を入れて、取引を作成します。
              1. type:収支区分 (収入: income, 支出: expense)
                • ここでは支出なのでexpenseとします
              2. issue_date:発生日
                • 2020/11/1に購入ということで”2020-11-01″とします
              3. details>amount:取引金額
                • 税込み金額の1100を値として入れます
            4. 取引（収入／支出）の作成に移動し、Try it outを押下して（Request bodyの背景が白くなったら編集モード）Request Bodyの箇所を集めた情報で上書きします。
            5. 以下は必須のものだけに加えて備考のみ追加で入れているサンプルです。実際にはより詳細な情報、例えば現金で支払済の場合はpaymentsを具体的な情報で追加指定ができます。APIリファレンスのサンプルにおいて、detailsの項目で必須以外は削除し、paymentsはブロックごと消すと以下のようになります。update_requiredの値3か所のみ置き換えて試せます。 
              • {
  "issue_date": "2020-11-01",
  "type": "expense",
  "company_id": update_required,
  "details": [
    {
      "tax_code": update_required,
      "account_item_id": update_required,
      "amount": 1100,
      "description": "ノートとボールペンをコンビニで購入"
    }
  ]
}
            6. Executeボタンを押してリクエストを送信します。
            7. Server responseのテーブルにあるcode 201の行のResponse bodyを確認してみましょう。同じようにDownloadからファイル形式で内容を確認でき、どういった取引が登録されているかを確認できます。
            8. 実際に登録されているかを確認したい場合はfreeeにログインをして取引の一覧から該当する取引を探して確認してください。
                1. メモタグ、口座、部門などの情報を追加して取引を作成してみたい場合は同様にGETで情報を取得してPOST時に指定してください。
                2. 以下の資料はさらに一歩進んで、請求書や見積書、各種申請のワークフローのレコードを作成するフローを説明しています。

freee人事労務

developerサイトのfreee人事労務のAPI仕様書を参照しながら次のステップで行います。

  1. [GET] ユーザー情報を取得する
    • ログインユーザーの情報を取得するAPIを用いてユーザー情報をリクエストします。
    • レスポンスからcompany_id、employee_idを取得します。
  2. [POST] 勤怠を記録する
    • 取得したcompany_id、employee_idを用いて、勤怠を記録します。