freee人事労務のAPI仕様です。
\n\nfreee API開発がはじめての方はfreee API スタートガイドを参照してください。
\n\nhttps://api.freee.co.jp/hr
\n\nOAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。
\n\nリクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄（application/jsonなど）を確認してください。
\n\nfreeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。
\n\nすべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。
\n\nX-Request-Id
\nAPIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。
\n\n| ステータスコード | \n原因 | \n
|---|---|
| 400 | リクエストパラメータが不正 |
| 401 | アクセストークンが無効 |
| 403 | アクセス権限がない |
| 404 | リソースが存在しない |
| 429 | リクエスト回数制限を超えた |
| 503 | システム内で予期しないエラーが発生 |
メッセージボディ内の messages にはエラー内容を説明する文字列が入ります。
{\n "status_code" : 400,\n "errors" : [\n {\n "type" : "bad_request",\n "messages" : [\n "リクエストの形式が不正です。"\n ]\n }\n ]\n } APIリクエストは1時間で10000回を上限としています。API使用ステータスはレスポンスヘッダに付与されます。
\nX-Ratelimit-Limit:10000\nX-Ratelimit-Remaining:9998\nX-Ratelimit-Reset:2018-01-01T12:00:00.000000Z\n| ヘッダ名 | \n説明 | \n
|---|---|
| X-RateLimit-Limit | 使用回数の上限 |
| X-RateLimit-Remaining | 残り使用回数 |
| X-RateLimit-Reset | 使用回数がリセットされる時刻 |
上記に加え、freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。
その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。
契約プランごとに利用可能なfreee人事労務APIはfreee人事労務のWeb版でご利用できる機能と同様です。例えば、スタンダードプラン（または旧ベーシックプラン）を契約している場合、Web版では打刻機能をご利用いただけますので、APIでもタイムレコーダー(打刻)APIが利用可能です。freee人事労務のWeb版のプラン別機能比較はfreee人事労務のプラン・料金についてのヘルプを参照してください。
\n\n詳細は人事労務Webhook概要を参照してください。
\n\nこのリクエストの認可セッションにおけるログインユーザーの情報を返します。
\nfreee人事労務では一人のログインユーザーを複数の事業所に関連付けられるため、このユーザーと関連のあるすべての事業所の情報をリストで返します。
\n\n指定した事業所に所属する従業員をリストで返します。
\n\n指定した対象年月に事業所に所属する従業員をリストで返します。
\n\n従業員を新規作成します。
\n\n指定したIDの従業員を返します。
\n\n指定した従業員の情報を更新します。
\n\n指定したIDの従業員を削除します。
\n\n指定した従業員・日付の姓名などの情報を返します。
\n\n指定した従業員の姓名・住所などを更新します。
\n\n指定した従業員・日付の健康保険情報を返します。
\n\n指定した従業員の健康保険情報を更新します。
\n\n指定した従業員・日付の厚生年金保険情報を返します。
\n\n指定した従業員の厚生年金保険情報を更新します。
\n\n指定した従業員・日付の家族情報を返します。
", "operationId": "get_employee_dependent_rules", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "year", "in": "query", "description": "従業員情報を取得したい年", "required": true, "schema": { "type": "integer", "minimum": 2000, "maximum": 2100 } }, { "name": "month", "in": "query", "description": "従業員情報を取得したい月指定した従業員の家族情報を更新します。
\n\n指定した従業員・日付の銀行口座情報を返します。
", "operationId": "get_employee_bank_account_rule", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "year", "in": "query", "description": "従業員情報を取得したい年", "required": true, "schema": { "type": "integer", "minimum": 2000, "maximum": 2100 } }, { "name": "month", "in": "query", "description": "従業員情報を取得したい月指定した従業員の銀行口座1の情報を更新します。
", "operationId": "update_employee_bank_account_rule", "parameters": [ { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRulesController.update_body" } } }, "required": false }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRulesController.update_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } }, "x-codegen-request-body-name": "body" } }, "/api/v1/employees/{employee_id}/basic_pay_rule": { "get": { "tags": [ "従業員の基本給" ], "summary": "従業員の基本給の取得", "description": "指定した従業員・日付の基本給情報を返します。
\n\n指定した従業員の基本給情報を更新します。
\n\n指定した従業員の手当情報をリストで返します。
\n\n指定した従業員の手当情報を更新します。
\n\n指定した従業員の手当情報を削除します。
\n\n指定した従業員の控除情報をリストで返します。
\n\n指定した従業員の控除情報を更新します。
\n\n指定した従業員の控除情報を削除します。
\n\n指定した従業員・日付のカスタム項目情報を返します。
\n\n指定した従業員・日付の勤怠情報を返します。
", "operationId": "get_employee_work_record", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "date", "in": "path", "description": "従業員情報を取得したい年月日(YYYY-MM-DD)(例:2018-08-01)", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordSerializer" }, { "$ref": "#/components/schemas/LegacyApiV1EmployeesWorkRecordSerializer" } ] } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "勤怠" ], "summary": "勤怠の更新", "description": "指定した従業員の勤怠情報を更新します。
\n\n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2017-05-25 12:00:00\",\n \"clock_out_at\": \"2017-05-25 13:00:00\"\n }\n ],\n \"work_record_segments\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00\"\n }\n ]\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2017-05-25 12:00:00\",\n \"clock_out_at\": \"2017-05-25 13:00:00\"\n }\n ],\n \"work_record_segments\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00:00\"\n }\n ],\n \"day_pattern\": \"normal_day\",\n \"normal_work_clock_in_at\": \"2017-05-25 11:00:00\",\n \"normal_work_clock_out_at\": \"2017-12-20 20:00:00\",\n \"normal_work_mins\": 0,\n \"use_default_work_pattern\": false\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2023-12-22 12:00:00\",\n \"clock_out_at\": \"2023-12-22 13:00:00\"\n }\n ],\n \"work_record_segments\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00:00\"\n }\n ],\n \"paid_holidays\": [\n {\n \"type\": \"half\"\n \"mins\": 240\n }\n ]\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2023-12-22 16:00:00\",\n \"clock_out_at\": \"2023-12-22 16:30:00\"\n }\n ],\n \"clock_in_at\": \"2023-12-22 14:00:00\",\n \"clock_out_at\": \"2023-12-22 18:00:00\",\n \"paid_holidays\": [\n {\n \"type\": \"morning_off\"\n }\n ]\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2023-12-22 16:00:00\",\n \"clock_out_at\": \"2023-12-22 16:30:00\"\n }\n ],\n \"clock_in_at\": \"2023-12-22 14:00:00\",\n \"clock_out_at\": \"2023-12-22 18:00:00\",\n \"paid_holidays\": [\n {\n \"type\": \"half\",\n \"mins\": 240\n },\n {\n \"type\": \"hourly\",\n \"mins\": 120\n },\n ]\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"special_holiday\": 1.0\n \"special_holiday_setting_id\": 1\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2023-12-22 12:00:00\",\n \"clock_out_at\": \"2023-12-22 13:00:00\"\n }\n ],\n \"work_record_segments\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00:00\"\n }\n ],\n \"special_holiday_setting_id\": 1,\n \"hourly_special_holiday_mins\": 120\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"break_records\": [\n {\n \"clock_in_at\": \"2023-12-22 12:00:00\",\n \"clock_out_at\": \"2023-12-22 12:30:00\"\n }\n ],\n \"clock_in_at\": \"2023-12-22 09:00:00\",\n \"clock_out_at\": \"2023-12-22 13:00:00\",\n \"special_holiday_setting_id\": 1,\n \"half_holiday_type\": \"afternoon_off\"\n }\n \n \n \n \n {\n \"company_id\": 1,\n \"is_absence\": true\n }\n \n \n 指定した従業員の勤怠情報を削除します。
", "operationId": "destroy_employee_work_record", "parameters": [ { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "date", "in": "path", "description": "削除対象年月日(YYYY-MM-DD)(例:2018-08-01)", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "minimum": 1, "maximum": 2147483647, "type": "integer", "format": "int32" } } ], "responses": { "204": { "description": "successful operation" }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "404": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/notfoundError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } }, "x-codegen-request-body-name": "body" } }, "/api/v1/employees/{employee_id}/work_record_summaries/{year}/{month}": { "get": { "tags": [ "勤怠情報サマリ" ], "summary": "勤怠情報月次サマリの取得", "description": "指定した従業員、月の勤怠情報のサマリを返します。
\n\n指定した従業員、月の勤怠情報のサマリを更新します。
\n\n指定した従業員・期間の打刻情報を返します。
", "operationId": "get_employee_time_clocks", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "from_date", "in": "query", "description": "取得する打刻期間の開始日(YYYY-MM-DD)(例:2018-08-01)(デフォルト: 当月の打刻開始日)", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "name": "to_date", "in": "query", "description": "取得する打刻期間の終了日(YYYY-MM-DD)(例:2018-08-31)(デフォルト: 当日)", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100)", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesTimeClocksController.index_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "タイムレコーダー(打刻)" ], "summary": "打刻の登録", "description": "指定した従業員の打刻情報を登録します。
\n\n指定した従業員・指定した打刻の詳細情報を返します。
", "operationId": "get_employee_time_clock", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "id", "in": "path", "description": "打刻ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesTimeClocksController.show_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "404": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/notfoundError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/v1/employees/{employee_id}/time_clocks/available_types": { "get": { "tags": [ "タイムレコーダー(打刻)" ], "summary": "打刻可能種別の取得", "description": "指定した従業員・日付の打刻可能種別と打刻基準日を返します。
\n例: すでに出勤した状態だと、休憩開始、退勤が配列で返ります。
", "operationId": "get_employee_time_clocks_available_types", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "date", "in": "query", "description": "従業員情報を取得したい年月日(YYYY-MM-DD)(例:2018-08-01)(デフォルト：当日)", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesTimeClocksController.available_types_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/v1/employees/{employee_id}/special_holidays": { "get": { "tags": [ "従業員の特別休暇" ], "summary": "従業員の特別休暇一覧の取得", "description": "指定した従業員に付与された特別休暇情報をリストで返します。
", "operationId": "get_employees_special_holidays", "parameters": [ { "name": "company_id", "in": "query", "required": true, "description": "事業所ID", "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "example": 1 }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647, "example": 1 } }, { "name": "date", "in": "query", "description": "対象日", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2023-04-01" }, { "name": "start_date", "in": "query", "description": "対象開始日", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2023-04-01" }, { "name": "end_date", "in": "query", "description": "対象終了日", "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2023-04-01" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "employee_special_holidays": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "特別休暇付与ID", "format": "int32", "minimum": 1, "maximum": 2147483647, "example": 1 }, "company_id": { "type": "integer", "description": "事業所ID", "format": "int32", "minimum": 1, "maximum": 2147483647, "example": 1 }, "employee_id": { "type": "integer", "description": "従業員ID", "format": "int32", "minimum": 1, "maximum": 2147483647, "example": 1 }, "special_holiday_setting_id": { "type": "integer", "description": "特別休暇設定ID", "format": "int32", "minimum": 1, "maximum": 2147483647, "example": 1 }, "name": { "type": "string", "description": "特別休暇名称", "example": "育休" }, "type_name": { "type": "string", "description": "特別休暇・休業休職種別名", "example": "育児休業日" }, "paid_type": { "type": "string", "description": "有給・無給区分（paid: 有給、unpaid: 無休）", "enum": [ "paid", "unpaid" ], "example": "paid" }, "attendance_rate_calc_type": { "type": "string", "description": "出勤率計算方法（in_workdays: 出勤日数に含める、not_in_workdays: 出勤日数に含めない、not_in_total_workdays: 全労働日に含めない）", "enum": [ "in_workdays", "not_in_workdays", "not_in_total_workdays" ], "example": "in_workdays" }, "usage_day": { "type": "string", "description": "最小消化単位（full: 全休、half: 半休、hour: 時間休）", "enum": [ "full", "half", "hour" ], "example": "half" }, "valid_date_from": { "type": "string", "description": "有効期間開始日(YYYY-MM-DD)(例:2023-01-01)", "format": "date" }, "valid_date_to": { "type": "string", "description": "有効期間終了日(YYYY-MM-DD)(例:2023-01-31)", "format": "date" }, "days": { "type": "integer", "description": "付与日数", "format": "int32", "minimum": 0, "maximum": 2147483647, "example": 2 }, "used": { "type": "number", "description": "使用数", "format": "float", "minimum": 0, "maximum": 999999999.9999, "example": 0.5 }, "num_days_and_hours_used": { "type": "object", "description": "使用日数・時間数", "properties": { "days": { "type": "number", "description": "日数", "format": "float", "example": 0.5 }, "hours": { "type": "integer", "description": "時間数", "format": "int32", "example": 0 } } }, "left": { "type": "number", "description": "残数", "format": "float", "minimum": 0, "maximum": 999999999.9999, "example": 1.5 }, "num_days_and_hours_left": { "type": "object", "description": "残日数・時間数", "properties": { "days": { "type": "number", "description": "日数", "format": "float", "example": 1.5 }, "hours": { "type": "integer", "description": "時間数", "format": "int32", "example": 0 } } } } } } } } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/v1/employees/{employee_id}/attendance_tag_summaries/{year}/{month}": { "get": { "tags": [ "勤怠タグサマリ" ], "summary": "勤怠タグ月次サマリの取得", "description": "\n 指定した従業員・年月の勤怠タグサマリの一覧を返します。
\n 年月は給与支払い月を指定してください。\n
\n 指定した従業員・年月の勤怠タグサマリを更新します。
\n 年月は給与支払い月を指定してください。\n
指定した従業員の利用可能な勤怠タグの一覧を返します。
", "operationId": "get_employees_attendance_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesAttendanceTagsController.index_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "404": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/notfoundError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/v1/employees/{employee_id}/attendance_tags/{date}": { "get": { "tags": [ "勤怠タグ" ], "summary": "勤怠タグと利用回数の取得", "description": "指定した従業員・日付の勤怠タグと利用回数の一覧を返します。
", "operationId": "get_employees_attendance_tags_by_date", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "employee_id", "in": "path", "description": "従業員ID", "required": true, "schema": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, { "name": "date", "in": "path", "description": "対象年月日(YYYY-MM-DD)(例:2018-08-01)", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiV1EmployeesAttendanceTagsController.show_response" } } } }, "400": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/error" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } }, "application/json": { "schema": { "$ref": "#/components/schemas/accessDeniedError" } } } }, "404": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/notfoundError" } } } }, "500": { "description": "", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "勤怠タグ" ], "summary": "勤怠タグの更新", "description": "指定した従業員・日付の勤怠タグを更新します。
\n\n指定した事業所に所属する従業員の給与明細をリストで返します。
\n指定した年月に支払いのある給与明細が返されます。
\n\n指定した従業員ID、年月の給与明細を返します。
\n指定した年月に支払いのある給与明細が返されます。
\n\n\n \n {\n \"employee_payroll_statement\": {\n \"id\": 1,\n \"company_id\": 1,\n \"employee_id\": 1,\n \"employee_name\": \"給与 太郎\",\n \"employee_display_name\": \"給与 太郎\",\n \"employee_num\": \"001\",\n \"pay_date\": \"2018-02-25\",\n \"start_date\": \"2018-02-01\",\n \"closing_date\": \"2018-02-28\",\n \"variable_pay_start_date\": \"2018-01-01\",\n \"variable_pay_closing_date\": \"2018-01-31\",\n \"fixed\": true,\n \"calc_status\": \"calculated\",\n \"calculated_at\": \"2018-09-27T05:06:45.315Z\",\n \"pay_calc_type\": \"monthly\",\n \"board_member_remuneration_amount\": \"400000.0\",\n \"basic_pay_amount\": \"300000.0\",\n \"work_days\": \"21.0\",\n \"normal_work_time\": \"8.0\",\n \"normal_work_days\": \"21.0\",\n \"work_mins_by_paid_holiday\": \"480.0\",\n \"num_paid_holidays\": \"1.0\",\n \"is_board_member\": true,\n \"total_attendance_deduction_amount\": \"0.0\",\n \"total_allowance_amount\": \"0.0\",\n \"total_deduction_amount\": \"23830.0\",\n \"total_deduction_employer_share\": \"16830.0\",\n \"net_payment_amount\": \"277170.0\",\n \"gross_payment_amount\": \"301000.0\",\n \"total_worked_days_count\": \"21.0\",\n \"total_taxable_payment_amount\": \"301000.0\",\n \"total_expense_amount\": \"0.0\",\n \"total_transfer_amount\": \"277170.0\",\n \"total_annual_payment_amount\": \"600000.0\",\n \"payments\": [{ \"name\": \"基本給\", \"amount\": \"300000.0\"},{ \"name\": \"残業代\", \"amount\": \"1000.0\"}],\n \"deductions\": [{\"name\": \"所得税\", \"amount\": \"7000.0\"}, {\"name\": \"健康保険料\", \"amount\": \"16830.0\"}],\n \"deductions_emloyers_share\": [{\"name\": \"健康保険料(会社負担分)\", \"amount\": \"16830.0\"}],\n \"attendances\": [{\"name\": \"遅刻・早退\", \"time\": \"0.0\", \"amount\": \"0.0\"}],\n \"overtime_pays\": [{ \"name\": \"時間外労働\", \"time\": \"60.0\", \"amount\": \"1000.0\", \"code\": null }, { \"name\": \"カスタム固定残業代\", \"time\": null, \"amount\": \"10000.0\", \"code\": \"a001\" }],\n \"remark\": \"備考\"\n }\n }\n \n",
"operationId": "get_salaries_employee_payroll_statement",
"parameters": [
{
"name": "company_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"description": "事業所ID"
},
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"description": "従業員情報を取得したい年"
},
{
"name": "month",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"description": "従業員情報を取得したい月"
},
{
"name": "employee_id",
"in": "path",
"description": "従業員ID",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiV1SalariesEmployeePayrollStatementsController.show_response"
}
}
}
},
"400": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unauthorizedError"
}
}
}
},
"403": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/forbiddenError"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/accessDeniedError"
}
}
}
},
"404": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/notfoundError"
}
}
}
},
"500": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/internalServerError"
}
}
}
}
}
}
},
"/api/v1/salaries/employee_payroll_statements/{employee_id}/remark": {
"put": {
"tags": [
"給与明細"
],
"summary": "給与明細の備考の更新",
"description": "指定した従業員の給与明細の備考を更新します。
\n\n指定した事業所に所属する従業員の賞与明細をリストで返します。
\n指定した年月に支払いのある賞与明細が返されます。
\n\n指定した従業員ID、年月の賞与明細を返します。
\n指定した年月に支払いのある賞与明細が返されます。
\n\n\n \n {\n \"employee_payroll_statement\": {\n \"id\": 1,\n \"company_id\": 1,\n \"employee_id\": 1,\n \"employee_name\": \"給与 太郎\",\n \"employee_display_name\": \"給与 太郎\",\n \"employee_num\": \"001\",\n \"closing_date\": \"2018-03-31\",\n \"pay_date\": \"2018-03-31\",\n \"fixed\": true,\n \"calc_status\": \"calculated\",\n \"calculated_at\": \"2018-09-27T05:06:45.315Z\",\n \"bonus_amount\": \"300000.0\",\n \"total_allowance_amount\": \"0.0\",\n \"total_deduction_amount\": \"23830.0\",\n \"net_payment_amount\": \"268000.0\",\n \"gross_payment_amount\": \"330000.0\",\n \"total_taxable_payment_amount\": \"330000.0\",\n \"allowances\": [{\"name\": \"地域手当\", \"amount\": \"30000.0\"}],\n \"deductions\": [{\"name\": \"所得税\", \"amount\": \"46000.0\"}, {\"name\": \"健康保険料\", \"amount\": \"16000.0\"}],\n \"remark\": \"備考\"\n }\n }\n \n",
"operationId": "get_bonuses_employee_payroll_statement",
"parameters": [
{
"name": "company_id",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
},
"description": "事業所ID"
},
{
"name": "year",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 2000,
"maximum": 2100
},
"description": "従業員情報を取得したい年"
},
{
"name": "month",
"in": "query",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 12
},
"description": "従業員情報を取得したい月"
},
{
"name": "employee_id",
"in": "path",
"description": "従業員ID",
"required": true,
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 2147483647
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiV1BonusesEmployeePayrollStatementsController.show_response"
}
}
}
},
"400": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/error"
}
}
}
},
"401": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/unauthorizedError"
}
}
}
},
"403": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/forbiddenError"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/accessDeniedError"
}
}
}
},
"404": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/notfoundError"
}
}
}
},
"500": {
"description": "",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/internalServerError"
}
}
}
}
}
}
},
"/api/v1/employee_group_memberships": {
"get": {
"tags": [
"所属"
],
"summary": "所属一覧の取得",
"description": "指定した事業所の指定日付時点における所属情報をリストで返します。
\n\n指定した従業員の所属情報をリストで返します。
\nbase_dateを指定した場合は指定日付時点の所属情報を、base_dateを省略した場合は全期間の所属履歴を返します。
\n\n指定した事業所の指定日付時点における部門情報をリストで返します。
\n部門APIの使い方については、部門APIを利用した組織図の取得について をご参照ください。
\n\n指定した事業所の部門を新規作成します。
\n部門APIの使い方については、部門APIを利用した組織図の取得について をご参照ください。
\n\n指定した事業所の部門の情報を更新します。
\n部門APIの使い方については、部門APIを利用した組織図の取得について をご参照ください。
\n\n指定した事業所の部門の情報を削除します。
\n部門APIの使い方については、部門APIを利用した組織図の取得について をご参照ください。
\n\n指定した事業所のその他手当情報をリストで返します。
\n\n指定した事業所のその他手当を新規作成します。
\n\n指定した事業所のその他手当情報を返します。
\n\n指定した事業所のその他控除情報をリストで返します。
\n\n指定した事業所のその他控除を新規作成します。
\n\n指定した事業所のその他控除情報を返します。
\n\n指定した事業所の指定日付時点における役職情報をリストで返します。
\n\n指定した事業所の役職を新規作成します。
\n\n指定した事業所の役職の情報を更新します。
\n\n指定した事業所の役職の情報を削除します。
\n\n指定した事業所の指定日付時点における月次勤怠締め申請情報をリストで返します。
\n\n指定した事業所の月次勤怠締め申請を新規作成します。
\n\n指定した事業所の月次勤怠締め申請情報を取得します。
\n\n指定した事業所の月次勤怠締め申請情報を更新します。
\n\n指定した事業所の月次勤怠締め申請情報を削除します。
\n\n指定した事業所の月次勤怠締め申請情報を承認操作します。
\n\n指定した事業所の指定日付時点における勤務時間修正申請情報をリストで返します。
\n\n指定した事業所の勤務時間修正を新規作成します。
\n\n\n \n {\n \"company_id\": 1,\n \"target_date\": \"2017-05-25\",\n \"break_records\": [\n {\n \"clock_in_at\": \"2017-05-25 12:00:00\",\n \"clock_out_at\": \"2017-05-25 13:00:00\"\n }\n ],\n \"work_records\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00\"\n }\n ],\n \"approval_flow_route_id\": 1\n }\n \n \n 指定した事業所の勤務時間修正申請情報を取得します。
\n\n指定した事業所の勤務時間修正申請情報を更新します。
\n\n\n \n {\n \"company_id\": 1,\n \"target_date\": \"2017-05-25\",\n \"break_records\": [\n {\n \"clock_in_at\": \"2017-05-25 12:00:00\",\n \"clock_out_at\": \"2017-05-25 13:00:00\"\n }\n ],\n \"work_records\": [\n {\n \"clock_in_at\": \"2017-05-25 09:10:00\",\n \"clock_out_at\": \"2017-05-25 18:20:00\"\n }\n ],\n \"approval_flow_route_id\": 1\n }\n \n \n 指定した事業所の勤務時間修正申請情報を削除します。
\n\n指定した事業所の勤務時間修正申請情報を承認操作します。
\n\n指定した事業所の指定日付時点における有給休暇申請情報をリストで返します。
\n\n指定した事業所の有給休暇申請を新規作成します。
\n\n指定した事業所の有給休暇申請情報を取得します。
\n\n指定した事業所の有給休暇申請情報を更新します。
\n\n指定した事業所の有給休暇申請情報を削除します。
\n\n指定した事業所の有給休暇申請情報を承認操作します。
\n\n指定した事業所の指定日付時点における特別休暇申請情報をリストで返します。
\n\n指定した事業所の特別休暇申請を新規作成します。
\n\n指定した事業所の特別休暇申請情報を取得します。
\n\n指定した事業所の特別休暇申請情報を更新します。
\n\n指定した事業所の特別休暇申請情報を削除します。
\n\n指定した事業所の特別休暇申請情報を承認操作します。
\n\n指定した事業所の指定日付時点における残業申請情報をリストで返します。
\n\n指定した事業所の残業申請を新規作成します。
\n\n指定した事業所の残業申請情報を取得します。
\n\n指定した事業所の残業申請情報を更新します。
\n\n指定した事業所の残業申請情報を削除します。
\n\n指定した事業所の残業申請情報を承認操作します。
\n\n指定した従業員・日付の残業申請に必要な設定情報を取得します。
\n指定した事業所の申請経路一覧を取得する。
\n\n指定した事業所の申請経路を取得する。
\n\n指定した従業員の姓名・住所などを更新します。
\n\n指定した従業員の給与・賞与を更新します。
\n\n指定した年末調整の家族情報を更新します。
\n指定した従業員の前職情報を更新します。
\n\n指定した従業員の前職情報を削除します。
\n\n指定した従業員の保険料情報を作成します。
\n指定した従業員の保険料情報を更新します。
\n指定した従業員の保険料情報を削除します。
\n指定した従業員の住宅ローン控除額を更新します。
\n指定した従業員の住宅ローンを作成します。
\n指定した従業員の住宅ローンを更新します。
\n指定した従業員の住宅ローンを削除します。
\n