会計freeeの各種申請APIの使い方

ここでは会計freee APIの各種申請API:ワークフローに関する用語とユースケース別の使い方のポイントを紹介します。

APIで申請レコードを登録する前に

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

  1. 会計freee Webで[APIテスト用の]各種申請フォーム作成、申請経路作成、申請レコード作成する
    • APIとレスポンスの関係をつかみやすくするため
    • 各種申請機能は会計freeeのエンタープライズプランのみ利用可
  2. 各種申請レコードの取得API(Show):作成した個別の申請をGETして、レスポンスを確認する
    • 申請フォーム、申請経路、承認者などの関係性を把握
  3. ここまでのステップで把握できた内容をもとに新しい各種申請レコードを作成する

各種申請ワークフローの用語集

用語集・説明

用語 説明
申請経路 申請者が事前に登録されたものから選びます。申請する際に必ず選択する必要があります。指定なし、承認者を指定などから選択します。

経費などの申請経路を設定する

申請フォーム 社内の独自の申請フォームを作成して、申請から承認のフローに利用することができます。

経費などの申請経路を設定する

承認 申請を承認する際に行うアクションです
却下 申請を認めず却下する際に行うアクションです
差戻し 申請者に確認事項などがある場合に、再度内容を補足してもらうために戻すために行うアクションです

申請レコード作成時に利用するエンドポイントとプロパティ

以下の資料で必要なエンドポイントとPOST時の必須情報が把握できます。内容は取引の作成から始まり、各種申請APIの資料は後半にあります。

APIリファレンス

APIリファレンスで以下の項を参照してください

  • 各種申請API
    • /approval_requests
  • 申請経路API
    • /approval_flow_routes

ユースケース別ポイント

APIリファレンスに加え、参考にできる情報をユースケース別にまとめています。

ユースケース 条件・パターン ポイント
申請をする
POST/api/1/approval_requests
承認された各種申請から別の各種申請を作成する
  • parent_idに申請ステータスがapprovedの各種申請を指定すること
  • 各種申請から取引を作成している場合parent_idに指定できない
  • 各種申請から振伝を作成している場合parent_idに指定できない
  • 各種申請から経費精算、支払い依頼、各種申請を合計15件作成している場合parent_idに指定できない
申請を更新する
PUT/api/1/approval_requests
申請で利用する申請経路を変更する
  • approval_flow_route_idに変更したい申請経路を指定すること
  • 申請ステータスがdraft、feedbackの場合のみ可能
申請で利用する申請フォームを変更する 変更不可。申請を作成しなおす必要あり。
申請に対してアクションする
POST/api/1/approval_requests/{id}/actions
申請を代理承認する
  • approval_actionにforce_approveを指定すること
  • 会計freeeの管理者権限か管理者権限をコピーした権限のユーザーのみ可能
  • 申請者ユーザーは代理承認不可
  • 対象承認ステップの承認者ユーザーは代理承認不可
承認済み・却下済みを取り消す
  • approval_actionにforce_feedbackを指定すること
  • 申請ステータスがapproved、rejectedの場合のみ可能
  • 会計freeeの管理者権限か管理者権限をコピーした権限のユーザーのみ可能
管理者権限を持つユーザーが承認または拒否の取り消し
承認者を指定しない申請

承認または却下のあとに取り消して差戻しステータス

  1. resource_type=unspecifiedの申請はapproversに取り消しを行ったユーザーが追加される
  2. resource_typeがunspecified以外の申請はapproversには追加されない

*誰が承認/却下/差しもどし/取り消しをしたかは時系列順に並んでapproval_flow_logsに含まれている。このケースにおいてapprovers.statusではく、approval_flow_logsを確認して判断する必要あり

申請を承認する
  • approval_actionにapproveを指定すること
  • 対象承認ステップの承認者ユーザーのみ可能
申請を却下する
  • approval_actionにrejectを指定すること
  • 対象承認ステップの承認者ユーザーのみ可能
申請者へ差し戻す
  • approval_actionにfeedbackを指定すること
  • 対象承認ステップの承認者ユーザーのみ可能
申請を取り消す
  • approval_actionにcancelを指定すること
  • 申請者ユーザーのみ可能
申請を削除する
DELETE/api/1/approval_requests/{id}
申請者ユーザーで申請を削除する 申請ステータスがdraft、feedbackの場合のみ可能
申請者以外のユーザーで申請を削除したい
  • 申請ステータスがfeedbackの場合のみ可能
  • 会計freeeの管理者権限か管理者権限をコピーした権限のユーザーのみ可能