@him0/freee-mcp

# 月次勤怠締め申請 ## 概要 月次勤怠締め申請の操作 ## エンドポイント一覧 ### GET /api/v1/approval_requests/monthly_attendances 操作: 月次勤怠締め申請一覧の取得 説明: 概要 指定した事業所の指定日付時点における月次勤怠締め申請情報をリストで返します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 ### パラメータ | 名前 | 位置 | 必須 | 型 | 説明 | |------|------|------|-----|------| | company_id | query | はい | integer | 事業所ID | | status | query | いいえ | string | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し (選択肢: draft, in_progress, approved, feedback) | | application_number | query | いいえ | integer | 申請No | | start_issue_date | query | いいえ | string(date) | 申請開始日 | | end_issue_date | query | いいえ | string(date) | 申請終了日 | | approver_id | query | いいえ | integer | 現在承認ステップの承認者のユーザーID approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません | | applicant_id | query | いいえ | integer | 申請者のユーザーID | | start_target_date | query | いいえ | string(date) | 対象開始日 | | end_target_date | query | いいえ | string(date) | 対象終了日 | | passed_auto_check | query | いいえ | boolean | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 | | limit | query | いいえ | integer | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) | | offset | query | いいえ | integer | 取得レコードのオフセット (デフォルト: 0) | ### レスポンス (200) successful operation - monthly_attendances (必須): array[object] 配列の要素: - id (必須): integer(int32) - 申請ID 例: `1` (最小: 1, 最大: 2147483647) - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - application_number (必須): integer(int32) - 申請No 例: `1` (最小: 1, 最大: 2147483647) - applicant_id (必須): integer(int32) - 申請者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) - approver_ids (任意): array[integer] - 承認者のユーザーID配列<br> 次の場合、空配列になります。 - 指定なしの申請経路を利用した、申請ステータスが承認済み以外の申請 - 申請が差戻された - target_date (必須): string(date) - 対象日 例: `2022-02-01` (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - issue_date (必須): string(date) - 申請日 (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - status (必須): string - 申請ステータス。（draft:下書き、in_progress:申請中、approved:承認済、feedback:差戻し） (選択肢: draft, in_progress, approved, feedback) 例: `in_progress` - passed_auto_check (必須): boolean - 自動チェック結果 例: `true` - total_count (必須): integer(int32) - 合計件数 例: `1` (最小: 0, 最大: 2147483647) ### POST /api/v1/approval_requests/monthly_attendances 操作: 月次勤怠締め申請の作成 説明: 概要 指定した事業所の月次勤怠締め申請を新規作成します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 申請者と承認者が同一ユーザーの場合、feedback(差戻し)をするとレスポンスは以下のようになります。 status: draft approval_flow_logs.action: cancel ### リクエストボディ - company_id (必須): integer(int32) - 事業所ID（必須） 例: `1` (最小: 1, 最大: 2147483647) - target_year (必須): integer(int32) - 対象年（必須） 例: `2022` (最小: 2000, 最大: 2100) - target_month (必須): integer(int32) - 対象月（必須） 例: `1` (最小: 1, 最大: 12) - approval_flow_route_id (必須): integer(int32) - 申請経路ID（必須） 例: `1` (最小: 1, 最大: 2147483647) - approver_id (任意): integer(int32) - 承認者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) ### レスポンス (201) successful operation - monthly_attendance (必須): object - id (必須): integer(int32) - 申請ID 例: `1` (最小: 1, 最大: 2147483647) - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - application_number (必須): integer(int32) - 申請No 例: `1` (最小: 1, 最大: 2147483647) - applicant_id (必須): integer(int32) - 申請者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) - approver_ids (任意): array[integer] - 承認者のユーザーID配列<br> 次の場合、空配列になります。 - 指定なしの申請経路を利用した、申請ステータスが承認済み以外の申請 - 申請が差戻された - target_date (必須): string(date) - 対象日 例: `2022-02-01` (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - issue_date (必須): string(date) - 申請日 (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - status (必須): string - 申請ステータス。（draft:下書き、in_progress:申請中、approved:承認済、feedback:差戻し） (選択肢: draft, in_progress, approved, feedback) 例: `in_progress` - passed_auto_check (必須): boolean - 自動チェック結果 例: `true` - approval_flow_route_id (必須): integer - 申請経路ID 例: `1` (最小: 1, 最大: 2147483647) - approval_flow_route_name (必須): string - 申請経路名 例: `申請経路` - approval_flow_logs (必須): array[object] - 承認履歴 - current_step_id (任意): integer(int32) - 現在承認ステップID<br> 申請を差戻した場合、nullになります。 例: `1` (最小: 1, 最大: 2147483647) - current_round (必須): integer(int32) - 現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例: `1` (最小: 0, 最大: 2147483647) ### GET /api/v1/approval_requests/monthly_attendances/{id} 操作: 月次勤怠締め申請の取得 説明: 概要 指定した事業所の月次勤怠締め申請情報を取得します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 申請者と承認者が同一ユーザーの場合、feedback(差戻し)をするとレスポンスは以下のようになります。 status: draft approval_flow_logs.action: cancel ### パラメータ | 名前 | 位置 | 必須 | 型 | 説明 | |------|------|------|-----|------| | company_id | query | はい | integer | 事業所ID | | id | path | はい | integer | 月次勤怠締め申請ID | ### レスポンス (200) successful operation - monthly_attendance (必須): object - id (必須): integer(int32) - 申請ID 例: `1` (最小: 1, 最大: 2147483647) - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - application_number (必須): integer(int32) - 申請No 例: `1` (最小: 1, 最大: 2147483647) - applicant_id (必須): integer(int32) - 申請者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) - approver_ids (任意): array[integer] - 承認者のユーザーID配列<br> 次の場合、空配列になります。 - 指定なしの申請経路を利用した、申請ステータスが承認済み以外の申請 - 申請が差戻された - target_date (必須): string(date) - 対象日 例: `2022-02-01` (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - issue_date (必須): string(date) - 申請日 (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - status (必須): string - 申請ステータス。（draft:下書き、in_progress:申請中、approved:承認済、feedback:差戻し） (選択肢: draft, in_progress, approved, feedback) 例: `in_progress` - passed_auto_check (必須): boolean - 自動チェック結果 例: `true` - approval_flow_route_id (必須): integer - 申請経路ID 例: `1` (最小: 1, 最大: 2147483647) - approval_flow_route_name (必須): string - 申請経路名 例: `申請経路` - approval_flow_logs (必須): array[object] - 承認履歴 - current_step_id (任意): integer(int32) - 現在承認ステップID<br> 申請を差戻した場合、nullになります。 例: `1` (最小: 1, 最大: 2147483647) - current_round (必須): integer(int32) - 現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例: `1` (最小: 0, 最大: 2147483647) ### PUT /api/v1/approval_requests/monthly_attendances/{id} 操作: 月次勤怠締め申請の更新 説明: 概要 指定した事業所の月次勤怠締め申請情報を更新します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 申請者と承認者が同一ユーザーの場合、feedback(差戻し)をするとレスポンスは以下のようになります。 status: draft approval_flow_logs.action: cancel ### パラメータ | 名前 | 位置 | 必須 | 型 | 説明 | |------|------|------|-----|------| | id | path | はい | integer | 月次勤怠締め申請ID | ### リクエストボディ - company_id (必須): integer(int32) - 事業所ID（必須） 例: `1` (最小: 1, 最大: 2147483647) - approval_flow_route_id (必須): integer(int32) - 申請経路ID（必須） 例: `1` (最小: 1, 最大: 2147483647) - approver_id (任意): integer(int32) - 承認者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) ### レスポンス (200) successful operation - monthly_attendance (必須): object - id (必須): integer(int32) - 申請ID 例: `1` (最小: 1, 最大: 2147483647) - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - application_number (必須): integer(int32) - 申請No 例: `1` (最小: 1, 最大: 2147483647) - applicant_id (必須): integer(int32) - 申請者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) - approver_ids (任意): array[integer] - 承認者のユーザーID配列<br> 次の場合、空配列になります。 - 指定なしの申請経路を利用した、申請ステータスが承認済み以外の申請 - 申請が差戻された - target_date (必須): string(date) - 対象日 例: `2022-02-01` (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - issue_date (必須): string(date) - 申請日 (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - status (必須): string - 申請ステータス。（draft:下書き、in_progress:申請中、approved:承認済、feedback:差戻し） (選択肢: draft, in_progress, approved, feedback) 例: `in_progress` - passed_auto_check (必須): boolean - 自動チェック結果 例: `true` - approval_flow_route_id (必須): integer - 申請経路ID 例: `1` (最小: 1, 最大: 2147483647) - approval_flow_route_name (必須): string - 申請経路名 例: `申請経路` - approval_flow_logs (必須): array[object] - 承認履歴 - current_step_id (任意): integer(int32) - 現在承認ステップID<br> 申請を差戻した場合、nullになります。 例: `1` (最小: 1, 最大: 2147483647) - current_round (必須): integer(int32) - 現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例: `1` (最小: 0, 最大: 2147483647) ### DELETE /api/v1/approval_requests/monthly_attendances/{id} 操作: 月次勤怠締め申請の削除 説明: 概要 指定した事業所の月次勤怠締め申請情報を削除します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 ### パラメータ | 名前 | 位置 | 必須 | 型 | 説明 | |------|------|------|-----|------| | id | path | はい | integer | 月次勤怠締め申請ID | | company_id | query | はい | integer | 事業所ID | ### レスポンス (204) successful operation ### POST /api/v1/approval_requests/monthly_attendances/{id}/actions 操作: 月次勤怠締め申請の承認操作 説明: 概要 指定した事業所の月次勤怠締め申請情報を承認操作します。 注意点 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 申請者と承認者が同一ユーザーの場合、feedback(差戻し)をするとレスポンスは以下のようになります。 status: draft approval_flow_logs.action: cancel ### パラメータ | 名前 | 位置 | 必須 | 型 | 説明 | |------|------|------|-----|------| | id | path | はい | integer | 月次勤怠締め申請ID | ### リクエストボディ - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - approval_action (必須): string - 申請操作。（approve:承認、cancel:取り消し、feedback:差戻し、force_feedback:承認取り消し） (選択肢: approve, cancel, feedback, force_feedback) 例: `approve` - target_round (必須): integer(int32) - 対象round。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。取得APIレスポンス.current_roundを送信してください。 例: `1` (最小: 1, 最大: 2147483647) - target_step_id (必須): integer(int32) - 対象承認ステップID。取得APIレスポンス.current_step_idを送信してください。 例: `1` (最小: 1, 最大: 2147483647) - next_approver_id (任意): integer(int32) - 次のステップの承認者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) ### レスポンス (201) successful operation - monthly_attendance (必須): object - id (必須): integer(int32) - 申請ID 例: `1` (最小: 1, 最大: 2147483647) - company_id (必須): integer(int32) - 事業所ID 例: `1` (最小: 1, 最大: 2147483647) - application_number (必須): integer(int32) - 申請No 例: `1` (最小: 1, 最大: 2147483647) - applicant_id (必須): integer(int32) - 申請者のユーザーID 例: `1` (最小: 1, 最大: 2147483647) - approver_ids (任意): array[integer] - 承認者のユーザーID配列<br> 次の場合、空配列になります。 - 指定なしの申請経路を利用した、申請ステータスが承認済み以外の申請 - 申請が差戻された - target_date (必須): string(date) - 対象日 例: `2022-02-01` (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - issue_date (必須): string(date) - 申請日 (パターン: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$) - status (必須): string - 申請ステータス。（draft:下書き、in_progress:申請中、approved:承認済、feedback:差戻し） (選択肢: draft, in_progress, approved, feedback) 例: `in_progress` - passed_auto_check (必須): boolean - 自動チェック結果 例: `true` - approval_flow_route_id (必須): integer - 申請経路ID 例: `1` (最小: 1, 最大: 2147483647) - approval_flow_route_name (必須): string - 申請経路名 例: `申請経路` - approval_flow_logs (必須): array[object] - 承認履歴 - current_step_id (任意): integer(int32) - 現在承認ステップID<br> 申請を差戻した場合、nullになります。 例: `1` (最小: 1, 最大: 2147483647) - current_round (必須): integer(int32) - 現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。 例: `1` (最小: 0, 最大: 2147483647) ## 参考情報 - freee API公式ドキュメント: https://developer.freee.co.jp/docs - OpenAPIスキーマ: [hr-api-schema.json](../../openapi/hr-api-schema.json)