freee人事労務 有給申請APIの使い方

ここではfreee人事労務APIの有給申請APIに関する用語やポイントを紹介します。
有給申請APIのリファレンスはこちらとなります。
※freee有給申請APIはプロフェッショナルプラン、エンタープライズプランでのみ実行可能です。

APIで申請レコードを登録する前に(学習パス)

以下に沿って流れをつかむ、必要情報を理解することを推奨します。

  1. freee人事労務のWeb版で(APIテスト用の)申請経路、有給申請を作成する。
    • 事前にWebで操作をし、APIとレスポンスの関係をつかみやすくするため
  2. 有給申請の一覧取得APIで作成した申請の一覧をGETして、個別申請の有給申請IDを確認する。
  3. 有給申請の詳細取得APIで作成した個別の申請をGETして、レスポンスを確認する。
    • 申請に含まれる属性を把握する
  4. 申請経路一覧の取得APIで作成した申請経路の一覧をGETして、個別申請の申請経路IDを確認する。
  5. 申請経路の取得APIで作成した申請経路をGETして、レスポンスを確認する。
    • 申請経路、承認者などの関係性を把握する
  6. ここまでのステップで把握できた内容をもとに新しい有給申請レコードをAPIで作成する。

有給申請APIの用語集・説明

勤怠ワークフローに関する用語は以下ヘルプページも併せてご覧ください。

勤怠ワークフロー – 申請を行う

用語説明
申請経路申請者が事前に登録されたものから選びます。申請する際に必ず選択する必要があります。指定なし、承認者を指定などから選択します。
申請経路の設定で、申請経路ごとに“勤怠申請”で利用するか、“身上変更申請”で利用するかを設定できます。
申請経路の設定については、同等の機能となる「 freee会計の経路作成機能 」のヘルプページをご覧ください。
経費などの申請経路を設定する
承認承認者が申請を承認する際に行うアクションです。
取り消し申請者が自身の申請を(承認前に)取り消す際に行うアクションです。
承認取り消し承認者が一度承認した申請の承認を取り消す際に行うアクションです。
詳細はヘルプページをご覧ください。
勤怠ワークフロー – 申請を差戻し・削除する
差戻し承認者から申請者に確認事項があり、申請を指し戻すために行うアクションです。
詳細はヘルプページをご覧ください。
勤怠ワークフロー – 申請を差戻し・削除する