diff --git a/hr/open-api-3/api-schema.json b/hr/open-api-3/api-schema.json
index b5c9145..4cec24d 100644
--- a/hr/open-api-3/api-schema.json
+++ b/hr/open-api-3/api-schema.json
@@ -5117,531 +5117,830 @@
}
}
},
- "ApiV1EmployeeSerializer": {
+ "ApiV1MonthlyAttendanceIndexResponseParams": {
"type": "object",
+ "required": [
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check"
+ ],
"properties": {
"id": {
"type": "integer",
- "description": "従業員ID",
- "format": "int32"
+ "description": "申請ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
"company_id": {
"type": "integer",
"description": "事業所ID",
- "format": "int32"
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "num": {
- "type": "string",
- "description": "従業員番号",
- "nullable": true
+ "application_number": {
+ "type": "integer",
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "display_name": {
- "type": "string",
- "description": "従業員名（表示名）"
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "base_pension_num": {
- "type": "string",
- "description": "基礎年金番号",
- "nullable": true
+ "approver_id": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
},
- "employment_insurance_reference_number": {
+ "target_date": {
"type": "string",
- "description": "被保険者番号（雇用保険）"
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+ "example": "2022-02-01"
},
- "birth_date": {
+ "issue_date": {
"type": "string",
- "description": "生年月日",
- "format": "date"
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "entry_date": {
+ "content": {
"type": "string",
- "description": "入社日",
- "format": "date"
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
},
- "retire_date": {
+ "status": {
"type": "string",
- "description": "退職日",
- "format": "date",
- "nullable": true
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
+ "enum": [
+ "in_progress",
+ "approved",
+ "feedback"
+ ],
+ "example": "in_progress"
},
- "user_id": {
+ "passed_auto_check": {
+ "type": "boolean",
+ "description": "自動チェック結果",
+ "example": true
+ }
+ }
+ },
+ "ApiV1MonthlyAttendanceResponseParams": {
+ "type": "object",
+ "required": [
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check",
+ "approval_flow_route_id",
+ "approval_flow_route_name",
+ "approval_flow_logs",
+ "current_step_id",
+ "current_round"
+ ],
+ "properties": {
+ "id": {
"type": "integer",
+ "description": "申請ID",
"format": "int32",
- "nullable": true
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "profile_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "health_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
+ "application_number": {
+ "type": "integer",
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "welfare_pension_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "dependent_rules": {
+ "approver_id": {
"type": "array",
- "description": "扶養親族",
"items": {
- "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
}
},
- "bank_account_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
- },
- "basic_pay_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
+ "target_date": {
+ "type": "string",
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+ "example": "2022-02-01"
},
- "payroll_calculation": {
- "type": "boolean",
- "description": "給与計算対象従業員の場合trueを返します",
- "example": true
- }
- }
- },
- "ApiV1UsersCompanySerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32"
+ "issue_date": {
+ "type": "string",
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "name": {
+ "content": {
"type": "string",
- "description": "事業所名"
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
},
- "role": {
+ "status": {
"type": "string",
- "description": "事業所におけるロール。\n- `company_admin`: 管理者ユーザ\n- `self_only`: 一般ユーザ",
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
"enum": [
- "company_admin",
- "self_only"
- ]
+ "in_progress",
+ "approved",
+ "feedback"
+ ],
+ "example": "in_progress"
},
- "external_cid": {
- "type": "string",
- "description": "事業所番号(半角数字10桁)"
+ "passed_auto_check": {
+ "type": "boolean",
+ "description": "自動チェック結果",
+ "example": true
},
- "employee_id": {
+ "approval_flow_route_id": {
"type": "integer",
- "description": "事業所に所属する従業員としての従業員ID、従業員情報が未登録の場合はnullになります。",
- "format": "int32",
- "nullable": true
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "申請経路ID",
+ "example": 1
},
- "display_name": {
+ "approval_flow_route_name": {
"type": "string",
- "description": "事業所に所属する従業員の表示名",
- "nullable": true
- }
- }
- },
- "ApiV1UsersMeSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "ユーザID",
- "format": "int32"
+ "description": "申請経路名",
+ "example": "申請経路"
},
- "companies": {
- "type": "array",
- "description": "ユーザが属する事業所の一覧",
- "items": {
- "$ref": "#/components/schemas/ApiV1UsersCompanySerializer"
- }
- }
- }
- },
- "ApiV1EmployeeGroupMembershipsIndexSerializer": {
- "type": "object",
- "properties": {
- "employee_group_memberships": {
+ "approval_flow_logs": {
"type": "array",
+ "description": "承認履歴",
"items": {
- "$ref": "#/components/schemas/ApiV1EmployeeGroupMembershipSerializer"
+ "$ref": "#/components/schemas/ApiV1ApprovalFlowLogsParams"
}
},
- "total_count": {
+ "current_step_id": {
"type": "integer",
+ "description": "現在承認ステップID",
"format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
"example": 1
- }
- }
- },
- "ApiV1BonusesEmployeePayrollStatementsIndexSerializer": {
- "type": "object",
- "properties": {
- "employee_payroll_statements": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ApiV1BonusesEmployeePayrollStatementSerializer"
- }
},
- "total_count": {
+ "current_round": {
"type": "integer",
- "format": "int32"
+ "description": "現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1BonusesEmployeePayrollStatementSerializer": {
+ "ApiV1PaidHolidayIndexResponseParams": {
"type": "object",
+ "required": [
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "holiday_type",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check"
+ ],
"properties": {
"id": {
"type": "integer",
- "description": "賞与明細ID",
- "format": "int32"
+ "description": "申請ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
"company_id": {
"type": "integer",
"description": "事業所ID",
- "format": "int32"
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "employee_id": {
+ "application_number": {
"type": "integer",
- "description": "従業員ID",
- "format": "int32"
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "employee_name": {
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "approver_id": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
+ },
+ "target_date": {
"type": "string",
- "description": "従業員の姓名"
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "employee_display_name": {
+ "holiday_type": {
"type": "string",
- "description": "従業員の表示名"
+ "description": "取得単位。（full:全休、half:半休、hour:時間休）",
+ "enum": [
+ "full",
+ "half",
+ "hour"
+ ],
+ "example": "half"
},
- "employee_num": {
+ "start_at": {
"type": "string",
- "description": "従業員番号",
- "nullable": true
+ "description": "取得予定開始時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 43200
},
- "closing_date": {
+ "end_at": {
"type": "string",
- "description": "確定日",
- "format": "date"
+ "description": "取得予定終了時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 86340
},
- "pay_date": {
+ "issue_date": {
"type": "string",
- "description": "支払日",
- "format": "date"
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "fixed": {
+ "content": {
+ "type": "string",
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
+ },
+ "comment": {
+ "type": "string",
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
+ },
+ "status": {
+ "type": "string",
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
+ "enum": [
+ "in_progress",
+ "approved",
+ "feedback"
+ ],
+ "example": "in_progress"
+ },
+ "passed_auto_check": {
"type": "boolean",
- "description": "賞与明細が確定されているかどうか"
+ "description": "自動チェック結果",
+ "example": true
+ }
+ }
+ },
+ "ApiV1PaidHolidayResponseParams": {
+ "type": "object",
+ "required": [
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "holiday_type",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check",
+ "approval_flow_route_id",
+ "approval_flow_route_name",
+ "approval_flow_logs",
+ "current_step_id",
+ "current_round"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "申請ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "calc_status": {
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "application_number": {
+ "type": "integer",
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "approver_id": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
+ },
+ "target_date": {
"type": "string",
- "description": "計算状況ステータス calculating: 計算中, calculated: 計算完了, error: エラー"
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "calculated_at": {
+ "holiday_type": {
"type": "string",
- "description": "計算状況ステータスの更新日",
- "format": "date-time",
- "nullable": true
+ "description": "取得単位。（full:全休、half:半休、hour:時間休）",
+ "enum": [
+ "full",
+ "half",
+ "hour"
+ ],
+ "example": "half"
},
- "bonus_amount": {
+ "start_at": {
"type": "string",
- "description": "賞与額",
- "nullable": true
+ "description": "取得予定開始時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 43200
},
- "total_allowance_amount": {
+ "end_at": {
"type": "string",
- "description": "手当額合計",
- "nullable": true
+ "description": "取得予定終了時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 86340
},
- "total_deduction_amount": {
+ "issue_date": {
"type": "string",
- "description": "控除額合計",
- "nullable": true
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "net_payment_amount": {
+ "content": {
"type": "string",
- "description": "差引支給額(手取り額)",
- "nullable": true
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
},
- "gross_payment_amount": {
+ "comment": {
"type": "string",
- "description": "総支給額(額面)",
- "nullable": true
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
},
- "total_taxable_payment_amount": {
+ "status": {
"type": "string",
- "description": "課税対象支給額",
- "nullable": true
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
+ "enum": [
+ "in_progress",
+ "approved",
+ "feedback"
+ ],
+ "example": "in_progress"
},
- "allowances": {
- "type": "array",
- "description": "手当",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeePayrollStatementsEmployeePayrollStatementItemSerializer"
- }
+ "passed_auto_check": {
+ "type": "boolean",
+ "description": "自動チェック結果",
+ "example": true
},
- "deductions": {
+ "approval_flow_route_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "申請経路ID",
+ "example": 1
+ },
+ "approval_flow_route_name": {
+ "type": "string",
+ "description": "申請経路名",
+ "example": "申請経路"
+ },
+ "approval_flow_logs": {
"type": "array",
- "description": "控除項目（所得税、社会保険料等）",
+ "description": "承認履歴",
"items": {
- "$ref": "#/components/schemas/ApiV1EmployeePayrollStatementsEmployeePayrollStatementItemSerializer"
+ "$ref": "#/components/schemas/ApiV1ApprovalFlowLogsParams"
}
},
- "remark": {
- "type": "string",
- "description": "備考"
+ "current_step_id": {
+ "type": "integer",
+ "description": "現在承認ステップID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "current_round": {
+ "type": "integer",
+ "description": "現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1CompaniesEmployeeSerializer": {
+ "ApiV1OvertimeWorkIndexResponseParams": {
"type": "object",
+ "required": [
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check"
+ ],
"properties": {
"id": {
"type": "integer",
- "description": "従業員ID",
- "format": "int32"
+ "description": "申請ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "num": {
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "application_number": {
+ "type": "integer",
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "approver_id": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
+ },
+ "target_date": {
"type": "string",
- "description": "従業員番号(従業員詳細未設定の場合、nullになります。)",
- "nullable": true
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "display_name": {
+ "start_at": {
"type": "string",
- "description": "従業員名（表示名）"
+ "description": "取得予定開始時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 43200
},
- "entry_date": {
+ "end_at": {
"type": "string",
- "description": "入社日",
- "format": "date-time"
+ "description": "取得予定終了時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 86340
},
- "retire_date": {
+ "issue_date": {
"type": "string",
- "description": "退職日",
- "format": "date-time",
- "nullable": true
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "user_id": {
- "type": "integer",
- "format": "int32",
- "description": "ユーザーID(従業員詳細未設定の場合、nullになります。)",
- "nullable": true
+ "content": {
+ "type": "string",
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
},
- "email": {
+ "comment": {
"type": "string",
- "description": "ログイン用メールアドレス(従業員詳細未設定の場合、nullになります。)",
- "nullable": true
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
},
- "payroll_calculation": {
+ "status": {
+ "type": "string",
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
+ "enum": [
+ "in_progress",
+ "approved",
+ "feedback"
+ ],
+ "example": "in_progress"
+ },
+ "passed_auto_check": {
"type": "boolean",
- "description": "給与計算対象従業員の場合trueを返します",
+ "description": "自動チェック結果",
"example": true
}
}
},
- "ApiV1EmployeesProfileRuleUpdateRequestSerializer": {
+ "ApiV1OvertimeWorkResponseParams": {
"type": "object",
"required": [
- "last_name",
- "first_name",
- "last_name_kana",
- "first_name_kana"
+ "id",
+ "company_id",
+ "application_number",
+ "applicant_id",
+ "approver_id",
+ "target_date",
+ "issue_date",
+ "content",
+ "status",
+ "passed_auto_check",
+ "approval_flow_route_id",
+ "approval_flow_route_name",
+ "approval_flow_logs",
+ "current_step_id",
+ "current_round"
],
"properties": {
- "last_name": {
- "type": "string",
- "description": "姓 null不可",
- "maxLength": 255
+ "id": {
+ "type": "integer",
+ "description": "申請ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "first_name": {
- "type": "string",
- "description": "名 null不可",
- "maxLength": 255
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "last_name_kana": {
- "type": "string",
- "description": "姓カナ",
- "maxLength": 255
+ "application_number": {
+ "type": "integer",
+ "description": "申請No",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "first_name_kana": {
- "type": "string",
- "description": "名カナ",
- "maxLength": 255
+ "applicant_id": {
+ "type": "integer",
+ "description": "申請者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "zipcode1": {
- "type": "string",
- "description": "住民票住所の郵便番号1",
- "maxLength": 3
- },
- "zipcode2": {
- "type": "string",
- "description": "住民票住所の郵便番号2",
- "maxLength": 4
- },
- "prefecture_code": {
- "type": "integer",
- "minimum": -1,
- "maximum": 46,
- "description": "住民票住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
- "example": 4
- },
- "address": {
- "type": "string",
- "description": "住民票住所の市区町村以降の住所",
- "maxLength": 255
- },
- "address_kana": {
- "type": "string",
- "description": "住民票住所の市区町村以降の住所カナ",
- "maxLength": 255
- },
- "phone1": {
- "type": "string",
- "description": "電話番号1",
- "maxLength": 5
- },
- "phone2": {
- "type": "string",
- "description": "電話番号2",
- "maxLength": 4
- },
- "phone3": {
- "type": "string",
- "description": "電話番号3",
- "maxLength": 4
+ "approver_id": {
+ "type": "array",
+ "items": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
},
- "residential_zipcode1": {
+ "target_date": {
"type": "string",
- "description": "現住所の郵便番号１",
- "maxLength": 3
+ "description": "対象日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "residential_zipcode2": {
+ "start_at": {
"type": "string",
- "description": "現住所の郵便番号２",
- "maxLength": 4
- },
- "residential_prefecture_code": {
- "type": "integer",
- "minimum": -1,
- "maximum": 46,
- "description": "現住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
- "example": 4
+ "description": "取得予定開始時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 43200
},
- "residential_address": {
+ "end_at": {
"type": "string",
- "description": "現住所の住所",
- "maxLength": 255
+ "description": "取得予定終了時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "nullable": true,
+ "example": 86340
},
- "residential_address_kana": {
+ "issue_date": {
"type": "string",
- "description": "現住所の住所カナ",
- "maxLength": 255
+ "description": "申請日",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "employment_type": {
+ "content": {
"type": "string",
- "description": "雇用形態 board-member: 役員, (空文字列): 役員以外",
- "enum": [
- "board-member",
- ""
- ]
+ "description": "申請内容",
+ "nullable": true,
+ "example": "申請内容"
},
- "title": {
+ "comment": {
"type": "string",
- "description": "肩書",
- "maxLength": 255
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
},
- "gender": {
+ "status": {
"type": "string",
- "description": "性別 unselected: 未選択, male: 男性, female: 女性（デフォルト: unselected: 未選択）",
+ "description": "申請ステータス。（in_progress:申請中、approved:承認済、feedback:差戻し）",
"enum": [
- "unselected",
- "male",
- "female"
+ "in_progress",
+ "approved",
+ "feedback"
],
- "example": "male"
+ "example": "in_progress"
},
- "married": {
+ "passed_auto_check": {
"type": "boolean",
- "description": "null不可 配偶者の有無"
+ "description": "自動チェック結果",
+ "example": true
},
- "is_working_student": {
- "type": "boolean",
- "description": "null不可 勤労学生かどうか"
+ "approval_flow_route_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "申請経路ID",
+ "example": 1
},
- "widow_type": {
+ "approval_flow_route_name": {
"type": "string",
- "description": "寡夫／寡婦かどうか null不可 na: 空白, widower: 寡夫, widow: 寡婦, special_widow: 特別寡婦, one_parent: ひとり親",
- "enum": [
- "na",
- "widower",
- "widow",
- "special_widow",
- "one_parent"
- ]
+ "description": "申請経路名",
+ "example": "申請経路"
},
- "disability_type": {
- "type": "string",
- "description": "障害者かどうか null不可 na: 空白, general: 障害者, heavy: 特別障害者",
- "enum": [
- "na",
- "general",
- "heavy"
- ]
- }
- }
- },
- "ApiV1EmployeesEmployeeMultiHourlyWageWorkRecordSummarySerializer": {
- "type": "object",
- "properties": {
- "name": {
- "type": "string",
- "description": "時給名"
+ "approval_flow_logs": {
+ "type": "array",
+ "description": "承認履歴",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1ApprovalFlowLogsParams"
+ }
},
- "total_normal_time_mins": {
+ "current_step_id": {
"type": "integer",
- "description": "所定内労働時間（分）",
- "format": "int32"
- }
- }
- },
- "ApiV1EmployeesWorkRecordTimeRangeSerializer": {
- "type": "object",
- "required": [
- "clock_in_at",
- "clock_out_at"
- ],
- "properties": {
- "clock_in_at": {
- "type": "string",
- "description": "開始時刻",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
+ "description": "現在承認ステップID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "clock_out_at": {
- "type": "string",
- "description": "終了時刻",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
+ "current_round": {
+ "type": "integer",
+ "description": "現在のround。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1EmployeesWorkRecordTimeRangeResponseSerializer": {
+ "ApiV1ApprovalFlowLogsParams": {
"type": "object",
"properties": {
- "clock_in_at": {
+ "employee_id": {
+ "type": "integer",
+ "description": "申請操作をした従業員ID",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "action": {
"type": "string",
- "description": "開始時刻",
- "format": "date-time"
+ "description": "申請操作。（apply:申請する、approve:承認、cancel:取り消し、feedback:差戻し）",
+ "enum": [
+ "apply",
+ "approve",
+ "cancel",
+ "feedback"
+ ],
+ "example": "approve"
},
- "clock_out_at": {
+ "update_at": {
"type": "string",
- "description": "終了時刻",
- "format": "date-time"
+ "description": "申請操作をした日付時間",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$"
}
}
},
- "ApiV1EmployeesWelfarePensionInsuranceRuleSerializer": {
+ "ApiV1EmployeeSerializer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
+ "description": "従業員ID",
"format": "int32"
},
"company_id": {
@@ -5649,218 +5948,319 @@
"description": "事業所ID",
"format": "int32"
},
- "employee_id": {
- "type": "integer",
- "description": "従業員ID",
- "format": "int32"
+ "num": {
+ "type": "string",
+ "description": "従業員番号",
+ "nullable": true
},
- "entried": {
- "type": "boolean",
- "description": "厚生年金保険に加入しているかどうか"
+ "display_name": {
+ "type": "string",
+ "description": "従業員名（表示名）"
},
- "reference_num": {
+ "base_pension_num": {
"type": "string",
- "description": "厚生年金保険の被保険者整理番号",
+ "description": "基礎年金番号",
"nullable": true
},
- "standard_monthly_remuneration": {
- "type": "integer",
- "description": "標準報酬月額",
- "format": "int32"
- }
- },
- "nullable": true
- },
- "ApiV1EmployeesHealthInsuranceRuleUpdateRequestSerializer": {
- "type": "object",
- "required": [
- "standard_monthly_remuneration"
- ],
- "properties": {
- "entried": {
- "type": "boolean",
- "description": "健康保険に加入しているかどうか null不可"
+ "employment_insurance_reference_number": {
+ "type": "string",
+ "description": "被保険者番号（雇用保険）"
},
- "reference_num": {
+ "birth_date": {
"type": "string",
- "description": "健康保険の被保険者整理番号",
- "maxLength": 255,
- "example": 1
+ "description": "生年月日",
+ "format": "date"
},
- "standard_monthly_remuneration": {
+ "entry_date": {
+ "type": "string",
+ "description": "入社日",
+ "format": "date"
+ },
+ "retire_date": {
+ "type": "string",
+ "description": "退職日",
+ "format": "date",
+ "nullable": true
+ },
+ "user_id": {
"type": "integer",
- "description": "標準報酬月額 null不可",
"format": "int32",
- "minimum": 1,
- "maximum": 2147483647,
- "example": 58000
- }
- }
- },
- "ApiV1EmployeesProfileRuleSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "format": "int32"
+ "nullable": true
},
- "company_id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32"
+ "profile_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
},
- "employee_id": {
+ "health_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
+ },
+ "welfare_pension_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ },
+ "dependent_rules": {
+ "type": "array",
+ "description": "扶養親族",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
+ }
+ },
+ "bank_account_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
+ },
+ "basic_pay_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
+ },
+ "payroll_calculation": {
+ "type": "boolean",
+ "description": "給与計算対象従業員の場合trueを返します",
+ "example": true
+ }
+ }
+ },
+ "ApiV1UsersCompanySerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
- "description": "従業員ID",
+ "description": "事業所ID",
"format": "int32"
},
- "last_name": {
- "type": "string",
- "description": "姓"
- },
- "first_name": {
+ "name": {
"type": "string",
- "description": "名"
+ "description": "事業所名"
},
- "last_name_kana": {
+ "role": {
"type": "string",
- "description": "姓カナ"
+ "description": "事業所におけるロール。\n- `company_admin`: 管理者ユーザ\n- `self_only`: 一般ユーザ",
+ "enum": [
+ "company_admin",
+ "self_only"
+ ]
},
- "first_name_kana": {
+ "external_cid": {
"type": "string",
- "description": "名カナ"
+ "description": "事業所番号(半角数字10桁)"
},
- "zipcode1": {
- "type": "string",
- "description": "住民票住所の郵便番号1",
+ "employee_id": {
+ "type": "integer",
+ "description": "事業所に所属する従業員としての従業員ID、従業員情報が未登録の場合はnullになります。",
+ "format": "int32",
"nullable": true
},
- "zipcode2": {
+ "display_name": {
"type": "string",
- "description": "住民票住所の郵便番号2",
+ "description": "事業所に所属する従業員の表示名",
"nullable": true
+ }
+ }
+ },
+ "ApiV1UsersMeSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "ユーザID",
+ "format": "int32"
},
- "prefecture_code": {
+ "companies": {
+ "type": "array",
+ "description": "ユーザが属する事業所の一覧",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1UsersCompanySerializer"
+ }
+ }
+ }
+ },
+ "ApiV1EmployeeGroupMembershipsIndexSerializer": {
+ "type": "object",
+ "properties": {
+ "employee_group_memberships": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeeGroupMembershipSerializer"
+ }
+ },
+ "total_count": {
"type": "integer",
- "nullable": true,
- "minimum": -1,
- "maximum": 46,
- "description": "住民票住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
- "example": 4
+ "format": "int32",
+ "example": 1
+ }
+ }
+ },
+ "ApiV1BonusesEmployeePayrollStatementsIndexSerializer": {
+ "type": "object",
+ "properties": {
+ "employee_payroll_statements": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1BonusesEmployeePayrollStatementSerializer"
+ }
},
- "address": {
+ "total_count": {
+ "type": "integer",
+ "format": "int32"
+ }
+ }
+ },
+ "ApiV1BonusesEmployeePayrollStatementSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "賞与明細ID",
+ "format": "int32"
+ },
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32"
+ },
+ "employee_id": {
+ "type": "integer",
+ "description": "従業員ID",
+ "format": "int32"
+ },
+ "employee_name": {
"type": "string",
- "description": "住民票住所の市区町村以降の住所",
- "nullable": true
+ "description": "従業員の姓名"
},
- "address_kana": {
+ "employee_display_name": {
"type": "string",
- "description": "住民票住所の市区町村以降の住所カナ"
+ "description": "従業員の表示名"
},
- "phone1": {
+ "employee_num": {
"type": "string",
- "description": "電話番号1",
+ "description": "従業員番号",
"nullable": true
},
- "phone2": {
+ "closing_date": {
"type": "string",
- "description": "電話番号2",
- "nullable": true
+ "description": "確定日",
+ "format": "date"
},
- "phone3": {
+ "pay_date": {
"type": "string",
- "description": "電話番号3",
- "nullable": true
+ "description": "支払日",
+ "format": "date"
},
- "residential_zipcode1": {
+ "fixed": {
+ "type": "boolean",
+ "description": "賞与明細が確定されているかどうか"
+ },
+ "calc_status": {
"type": "string",
- "description": "現住所の郵便番号１",
- "nullable": true
+ "description": "計算状況ステータス calculating: 計算中, calculated: 計算完了, error: エラー"
},
- "residential_zipcode2": {
+ "calculated_at": {
"type": "string",
- "description": "現住所の郵便番号２",
+ "description": "計算状況ステータスの更新日",
+ "format": "date-time",
"nullable": true
},
- "residential_prefecture_code": {
- "type": "integer",
- "nullable": true,
- "minimum": -1,
- "maximum": 46,
- "description": "現住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
- "example": 4
- },
- "residential_address": {
+ "bonus_amount": {
"type": "string",
- "description": "現住所の住所",
+ "description": "賞与額",
"nullable": true
},
- "residential_address_kana": {
+ "total_allowance_amount": {
"type": "string",
- "description": "現住所の住所カナ",
+ "description": "手当額合計",
"nullable": true
},
- "employment_type": {
+ "total_deduction_amount": {
"type": "string",
- "description": "雇用形態 board-member: 役員, (空文字列): 役員以外",
+ "description": "控除額合計",
"nullable": true
},
- "title": {
+ "net_payment_amount": {
"type": "string",
- "description": "肩書",
+ "description": "差引支給額(手取り額)",
"nullable": true
},
- "gender": {
+ "gross_payment_amount": {
"type": "string",
- "description": "性別 unselected: 未選択, male: 男性, female: 女性",
- "enum": [
- "unselected",
- "male",
- "female"
- ],
- "example": "male"
+ "description": "総支給額(額面)",
+ "nullable": true
},
- "married": {
- "type": "boolean",
- "description": "配偶者の有無"
+ "total_taxable_payment_amount": {
+ "type": "string",
+ "description": "課税対象支給額",
+ "nullable": true
},
- "is_working_student": {
- "type": "boolean",
- "description": "勤労学生かどうか"
+ "allowances": {
+ "type": "array",
+ "description": "手当",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeePayrollStatementsEmployeePayrollStatementItemSerializer"
+ }
},
- "widow_type": {
- "type": "string",
- "description": "寡夫／寡婦かどうか na: 空白, widower: 寡夫, widow: 寡婦, special_widow: 特別寡婦"
+ "deductions": {
+ "type": "array",
+ "description": "控除項目（所得税、社会保険料等）",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeePayrollStatementsEmployeePayrollStatementItemSerializer"
+ }
},
- "disability_type": {
+ "remark": {
"type": "string",
- "description": "障害者かどうか na: 空白, general: 障害者, heavy: 特別障害者"
+ "description": "備考"
}
- },
- "nullable": true
+ }
},
- "ApiV1EmployeesDependentRuleUpdateRequestSerializer": {
+ "ApiV1CompaniesEmployeeSerializer": {
"type": "object",
- "required": [
- "last_name",
- "first_name",
- "gender",
- "relationship",
- "birth_date",
- "residence_type",
- "income",
- "annual_revenue",
- "disability_type",
- "social_insurance_and_tax_dependent"
- ],
"properties": {
"id": {
"type": "integer",
- "description": "扶養親族ID（idがない場合は新規作成になる)",
+ "description": "従業員ID",
+ "format": "int32"
+ },
+ "num": {
+ "type": "string",
+ "description": "従業員番号(従業員詳細未設定の場合、nullになります。)",
+ "nullable": true
+ },
+ "display_name": {
+ "type": "string",
+ "description": "従業員名（表示名）"
+ },
+ "entry_date": {
+ "type": "string",
+ "description": "入社日",
+ "format": "date-time"
+ },
+ "retire_date": {
+ "type": "string",
+ "description": "退職日",
+ "format": "date-time",
+ "nullable": true
+ },
+ "user_id": {
+ "type": "integer",
"format": "int32",
- "minimum": 1,
- "maximum": 2147483647
+ "description": "ユーザーID(従業員詳細未設定の場合、nullになります。)",
+ "nullable": true
+ },
+ "email": {
+ "type": "string",
+ "description": "ログイン用メールアドレス(従業員詳細未設定の場合、nullになります。)",
+ "nullable": true
},
+ "payroll_calculation": {
+ "type": "boolean",
+ "description": "給与計算対象従業員の場合trueを返します",
+ "example": true
+ }
+ }
+ },
+ "ApiV1EmployeesProfileRuleUpdateRequestSerializer": {
+ "type": "object",
+ "required": [
+ "last_name",
+ "first_name",
+ "last_name_kana",
+ "first_name_kana"
+ ],
+ "properties": {
"last_name": {
"type": "string",
"description": "姓 null不可",
@@ -5881,57 +6281,6 @@
"description": "名カナ",
"maxLength": 255
},
- "gender": {
- "type": "string",
- "description": "性別 unselected: 未選択, male: 男性, female: 女性（デフォルト: unselected: 未選択）",
- "enum": [
- "unselected",
- "male",
- "female"
- ],
- "example": "male"
- },
- "relationship": {
- "type": "string",
- "description": "続柄 null不可 spouse: 配偶者, father: 父, mother: 母, child: 子, senior_brother: 兄, junior_brother: 弟, senior_sister: 姉, junior_sister: 妹, grandchild: 孫, grandfather: 祖父, grandmother: 祖母, father_in_law: 義父, mother_in_law: 義母, grandfather_in_law: 義祖父, grandmother_in_law: 義祖母, other: その他, great_grandfather: 曽祖父, great_grandmother: 曽祖母, spouses_child: 配偶者の連れ子",
- "enum": [
- "spouse",
- "father",
- "mother",
- "child",
- "senior_brother",
- "junior_brother",
- "senior_sister",
- "junior_sister",
- "grandchild",
- "grandfather",
- "grandmother",
- "father_in_law",
- "mother_in_law",
- "grandfather_in_law",
- "grandmother_in_law",
- "other",
- "great_grandfather",
- "great_grandmother",
- "spouses_child"
- ]
- },
- "birth_date": {
- "type": "string",
- "description": "生年月日 null不可",
- "format": "date",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
- "maxLength": 10
- },
- "residence_type": {
- "type": "string",
- "description": "同居・別居 null不可 live_in: 同居, resident: 別居(国内), non_resident: 別居(国外)",
- "enum": [
- "live_in",
- "resident",
- "non_resident"
- ]
- },
"zipcode1": {
"type": "string",
"description": "住民票住所の郵便番号1",
@@ -5959,678 +6308,460 @@
"description": "住民票住所の市区町村以降の住所カナ",
"maxLength": 255
},
- "base_pension_num": {
+ "phone1": {
"type": "string",
- "description": "基礎年金番号",
- "maxLength": 10
+ "description": "電話番号1",
+ "maxLength": 5
},
- "income": {
- "type": "integer",
- "description": "年間所得 null不可",
- "format": "int32",
- "minimum": 0,
- "maximum": 999999999
+ "phone2": {
+ "type": "string",
+ "description": "電話番号2",
+ "maxLength": 4
},
- "annual_revenue": {
- "type": "integer",
- "description": "年間収入 null不可",
- "format": "int32",
- "minimum": 0,
- "maximum": 999999999
+ "phone3": {
+ "type": "string",
+ "description": "電話番号3",
+ "maxLength": 4
},
- "disability_type": {
+ "residential_zipcode1": {
"type": "string",
- "description": "障害に該当するか null不可 na: 障害なし, general: 一般の障害者, heavy: 特別障害者",
- "enum": [
- "na",
- "general",
- "heavy"
- ]
+ "description": "現住所の郵便番号１",
+ "maxLength": 3
},
- "occupation": {
+ "residential_zipcode2": {
"type": "string",
- "description": "職業",
- "maxLength": 255
+ "description": "現住所の郵便番号２",
+ "maxLength": 4
},
- "annual_remittance_amount": {
+ "residential_prefecture_code": {
"type": "integer",
- "description": "一年間の送金額",
- "format": "int32",
- "minimum": 0,
- "maximum": 999999999
+ "minimum": -1,
+ "maximum": 46,
+ "description": "現住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
+ "example": 4
},
- "destroy": {
- "type": "boolean",
- "description": "扶養親族を削除するか"
+ "residential_address": {
+ "type": "string",
+ "description": "現住所の住所",
+ "maxLength": 255
},
- "social_insurance_and_tax_dependent": {
+ "residential_address_kana": {
"type": "string",
- "description": "扶養状況 social_insurance_and_tax: 所得税・住民税と社会保険, tax_only: 所得税・住民税のみ, social_insurance_only: 社会保険のみ, not_dependent: 扶養していない",
+ "description": "現住所の住所カナ",
+ "maxLength": 255
+ },
+ "employment_type": {
+ "type": "string",
+ "description": "雇用形態 board-member: 役員, (空文字列): 役員以外",
"enum": [
- "social_insurance_and_tax",
- "tax_only",
- "social_insurance_only",
- "not_dependent"
+ "board-member",
+ ""
]
- }
- }
- },
- "ApiV1EmployeesTimeClockSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "打刻ID",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
},
- "date": {
+ "title": {
"type": "string",
- "description": "打刻日",
- "format": "date"
+ "description": "肩書",
+ "maxLength": 255
},
- "type": {
+ "gender": {
"type": "string",
- "description": "打刻種別",
+ "description": "性別 unselected: 未選択, male: 男性, female: 女性（デフォルト: unselected: 未選択）",
"enum": [
- "clock_in",
- "break_begin",
- "break_end",
- "clock_out"
- ]
+ "unselected",
+ "male",
+ "female"
+ ],
+ "example": "male"
},
- "datetime": {
- "type": "string",
- "description": "打刻時刻",
- "format": "date-time"
+ "married": {
+ "type": "boolean",
+ "description": "null不可 配偶者の有無"
},
- "original_datetime": {
+ "is_working_student": {
+ "type": "boolean",
+ "description": "null不可 勤労学生かどうか"
+ },
+ "widow_type": {
"type": "string",
- "description": "オリジナルの打刻時間",
- "format": "date-time"
+ "description": "寡夫／寡婦かどうか null不可 na: 空白, widower: 寡夫, widow: 寡婦, special_widow: 特別寡婦, one_parent: ひとり親",
+ "enum": [
+ "na",
+ "widower",
+ "widow",
+ "special_widow",
+ "one_parent"
+ ]
},
- "note": {
+ "disability_type": {
"type": "string",
- "description": "打刻メモ",
- "maxLength": 255
+ "description": "障害者かどうか null不可 na: 空白, general: 障害者, heavy: 特別障害者",
+ "enum": [
+ "na",
+ "general",
+ "heavy"
+ ]
}
}
},
- "ApiV1EmployeesWorkRecordSummarySerializer": {
+ "ApiV1EmployeesEmployeeMultiHourlyWageWorkRecordSummarySerializer": {
"type": "object",
"properties": {
- "year": {
- "type": "integer",
- "description": "給与支払い年",
- "format": "int32"
+ "name": {
+ "type": "string",
+ "description": "時給名"
},
- "month": {
+ "total_normal_time_mins": {
"type": "integer",
- "description": "給与支払い月",
- "format": "int32",
- "minimum": 1,
- "maximum": 12
- },
- "start_date": {
+ "description": "所定内労働時間（分）",
+ "format": "int32"
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordTimeRangeSerializer": {
+ "type": "object",
+ "required": [
+ "clock_in_at",
+ "clock_out_at"
+ ],
+ "properties": {
+ "clock_in_at": {
"type": "string",
- "description": "集計開始日",
- "format": "date"
+ "description": "開始時刻",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
},
- "end_date": {
+ "clock_out_at": {
"type": "string",
- "description": "集計終了日",
- "format": "date"
- },
- "work_days": {
- "type": "number",
- "description": "労働日数",
- "format": "float"
+ "description": "終了時刻",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordTimeRangeResponseSerializer": {
+ "type": "object",
+ "properties": {
+ "clock_in_at": {
+ "type": "string",
+ "description": "開始時刻",
+ "format": "date-time"
},
- "total_work_mins": {
+ "clock_out_at": {
+ "type": "string",
+ "description": "終了時刻",
+ "format": "date-time"
+ }
+ }
+ },
+ "ApiV1EmployeesWelfarePensionInsuranceRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
- "description": "総勤務時間（分）",
"format": "int32"
},
- "total_normal_work_mins": {
+ "company_id": {
"type": "integer",
- "description": "所定内労働時間（分）",
+ "description": "事業所ID",
"format": "int32"
},
- "total_excess_statutory_work_mins": {
+ "employee_id": {
"type": "integer",
- "description": "給与計算に用いられる法定内残業時間（分）",
+ "description": "従業員ID",
"format": "int32"
},
- "total_overtime_except_normal_work_mins": {
+ "entried": {
+ "type": "boolean",
+ "description": "厚生年金保険に加入しているかどうか"
+ },
+ "reference_num": {
+ "type": "string",
+ "description": "厚生年金保険の被保険者整理番号",
+ "nullable": true
+ },
+ "standard_monthly_remuneration": {
"type": "integer",
- "description": "所定外法定外労働時間",
+ "description": "標準報酬月額",
"format": "int32"
+ }
+ },
+ "nullable": true
+ },
+ "ApiV1EmployeesHealthInsuranceRuleUpdateRequestSerializer": {
+ "type": "object",
+ "required": [
+ "standard_monthly_remuneration"
+ ],
+ "properties": {
+ "entried": {
+ "type": "boolean",
+ "description": "健康保険に加入しているかどうか null不可"
},
- "total_overtime_within_normal_work_mins": {
+ "reference_num": {
+ "type": "string",
+ "description": "健康保険の被保険者整理番号",
+ "maxLength": 255,
+ "example": 1
+ },
+ "standard_monthly_remuneration": {
+ "type": "integer",
+ "description": "標準報酬月額 null不可",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 58000
+ }
+ }
+ },
+ "ApiV1EmployeesProfileRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
"type": "integer",
- "description": "所定内法定外労働時間（裁量労働制の場合はみなしベース）",
"format": "int32"
},
- "total_holiday_work_mins": {
+ "company_id": {
"type": "integer",
- "description": "法定休日労働時間（分）",
+ "description": "事業所ID",
"format": "int32"
},
- "total_latenight_work_mins": {
+ "employee_id": {
"type": "integer",
- "description": "深夜労働allow(company)時間（分）",
+ "description": "従業員ID",
"format": "int32"
},
- "num_absences": {
- "type": "number",
- "description": "欠勤日数",
- "format": "float"
- },
- "num_paid_holidays": {
- "type": "number",
- "description": "有給取得日数",
- "format": "float"
- },
- "num_paid_holidays_and_hours": {
- "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
- },
- "num_paid_holidays_left": {
- "type": "number",
- "description": "有給残日数",
- "format": "float"
+ "last_name": {
+ "type": "string",
+ "description": "姓"
},
- "num_paid_holidays_and_hours_left": {
- "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
+ "first_name": {
+ "type": "string",
+ "description": "名"
},
- "num_substitute_holidays_used": {
- "type": "number",
- "description": "振替休日の使用日数",
- "format": "float"
+ "last_name_kana": {
+ "type": "string",
+ "description": "姓カナ"
},
- "num_compensatory_holidays_used": {
- "type": "number",
- "description": "代休の使用日数",
- "format": "float"
+ "first_name_kana": {
+ "type": "string",
+ "description": "名カナ"
},
- "num_special_holidays_used": {
- "type": "number",
- "description": "特別休暇の使用日数",
- "format": "float"
+ "zipcode1": {
+ "type": "string",
+ "description": "住民票住所の郵便番号1",
+ "nullable": true
},
- "num_special_holidays_and_hours_used": {
- "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
+ "zipcode2": {
+ "type": "string",
+ "description": "住民票住所の郵便番号2",
+ "nullable": true
},
- "total_lateness_and_early_leaving_mins": {
+ "prefecture_code": {
"type": "integer",
- "description": "遅刻早退時間（分）",
- "format": "int32"
- },
- "multi_hourly_wages": {
- "type": "array",
- "description": "複数時給の労働時間の内訳（複数時給を設定している従業員のみ）",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesEmployeeMultiHourlyWageWorkRecordSummarySerializer"
- }
- },
- "work_records": {
- "type": "array",
- "description": "日々の勤怠情報",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordSerializer"
- }
+ "nullable": true,
+ "minimum": -1,
+ "maximum": 46,
+ "description": "住民票住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
+ "example": 4
},
- "total_shortage_work_mins": {
- "type": "integer",
- "description": "不足時間（分）",
- "format": "int32",
+ "address": {
+ "type": "string",
+ "description": "住民票住所の市区町村以降の住所",
"nullable": true
},
- "total_deemed_paid_excess_statutory_work_mins": {
- "type": "integer",
- "description": "支給対象の法定内残業時間（分）",
- "format": "int32",
- "nullable": true
+ "address_kana": {
+ "type": "string",
+ "description": "住民票住所の市区町村以降の住所カナ"
},
- "total_deemed_paid_overtime_except_normal_work_mins": {
- "type": "integer",
- "description": "支給対象の時間外労働時間（分）",
- "format": "int32",
+ "phone1": {
+ "type": "string",
+ "description": "電話番号1",
"nullable": true
- }
- }
- },
- "ApiV1EmployeesWorkRecordSerializer": {
- "type": "object",
- "properties": {
- "break_records": {
- "type": "array",
- "description": "休憩時間のリスト",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordTimeRangeResponseSerializer"
- }
},
- "clock_in_at": {
+ "phone2": {
"type": "string",
- "description": "出勤時間",
- "format": "date-time",
+ "description": "電話番号2",
"nullable": true
},
- "clock_out_at": {
+ "phone3": {
"type": "string",
- "description": "退勤時間",
- "format": "date-time",
+ "description": "電話番号3",
"nullable": true
},
- "date": {
+ "residential_zipcode1": {
"type": "string",
- "description": "対象日付",
- "format": "date-time"
+ "description": "現住所の郵便番号１",
+ "nullable": true
},
- "day_pattern": {
+ "residential_zipcode2": {
"type": "string",
- "description": "勤務パターン\n- normal_day: 所定労働日\n- prescribed_holiday: 所定休日\n- legal_holiday: 法定休日",
- "enum": [
- "normal_day",
- "prescribed_holiday",
- "legal_holiday"
- ]
- },
- "schedule_pattern": {
- "type": "string",
- "description": "スケジュールパターン\n- substitute_holiday_work: 振替出勤\n- substitute_holiday: 振替休日\n- compensatory_holiday_work: 代休出勤\n- compensatory_holiday: 代休\n- special_holiday: 特別休暇",
- "enum": [
- "",
- "substitute_holiday_work",
- "substitute_holiday",
- "compensatory_holiday_work",
- "compensatory_holiday",
- "special_holiday"
- ]
- },
- "early_leaving_mins": {
- "type": "integer",
- "description": "早退分の時間（分単位）",
- "format": "int32"
- },
- "hourly_paid_holiday_mins": {
- "type": "integer",
- "description": "時間休を利用した時間（分単位）",
- "format": "int32"
- },
- "is_absence": {
- "type": "boolean",
- "description": "欠勤かどうか",
- "example": false
- },
- "is_editable": {
- "type": "boolean",
- "description": "勤怠データが編集可能かどうか"
+ "description": "現住所の郵便番号２",
+ "nullable": true
},
- "lateness_mins": {
+ "residential_prefecture_code": {
"type": "integer",
- "description": "遅刻分の時間（分単位）",
- "format": "int32"
+ "nullable": true,
+ "minimum": -1,
+ "maximum": 46,
+ "description": "現住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
+ "example": 4
},
- "normal_work_clock_in_at": {
+ "residential_address": {
"type": "string",
- "description": "所定労働開始時刻",
- "format": "date-time",
+ "description": "現住所の住所",
"nullable": true
},
- "normal_work_clock_out_at": {
+ "residential_address_kana": {
"type": "string",
- "description": "所定労働終了時刻",
- "format": "date-time",
+ "description": "現住所の住所カナ",
"nullable": true
},
- "normal_work_mins": {
- "type": "integer",
- "description": "所定労働時間",
- "format": "int32"
- },
- "normal_work_mins_by_paid_holiday": {
- "type": "integer",
- "description": "有給によって計上される所定労働時間（分）",
- "format": "int32"
- },
- "note": {
+ "employment_type": {
"type": "string",
- "description": "勤怠メモ",
- "maxLength": 255
+ "description": "雇用形態 board-member: 役員, (空文字列): 役員以外",
+ "nullable": true
},
- "paid_holiday": {
- "type": "number",
- "description": "この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。",
- "format": "float"
+ "title": {
+ "type": "string",
+ "description": "肩書",
+ "nullable": true
},
- "use_attendance_deduction": {
- "type": "boolean",
- "description": "欠勤・遅刻・早退を控除対象時間に算入するかどうか"
+ "gender": {
+ "type": "string",
+ "description": "性別 unselected: 未選択, male: 男性, female: 女性",
+ "enum": [
+ "unselected",
+ "male",
+ "female"
+ ],
+ "example": "male"
},
- "use_default_work_pattern": {
+ "married": {
"type": "boolean",
- "description": "デフォルトの勤務時間設定を使っているかどうか"
- },
- "total_overtime_work_mins": {
- "type": "integer",
- "description": "時間外労働時間（分）（Webの勤怠登録画面にて詳細項目の「勤務時間の長さを自動で計算しない」にチェックを入れた場合0が返却されます。時間外労働時間はtotal_overtime_except_normal_work_minsを参照してください。）",
- "format": "int32"
- },
- "total_holiday_work_mins": {
- "type": "integer",
- "description": "休日労働時間（分）",
- "format": "int32"
- },
- "total_latenight_work_mins": {
- "type": "integer",
- "description": "深夜労働時間（分）",
- "format": "int32"
+ "description": "配偶者の有無"
},
- "not_auto_calc_work_time": {
+ "is_working_student": {
"type": "boolean",
- "description": "勤怠登録時に勤務時間の長さを自動で計算しないかどうか",
- "example": false
- },
- "total_excess_statutory_work_mins": {
- "type": "integer",
- "description": "法定内残業時間（分）",
- "format": "int32"
- },
- "total_latenight_excess_statutory_work_mins": {
- "type": "integer",
- "description": "深夜の法定内残業時間（分）",
- "format": "int32"
+ "description": "勤労学生かどうか"
},
- "total_overtime_except_normal_work_mins": {
- "type": "integer",
- "description": "所定外法定外労働時間（分）",
- "format": "int32"
+ "widow_type": {
+ "type": "string",
+ "description": "寡夫／寡婦かどうか na: 空白, widower: 寡夫, widow: 寡婦, special_widow: 特別寡婦"
},
- "total_latenight_overtime_except_normal_work_min": {
- "type": "integer",
- "description": "深夜の所定外法定外労働時間（分）",
- "format": "int32"
+ "disability_type": {
+ "type": "string",
+ "description": "障害者かどうか na: 空白, general: 障害者, heavy: 特別障害者"
}
- }
+ },
+ "nullable": true
},
- "ApiV1EmployeesWelfarePensionInsuranceRuleUpdateRequestSerializer": {
+ "ApiV1EmployeesDependentRuleUpdateRequestSerializer": {
"type": "object",
"required": [
- "standard_monthly_remuneration"
+ "last_name",
+ "first_name",
+ "gender",
+ "relationship",
+ "birth_date",
+ "residence_type",
+ "income",
+ "annual_revenue",
+ "disability_type",
+ "social_insurance_and_tax_dependent"
],
"properties": {
- "entried": {
- "type": "boolean",
- "description": "厚生年金保険に加入しているかどうか null不可"
- },
- "reference_num": {
- "type": "string",
- "description": "厚生年金保険の被保険者整理番号",
- "maxLength": 255
- },
- "standard_monthly_remuneration": {
+ "id": {
"type": "integer",
- "description": "標準報酬月額 null不可",
+ "description": "扶養親族ID（idがない場合は新規作成になる)",
"format": "int32",
"minimum": 1,
"maximum": 2147483647
- }
- }
- },
- "ApiV1EmployeesBankAccountRuleUpdateRequestSerializer": {
- "type": "object",
- "properties": {
- "bank_name": {
- "type": "string",
- "description": "金融機関名",
- "maxLength": 255
},
- "bank_name_kana": {
+ "last_name": {
"type": "string",
- "description": "金融機関名カナ 英字カナのみ",
+ "description": "姓 null不可",
"maxLength": 255
},
- "bank_code": {
+ "first_name": {
"type": "string",
- "description": "金融機関コード 数値文字列4桁",
- "maxLength": 4
+ "description": "名 null不可",
+ "maxLength": 255
},
- "branch_name": {
+ "last_name_kana": {
"type": "string",
- "description": "支店名",
+ "description": "姓カナ",
"maxLength": 255
},
- "branch_name_kana": {
+ "first_name_kana": {
"type": "string",
- "description": "支店名カナ 英字カナのみ",
+ "description": "名カナ",
"maxLength": 255
},
- "branch_code": {
+ "gender": {
"type": "string",
- "description": "支店コード 数値文字列3桁",
- "maxLength": 3
+ "description": "性別 unselected: 未選択, male: 男性, female: 女性（デフォルト: unselected: 未選択）",
+ "enum": [
+ "unselected",
+ "male",
+ "female"
+ ],
+ "example": "male"
},
- "account_number": {
+ "relationship": {
"type": "string",
- "description": "口座番号 数値文字列7桁",
- "maxLength": 7
+ "description": "続柄 null不可 spouse: 配偶者, father: 父, mother: 母, child: 子, senior_brother: 兄, junior_brother: 弟, senior_sister: 姉, junior_sister: 妹, grandchild: 孫, grandfather: 祖父, grandmother: 祖母, father_in_law: 義父, mother_in_law: 義母, grandfather_in_law: 義祖父, grandmother_in_law: 義祖母, other: その他, great_grandfather: 曽祖父, great_grandmother: 曽祖母, spouses_child: 配偶者の連れ子",
+ "enum": [
+ "spouse",
+ "father",
+ "mother",
+ "child",
+ "senior_brother",
+ "junior_brother",
+ "senior_sister",
+ "junior_sister",
+ "grandchild",
+ "grandfather",
+ "grandmother",
+ "father_in_law",
+ "mother_in_law",
+ "grandfather_in_law",
+ "grandmother_in_law",
+ "other",
+ "great_grandfather",
+ "great_grandmother",
+ "spouses_child"
+ ]
},
- "account_name": {
+ "birth_date": {
"type": "string",
- "description": "口座名義カナ 英字カナのみ",
- "maxLength": 50
+ "description": "生年月日 null不可",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+ "maxLength": 10
},
- "account_type": {
+ "residence_type": {
"type": "string",
- "description": "預金種類 ordinary: 普通預金, current: 当座預金, saving: 貯蓄預金",
+ "description": "同居・別居 null不可 live_in: 同居, resident: 別居(国内), non_resident: 別居(国外)",
"enum": [
- "ordinary",
- "current",
- "saving"
+ "live_in",
+ "resident",
+ "non_resident"
]
- }
- }
- },
- "ApiV1EmployeesBasicPayRuleUpdateRequestSerializer": {
- "type": "object",
- "required": [
- "pay_calc_type",
- "pay_amount"
- ],
- "properties": {
- "pay_calc_type": {
- "type": "string",
- "description": "給与方式 null不可 monthly: 月給, daily: 日給, hourly: 時給",
- "enum": [
- "monthly",
- "daily",
- "hourly"
- ],
- "example": "monthly"
- },
- "pay_amount": {
- "type": "integer",
- "description": "基本給 null不可",
- "format": "int32",
- "minimum": 0,
- "maximum": 99999999,
- "example": 220000
- }
- }
- },
- "ApiV1EmployeesHealthInsuranceRuleSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "健康保険ルールID",
- "format": "int32"
- },
- "company_id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32"
- },
- "employee_id": {
- "type": "integer",
- "description": "従業員ID",
- "format": "int32"
- },
- "entried": {
- "type": "boolean",
- "description": "健康保険に加入しているかどうか"
- },
- "reference_num": {
- "type": "string",
- "description": "健康保険の被保険者整理番号",
- "nullable": true
- },
- "standard_monthly_remuneration": {
- "type": "integer",
- "description": "標準報酬月額",
- "format": "int32"
- }
- },
- "nullable": true
- },
- "ApiV1EmployeesBankAccountRuleSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "銀行口座ルールID",
- "format": "int32"
- },
- "company_id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32"
- },
- "employee_id": {
- "type": "integer",
- "description": "従業員ID",
- "format": "int32"
- },
- "bank_name": {
- "type": "string",
- "description": "金融機関名",
- "nullable": true
- },
- "bank_name_kana": {
- "type": "string",
- "description": "金融機関名カナ",
- "nullable": true
- },
- "bank_code": {
- "type": "string",
- "description": "金融機関コード",
- "nullable": true
- },
- "branch_name": {
- "type": "string",
- "description": "支店名",
- "nullable": true
- },
- "branch_name_kana": {
- "type": "string",
- "description": "支店名カナ",
- "nullable": true
- },
- "branch_code": {
- "type": "string",
- "description": "支店コード",
- "nullable": true
- },
- "account_number": {
- "type": "string",
- "description": "口座番号",
- "nullable": true
- },
- "account_name": {
- "type": "string",
- "description": "口座名義カナ",
- "nullable": true
- },
- "account_type": {
- "type": "string",
- "description": "預金種類 ordinary: 普通預金, current: 当座預金, saving: 貯蓄預金",
- "nullable": true
- }
- },
- "nullable": true
- },
- "ApiV1EmployeesDependentRuleSerializer": {
- "type": "object",
- "properties": {
- "id": {
- "type": "integer",
- "description": "扶養親族ルールID",
- "format": "int32"
- },
- "company_id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32"
- },
- "employee_id": {
- "type": "integer",
- "description": "従業員ID",
- "format": "int32"
- },
- "last_name": {
- "type": "string",
- "description": "姓"
- },
- "first_name": {
- "type": "string",
- "description": "名"
- },
- "last_name_kana": {
- "type": "string",
- "description": "姓カナ",
- "nullable": true
- },
- "first_name_kana": {
- "type": "string",
- "description": "名カナ",
- "nullable": true
- },
- "gender": {
- "type": "string",
- "description": "性別 unselected: 未選択, male: 男性, female: 女性",
- "enum": [
- "unselected",
- "male",
- "female"
- ]
- },
- "relationship": {
- "type": "string",
- "description": "続柄 spouse: 配偶者, father: 父, mother: 母, child: 子, senior_brother: 兄, junior_brother: 弟, senior_sister: 姉, junior_sister: 妹, grandchild: 孫, grandfather: 祖父, grandmother: 祖母, father_in_law: 義父, mother_in_law: 義母, grandfather_in_law: 義祖父, grandmother_in_law: 義祖母, other: その他, great_grandfather: 曽祖父, great_grandmother: 曽祖母, spouses_child: 配偶者の連れ子"
- },
- "birth_date": {
- "type": "string",
- "description": "生年月日",
- "format": "date"
- },
- "residence_type": {
- "type": "string",
- "description": "同居・別居 live_in: 同居, resident: 別居(国内), non_resident: 別居(国外)"
},
"zipcode1": {
"type": "string",
"description": "住民票住所の郵便番号1",
- "nullable": true
+ "maxLength": 3
},
"zipcode2": {
"type": "string",
"description": "住民票住所の郵便番号2",
- "nullable": true
+ "maxLength": 4
},
"prefecture_code": {
"type": "integer",
- "nullable": true,
"minimum": -1,
"maximum": 46,
"description": "住民票住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
@@ -6639,941 +6770,2251 @@
"address": {
"type": "string",
"description": "住民票住所の市区町村以降の住所",
- "nullable": true
+ "maxLength": 255
},
"address_kana": {
"type": "string",
"description": "住民票住所の市区町村以降の住所カナ",
- "nullable": true
+ "maxLength": 255
},
"base_pension_num": {
"type": "string",
"description": "基礎年金番号",
- "nullable": true
+ "maxLength": 10
},
"income": {
"type": "integer",
- "description": "年間所得",
- "format": "int32"
+ "description": "年間所得 null不可",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 999999999
},
"annual_revenue": {
"type": "integer",
- "description": "年間収入",
- "format": "int32"
+ "description": "年間収入 null不可",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 999999999
},
"disability_type": {
"type": "string",
- "description": "障害に該当するか na: 障害なし, general: 一般の障害者, heavy: 特別障害者"
+ "description": "障害に該当するか null不可 na: 障害なし, general: 一般の障害者, heavy: 特別障害者",
+ "enum": [
+ "na",
+ "general",
+ "heavy"
+ ]
},
"occupation": {
"type": "string",
"description": "職業",
- "nullable": true
+ "maxLength": 255
},
"annual_remittance_amount": {
"type": "integer",
"description": "一年間の送金額",
- "format": "int32"
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 999999999
+ },
+ "destroy": {
+ "type": "boolean",
+ "description": "扶養親族を削除するか"
},
"social_insurance_and_tax_dependent": {
"type": "string",
- "description": "扶養状況 social_insurance_and_tax: 所得税・住民税と社会保険, tax_only: 所得税・住民税のみ, social_insurance_only: 社会保険のみ"
+ "description": "扶養状況 social_insurance_and_tax: 所得税・住民税と社会保険, tax_only: 所得税・住民税のみ, social_insurance_only: 社会保険のみ, not_dependent: 扶養していない",
+ "enum": [
+ "social_insurance_and_tax",
+ "tax_only",
+ "social_insurance_only",
+ "not_dependent"
+ ]
}
}
},
- "ApiV1EmployeesBasicPayRuleSerializer": {
+ "ApiV1EmployeesTimeClockSerializer": {
"type": "object",
"properties": {
"id": {
"type": "integer",
+ "description": "打刻ID",
"format": "int32",
"minimum": 1,
"maximum": 2147483647
},
- "company_id": {
- "type": "integer",
- "description": "事業所ID",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
- },
- "employee_id": {
- "type": "integer",
- "description": "従業員ID",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
+ "date": {
+ "type": "string",
+ "description": "打刻日",
+ "format": "date"
},
- "pay_calc_type": {
+ "type": {
"type": "string",
- "description": "給与方式 monthly: 月給, daily: 日給, hourly: 時給",
+ "description": "打刻種別",
"enum": [
- "monthly",
- "daily",
- "hourly"
+ "clock_in",
+ "break_begin",
+ "break_end",
+ "clock_out"
+ ]
+ },
+ "datetime": {
+ "type": "string",
+ "description": "打刻時刻",
+ "format": "date-time"
+ },
+ "original_datetime": {
+ "type": "string",
+ "description": "オリジナルの打刻時間",
+ "format": "date-time"
+ },
+ "note": {
+ "type": "string",
+ "description": "打刻メモ",
+ "maxLength": 255
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordSummarySerializer": {
+ "type": "object",
+ "properties": {
+ "year": {
+ "type": "integer",
+ "description": "給与支払い年",
+ "format": "int32"
+ },
+ "month": {
+ "type": "integer",
+ "description": "給与支払い月",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12
+ },
+ "start_date": {
+ "type": "string",
+ "description": "集計開始日",
+ "format": "date"
+ },
+ "end_date": {
+ "type": "string",
+ "description": "集計終了日",
+ "format": "date"
+ },
+ "work_days": {
+ "type": "number",
+ "description": "労働日数",
+ "format": "float"
+ },
+ "total_work_mins": {
+ "type": "integer",
+ "description": "総勤務時間（分）",
+ "format": "int32"
+ },
+ "total_normal_work_mins": {
+ "type": "integer",
+ "description": "所定内労働時間（分）",
+ "format": "int32"
+ },
+ "total_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "給与計算に用いられる法定内残業時間（分）",
+ "format": "int32"
+ },
+ "total_overtime_except_normal_work_mins": {
+ "type": "integer",
+ "description": "所定外法定外労働時間",
+ "format": "int32"
+ },
+ "total_overtime_within_normal_work_mins": {
+ "type": "integer",
+ "description": "所定内法定外労働時間（裁量労働制の場合はみなしベース）",
+ "format": "int32"
+ },
+ "total_holiday_work_mins": {
+ "type": "integer",
+ "description": "法定休日労働時間（分）",
+ "format": "int32"
+ },
+ "total_latenight_work_mins": {
+ "type": "integer",
+ "description": "深夜労働allow(company)時間（分）",
+ "format": "int32"
+ },
+ "num_absences": {
+ "type": "number",
+ "description": "欠勤日数",
+ "format": "float"
+ },
+ "num_paid_holidays": {
+ "type": "number",
+ "description": "有給取得日数",
+ "format": "float"
+ },
+ "num_paid_holidays_and_hours": {
+ "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
+ },
+ "num_paid_holidays_left": {
+ "type": "number",
+ "description": "有給残日数",
+ "format": "float"
+ },
+ "num_paid_holidays_and_hours_left": {
+ "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
+ },
+ "num_substitute_holidays_used": {
+ "type": "number",
+ "description": "振替休日の使用日数",
+ "format": "float"
+ },
+ "num_compensatory_holidays_used": {
+ "type": "number",
+ "description": "代休の使用日数",
+ "format": "float"
+ },
+ "num_special_holidays_used": {
+ "type": "number",
+ "description": "特別休暇の使用日数",
+ "format": "float"
+ },
+ "num_special_holidays_and_hours_used": {
+ "$ref": "#/components/schemas/ApiV1HolidaysAndHoursSerializer"
+ },
+ "total_lateness_and_early_leaving_mins": {
+ "type": "integer",
+ "description": "遅刻早退時間（分）",
+ "format": "int32"
+ },
+ "multi_hourly_wages": {
+ "type": "array",
+ "description": "複数時給の労働時間の内訳（複数時給を設定している従業員のみ）",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesEmployeeMultiHourlyWageWorkRecordSummarySerializer"
+ }
+ },
+ "work_records": {
+ "type": "array",
+ "description": "日々の勤怠情報",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordSerializer"
+ }
+ },
+ "total_shortage_work_mins": {
+ "type": "integer",
+ "description": "不足時間（分）",
+ "format": "int32",
+ "nullable": true
+ },
+ "total_deemed_paid_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "支給対象の法定内残業時間（分）",
+ "format": "int32",
+ "nullable": true
+ },
+ "total_deemed_paid_overtime_except_normal_work_mins": {
+ "type": "integer",
+ "description": "支給対象の時間外労働時間（分）",
+ "format": "int32",
+ "nullable": true
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordSerializer": {
+ "type": "object",
+ "properties": {
+ "break_records": {
+ "type": "array",
+ "description": "休憩時間のリスト",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordTimeRangeResponseSerializer"
+ }
+ },
+ "clock_in_at": {
+ "type": "string",
+ "description": "出勤時間",
+ "format": "date-time",
+ "nullable": true
+ },
+ "clock_out_at": {
+ "type": "string",
+ "description": "退勤時間",
+ "format": "date-time",
+ "nullable": true
+ },
+ "date": {
+ "type": "string",
+ "description": "対象日付",
+ "format": "date-time"
+ },
+ "day_pattern": {
+ "type": "string",
+ "description": "勤務パターン\n- normal_day: 所定労働日\n- prescribed_holiday: 所定休日\n- legal_holiday: 法定休日",
+ "enum": [
+ "normal_day",
+ "prescribed_holiday",
+ "legal_holiday"
+ ]
+ },
+ "schedule_pattern": {
+ "type": "string",
+ "description": "スケジュールパターン\n- substitute_holiday_work: 振替出勤\n- substitute_holiday: 振替休日\n- compensatory_holiday_work: 代休出勤\n- compensatory_holiday: 代休\n- special_holiday: 特別休暇",
+ "enum": [
+ "",
+ "substitute_holiday_work",
+ "substitute_holiday",
+ "compensatory_holiday_work",
+ "compensatory_holiday",
+ "special_holiday"
]
},
- "pay_amount": {
+ "early_leaving_mins": {
+ "type": "integer",
+ "description": "早退分の時間（分単位）",
+ "format": "int32"
+ },
+ "hourly_paid_holiday_mins": {
+ "type": "integer",
+ "description": "時間休を利用した時間（分単位）",
+ "format": "int32"
+ },
+ "is_absence": {
+ "type": "boolean",
+ "description": "欠勤かどうか",
+ "example": false
+ },
+ "is_editable": {
+ "type": "boolean",
+ "description": "勤怠データが編集可能かどうか"
+ },
+ "lateness_mins": {
+ "type": "integer",
+ "description": "遅刻分の時間（分単位）",
+ "format": "int32"
+ },
+ "normal_work_clock_in_at": {
+ "type": "string",
+ "description": "所定労働開始時刻",
+ "format": "date-time",
+ "nullable": true
+ },
+ "normal_work_clock_out_at": {
+ "type": "string",
+ "description": "所定労働終了時刻",
+ "format": "date-time",
+ "nullable": true
+ },
+ "normal_work_mins": {
+ "type": "integer",
+ "description": "所定労働時間",
+ "format": "int32"
+ },
+ "normal_work_mins_by_paid_holiday": {
+ "type": "integer",
+ "description": "有給によって計上される所定労働時間（分）",
+ "format": "int32"
+ },
+ "note": {
+ "type": "string",
+ "description": "勤怠メモ",
+ "maxLength": 255
+ },
+ "paid_holiday": {
+ "type": "number",
+ "description": "この日に対する有給取得日数。半休の場合は0.5が入ります。時間休の場合はhourly_paid_holiday_minsを所定労働時間で割った値が入るため、実際の時間を確認するにはhourly_paid_holiday_minsを参照してください。",
+ "format": "float"
+ },
+ "use_attendance_deduction": {
+ "type": "boolean",
+ "description": "欠勤・遅刻・早退を控除対象時間に算入するかどうか"
+ },
+ "use_default_work_pattern": {
+ "type": "boolean",
+ "description": "デフォルトの勤務時間設定を使っているかどうか"
+ },
+ "total_overtime_work_mins": {
+ "type": "integer",
+ "description": "時間外労働時間（分）（Webの勤怠登録画面にて詳細項目の「勤務時間の長さを自動で計算しない」にチェックを入れた場合0が返却されます。時間外労働時間はtotal_overtime_except_normal_work_minsを参照してください。）",
+ "format": "int32"
+ },
+ "total_holiday_work_mins": {
+ "type": "integer",
+ "description": "休日労働時間（分）",
+ "format": "int32"
+ },
+ "total_latenight_work_mins": {
+ "type": "integer",
+ "description": "深夜労働時間（分）",
+ "format": "int32"
+ },
+ "not_auto_calc_work_time": {
+ "type": "boolean",
+ "description": "勤怠登録時に勤務時間の長さを自動で計算しないかどうか",
+ "example": false
+ },
+ "total_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "法定内残業時間（分）",
+ "format": "int32"
+ },
+ "total_latenight_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "深夜の法定内残業時間（分）",
+ "format": "int32"
+ },
+ "total_overtime_except_normal_work_mins": {
+ "type": "integer",
+ "description": "所定外法定外労働時間（分）",
+ "format": "int32"
+ },
+ "total_latenight_overtime_except_normal_work_min": {
+ "type": "integer",
+ "description": "深夜の所定外法定外労働時間（分）",
+ "format": "int32"
+ }
+ }
+ },
+ "ApiV1EmployeesWelfarePensionInsuranceRuleUpdateRequestSerializer": {
+ "type": "object",
+ "required": [
+ "standard_monthly_remuneration"
+ ],
+ "properties": {
+ "entried": {
+ "type": "boolean",
+ "description": "厚生年金保険に加入しているかどうか null不可"
+ },
+ "reference_num": {
+ "type": "string",
+ "description": "厚生年金保険の被保険者整理番号",
+ "maxLength": 255
+ },
+ "standard_monthly_remuneration": {
+ "type": "integer",
+ "description": "標準報酬月額 null不可",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ }
+ }
+ },
+ "ApiV1EmployeesBankAccountRuleUpdateRequestSerializer": {
+ "type": "object",
+ "properties": {
+ "bank_name": {
+ "type": "string",
+ "description": "金融機関名",
+ "maxLength": 255
+ },
+ "bank_name_kana": {
+ "type": "string",
+ "description": "金融機関名カナ 英字カナのみ",
+ "maxLength": 255
+ },
+ "bank_code": {
+ "type": "string",
+ "description": "金融機関コード 数値文字列4桁",
+ "maxLength": 4
+ },
+ "branch_name": {
+ "type": "string",
+ "description": "支店名",
+ "maxLength": 255
+ },
+ "branch_name_kana": {
+ "type": "string",
+ "description": "支店名カナ 英字カナのみ",
+ "maxLength": 255
+ },
+ "branch_code": {
+ "type": "string",
+ "description": "支店コード 数値文字列3桁",
+ "maxLength": 3
+ },
+ "account_number": {
+ "type": "string",
+ "description": "口座番号 数値文字列7桁",
+ "maxLength": 7
+ },
+ "account_name": {
+ "type": "string",
+ "description": "口座名義カナ 英字カナのみ",
+ "maxLength": 50
+ },
+ "account_type": {
+ "type": "string",
+ "description": "預金種類 ordinary: 普通預金, current: 当座預金, saving: 貯蓄預金",
+ "enum": [
+ "ordinary",
+ "current",
+ "saving"
+ ]
+ }
+ }
+ },
+ "ApiV1EmployeesBasicPayRuleUpdateRequestSerializer": {
+ "type": "object",
+ "required": [
+ "pay_calc_type",
+ "pay_amount"
+ ],
+ "properties": {
+ "pay_calc_type": {
+ "type": "string",
+ "description": "給与方式 null不可 monthly: 月給, daily: 日給, hourly: 時給",
+ "enum": [
+ "monthly",
+ "daily",
+ "hourly"
+ ],
+ "example": "monthly"
+ },
+ "pay_amount": {
+ "type": "integer",
+ "description": "基本給 null不可",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 99999999,
+ "example": 220000
+ }
+ }
+ },
+ "ApiV1EmployeesHealthInsuranceRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "健康保険ルールID",
+ "format": "int32"
+ },
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32"
+ },
+ "employee_id": {
+ "type": "integer",
+ "description": "従業員ID",
+ "format": "int32"
+ },
+ "entried": {
+ "type": "boolean",
+ "description": "健康保険に加入しているかどうか"
+ },
+ "reference_num": {
+ "type": "string",
+ "description": "健康保険の被保険者整理番号",
+ "nullable": true
+ },
+ "standard_monthly_remuneration": {
+ "type": "integer",
+ "description": "標準報酬月額",
+ "format": "int32"
+ }
+ },
+ "nullable": true
+ },
+ "ApiV1EmployeesBankAccountRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "銀行口座ルールID",
+ "format": "int32"
+ },
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32"
+ },
+ "employee_id": {
+ "type": "integer",
+ "description": "従業員ID",
+ "format": "int32"
+ },
+ "bank_name": {
+ "type": "string",
+ "description": "金融機関名",
+ "nullable": true
+ },
+ "bank_name_kana": {
+ "type": "string",
+ "description": "金融機関名カナ",
+ "nullable": true
+ },
+ "bank_code": {
+ "type": "string",
+ "description": "金融機関コード",
+ "nullable": true
+ },
+ "branch_name": {
+ "type": "string",
+ "description": "支店名",
+ "nullable": true
+ },
+ "branch_name_kana": {
+ "type": "string",
+ "description": "支店名カナ",
+ "nullable": true
+ },
+ "branch_code": {
+ "type": "string",
+ "description": "支店コード",
+ "nullable": true
+ },
+ "account_number": {
+ "type": "string",
+ "description": "口座番号",
+ "nullable": true
+ },
+ "account_name": {
+ "type": "string",
+ "description": "口座名義カナ",
+ "nullable": true
+ },
+ "account_type": {
+ "type": "string",
+ "description": "預金種類 ordinary: 普通預金, current: 当座預金, saving: 貯蓄預金",
+ "nullable": true
+ }
+ },
+ "nullable": true
+ },
+ "ApiV1EmployeesDependentRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "description": "扶養親族ルールID",
+ "format": "int32"
+ },
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32"
+ },
+ "employee_id": {
+ "type": "integer",
+ "description": "従業員ID",
+ "format": "int32"
+ },
+ "last_name": {
+ "type": "string",
+ "description": "姓"
+ },
+ "first_name": {
+ "type": "string",
+ "description": "名"
+ },
+ "last_name_kana": {
+ "type": "string",
+ "description": "姓カナ",
+ "nullable": true
+ },
+ "first_name_kana": {
+ "type": "string",
+ "description": "名カナ",
+ "nullable": true
+ },
+ "gender": {
+ "type": "string",
+ "description": "性別 unselected: 未選択, male: 男性, female: 女性",
+ "enum": [
+ "unselected",
+ "male",
+ "female"
+ ]
+ },
+ "relationship": {
+ "type": "string",
+ "description": "続柄 spouse: 配偶者, father: 父, mother: 母, child: 子, senior_brother: 兄, junior_brother: 弟, senior_sister: 姉, junior_sister: 妹, grandchild: 孫, grandfather: 祖父, grandmother: 祖母, father_in_law: 義父, mother_in_law: 義母, grandfather_in_law: 義祖父, grandmother_in_law: 義祖母, other: その他, great_grandfather: 曽祖父, great_grandmother: 曽祖母, spouses_child: 配偶者の連れ子"
+ },
+ "birth_date": {
+ "type": "string",
+ "description": "生年月日",
+ "format": "date"
+ },
+ "residence_type": {
+ "type": "string",
+ "description": "同居・別居 live_in: 同居, resident: 別居(国内), non_resident: 別居(国外)"
+ },
+ "zipcode1": {
+ "type": "string",
+ "description": "住民票住所の郵便番号1",
+ "nullable": true
+ },
+ "zipcode2": {
+ "type": "string",
+ "description": "住民票住所の郵便番号2",
+ "nullable": true
+ },
+ "prefecture_code": {
+ "type": "integer",
+ "nullable": true,
+ "minimum": -1,
+ "maximum": 46,
+ "description": "住民票住所の都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄)",
+ "example": 4
+ },
+ "address": {
+ "type": "string",
+ "description": "住民票住所の市区町村以降の住所",
+ "nullable": true
+ },
+ "address_kana": {
+ "type": "string",
+ "description": "住民票住所の市区町村以降の住所カナ",
+ "nullable": true
+ },
+ "base_pension_num": {
+ "type": "string",
+ "description": "基礎年金番号",
+ "nullable": true
+ },
+ "income": {
+ "type": "integer",
+ "description": "年間所得",
+ "format": "int32"
+ },
+ "annual_revenue": {
+ "type": "integer",
+ "description": "年間収入",
+ "format": "int32"
+ },
+ "disability_type": {
+ "type": "string",
+ "description": "障害に該当するか na: 障害なし, general: 一般の障害者, heavy: 特別障害者"
+ },
+ "occupation": {
+ "type": "string",
+ "description": "職業",
+ "nullable": true
+ },
+ "annual_remittance_amount": {
+ "type": "integer",
+ "description": "一年間の送金額",
+ "format": "int32"
+ },
+ "social_insurance_and_tax_dependent": {
+ "type": "string",
+ "description": "扶養状況 social_insurance_and_tax: 所得税・住民税と社会保険, tax_only: 所得税・住民税のみ, social_insurance_only: 社会保険のみ"
+ }
+ }
+ },
+ "ApiV1EmployeesBasicPayRuleSerializer": {
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "employee_id": {
+ "type": "integer",
+ "description": "従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "pay_calc_type": {
+ "type": "string",
+ "description": "給与方式 monthly: 月給, daily: 日給, hourly: 時給",
+ "enum": [
+ "monthly",
+ "daily",
+ "hourly"
+ ]
+ },
+ "pay_amount": {
+ "type": "integer",
+ "description": "基本給",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 99999999
+ }
+ },
+ "nullable": true
+ },
+ "ApiV1EmployeesController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee": {
+ "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesController.create_response": {
+ "type": "object",
+ "properties": {
+ "employee": {
+ "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesController.create_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "employee"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "作成対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "employee": {
+ "$ref": "#/components/schemas/ApiV1EmployeeCreateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesController.update_response": {
+ "type": "object",
+ "properties": {
+ "employee": {
+ "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "employee"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "year": {
+ "type": "integer",
+ "description": "更新対象年\n- 給与計算対象の従業員情報の場合は必須になります。",
+ "format": "int32",
+ "minimum": 2000,
+ "maximum": 2100,
+ "example": 2021
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月\n- 給与計算対象の従業員情報の場合は必須になります。",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12,
+ "example": 1
+ },
+ "employee": {
+ "$ref": "#/components/schemas/ApiV1EmployeeUpdateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesProfileRulesController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee_profile_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesProfileRulesController.update_response": {
+ "type": "object",
+ "properties": {
+ "employee_profile_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesProfileRulesController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "year",
+ "month",
+ "employee_profile_rule"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32"
+ },
+ "year": {
+ "type": "integer",
+ "minimum": 2000,
+ "maximum": 2100,
+ "description": "更新対象年（必須）",
+ "format": "int32"
+ },
+ "month": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 12,
+ "description": "更新対象月（必須）
\n締日支払日設定が翌月払いの従業員情報の場合は、\n指定したmonth + 1の値が更新されます。",
+ "format": "int32"
+ },
+ "employee_profile_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleUpdateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesHealthInsuranceRulesController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee_health_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesHealthInsuranceRulesController.update_response": {
+ "type": "object",
+ "properties": {
+ "employee_health_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesHealthInsuranceRulesController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "year",
+ "month",
+ "employee_health_insurance_rule"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "year": {
+ "type": "integer",
+ "description": "更新対象年（必須）",
+ "format": "int32",
+ "minimum": 2000,
+ "maximum": 2100,
+ "example": 2021
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12,
+ "example": 1
+ },
+ "employee_health_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleUpdateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesWelfarePensionInsuranceRulesController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee_welfare_pension_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesWelfarePensionInsuranceRulesController.update_response": {
+ "type": "object",
+ "properties": {
+ "employee_welfare_pension_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesWelfarePensionInsuranceRulesController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "year",
+ "month",
+ "employee_welfare_pension_insurance_rule"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "year": {
+ "type": "integer",
+ "description": "更新対象年（必須）",
+ "format": "int32",
+ "minimum": 2000,
+ "maximum": 2100
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12
+ },
+ "employee_welfare_pension_insurance_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleUpdateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesDependentRulesController.index_response": {
+ "type": "object",
+ "properties": {
+ "employee_dependent_rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
+ }
+ }
+ }
+ },
+ "ApiV1EmployeesDependentRulesController.bulk_update_response": {
+ "type": "object",
+ "properties": {
+ "employee_dependent_rules": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
+ }
+ }
+ }
+ },
+ "ApiV1EmployeesDependentRulesController.bulk_update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "year",
+ "month",
+ "employee_dependent_rules"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "year": {
+ "type": "integer",
+ "description": "更新対象年（必須）",
+ "format": "int32",
+ "minimum": 2000,
+ "maximum": 2100
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12
+ },
+ "employee_dependent_rules": {
+ "type": "array",
+ "description": "扶養親族ルール",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleUpdateRequestSerializer"
+ }
+ }
+ }
+ },
+ "ApiV1EmployeesBankAccountRulesController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee_bank_account_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesBankAccountRulesController.update_response": {
+ "type": "object",
+ "properties": {
+ "employee_bank_account_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesBankAccountRulesController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "year",
+ "month",
+ "employee_bank_account_rule"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "year": {
"type": "integer",
- "description": "基本給",
+ "description": "更新対象年（必須）",
"format": "int32",
- "minimum": 0,
- "maximum": 99999999
+ "minimum": 2000,
+ "maximum": 2100
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12
+ },
+ "employee_bank_account_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleUpdateRequestSerializer"
}
- },
- "nullable": true
+ }
},
- "ApiV1EmployeesController.show_response": {
+ "ApiV1EmployeesBasicPayRulesController.show_response": {
"type": "object",
"properties": {
- "employee": {
- "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
+ "employee_basic_pay_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
}
}
},
- "ApiV1EmployeesController.create_response": {
+ "ApiV1EmployeesBasicPayRulesController.update_response": {
"type": "object",
"properties": {
- "employee": {
- "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
+ "employee_basic_pay_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
}
}
},
- "ApiV1EmployeesController.create_body": {
+ "ApiV1EmployeesBasicPayRulesController.update_body": {
"type": "object",
"required": [
"company_id",
- "employee"
+ "year",
+ "month",
+ "employee_basic_pay_rule"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "更新対象事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "year": {
+ "type": "integer",
+ "description": "更新対象年（必須）",
+ "format": "int32",
+ "minimum": 2000,
+ "maximum": 2100,
+ "example": 2021
+ },
+ "month": {
+ "type": "integer",
+ "description": "更新対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12,
+ "example": 1
+ },
+ "employee_basic_pay_rule": {
+ "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleUpdateRequestSerializer"
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordsController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id"
+ ],
+ "properties": {
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "break_records": {
+ "type": "array",
+ "description": "休憩時間のリスト",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordTimeRangeSerializer"
+ }
+ },
+ "clock_in_at": {
+ "type": "string",
+ "description": "出勤時刻",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
+ },
+ "clock_out_at": {
+ "type": "string",
+ "description": "退勤時刻",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
+ },
+ "day_pattern": {
+ "type": "string",
+ "description": "勤務パターン（所定労働日: normal_day, 所定休日: prescribed_holiday, 法定休日: legal_holiday）",
+ "enum": [
+ "normal_day",
+ "prescribed_holiday",
+ "legal_holiday"
+ ]
+ },
+ "early_leaving_mins": {
+ "type": "integer",
+ "description": "早退分の時間（分単位）",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 1440
+ },
+ "is_absence": {
+ "type": "boolean",
+ "description": "欠勤かどうか"
+ },
+ "lateness_mins": {
+ "type": "integer",
+ "description": "遅刻分の時間（分単位）",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 1440
+ },
+ "normal_work_clock_in_at": {
+ "type": "string",
+ "description": "所定労働開始時刻。指定しない場合はデフォルト設定が使用されます。",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
+ },
+ "normal_work_clock_out_at": {
+ "type": "string",
+ "description": "所定労働終了時刻。指定しない場合はデフォルト設定が使用されます。",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
+ },
+ "normal_work_mins": {
+ "type": "integer",
+ "description": "所定労働時間。指定しない場合はデフォルト設定が使用されます。",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 1440
+ },
+ "normal_work_mins_by_paid_holiday": {
+ "type": "integer",
+ "description": "有給によって計上される所定労働時間（分）",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 1440
+ },
+ "note": {
+ "type": "string",
+ "description": "勤怠メモ",
+ "maxLength": 255
+ },
+ "paid_holiday": {
+ "type": "number",
+ "description": "この日の有休取得数。0.5日単位で指定します。",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 1
+ },
+ "use_attendance_deduction": {
+ "type": "boolean",
+ "description": "欠勤・遅刻・早退を控除対象時間に算入するかどうか"
+ },
+ "use_default_work_pattern": {
+ "type": "boolean",
+ "description": "デフォルトの勤務設定を使うかどうか。"
+ }
+ }
+ },
+ "ApiV1EmployeesWorkRecordSummaryController.update_body": {
+ "type": "object",
+ "required": [
+ "company_id"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "作成対象事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
+ "description": "事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647
+ },
+ "work_days": {
+ "type": "number",
+ "description": "総勤務日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "work_days_on_weekdays": {
+ "type": "number",
+ "description": "所定労働日の勤務日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "work_days_on_prescribed_holidays": {
+ "type": "number",
+ "description": "所定休日の勤務日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "work_days_on_legal_holidays": {
+ "type": "number",
+ "description": "法定休日の勤務日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "total_work_mins": {
+ "type": "integer",
+ "description": "労働時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_normal_work_mins": {
+ "type": "integer",
+ "description": "所定労働時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "給与計算に用いられる法定内残業時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_holiday_work_mins": {
+ "type": "integer",
+ "description": "法定休日労働時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_latenight_work_mins": {
+ "type": "integer",
+ "description": "深夜労働時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_actual_excess_statutory_work_mins": {
+ "type": "integer",
+ "description": "実労働時間ベースの法定内残業時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
+ },
+ "total_overtime_work_mins": {
+ "type": "integer",
+ "description": "時間外労働時間（分）",
+ "minimum": 0,
"maximum": 2147483647
},
- "employee": {
- "$ref": "#/components/schemas/ApiV1EmployeeCreateRequestSerializer"
- }
- }
- },
- "ApiV1EmployeesController.update_response": {
- "type": "object",
- "properties": {
- "employee": {
- "$ref": "#/components/schemas/ApiV1EmployeeSerializer"
- }
- }
- },
- "ApiV1EmployeesController.update_body": {
- "type": "object",
- "required": [
- "company_id",
- "employee"
- ],
- "properties": {
- "company_id": {
+ "num_absences": {
+ "type": "number",
+ "description": "欠勤日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "num_absences_for_deduction": {
+ "type": "number",
+ "description": "控除対象の欠勤日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 9999.999
+ },
+ "total_lateness_mins": {
"type": "integer",
- "description": "更新対象事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647,
- "example": 1
+ "description": "遅刻時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "year": {
+ "total_lateness_mins_for_deduction": {
"type": "integer",
- "description": "更新対象年\n- 給与計算対象の従業員情報の場合は必須になります。",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100,
- "example": 2021
+ "description": "控除対象の遅刻時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "month": {
+ "total_early_leaving_mins": {
"type": "integer",
- "description": "更新対象月\n- 給与計算対象の従業員情報の場合は必須になります。",
- "format": "int32",
- "minimum": 1,
- "maximum": 12,
- "example": 1
+ "description": "早退時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "employee": {
- "$ref": "#/components/schemas/ApiV1EmployeeUpdateRequestSerializer"
- }
- }
- },
- "ApiV1EmployeesProfileRulesController.show_response": {
- "type": "object",
- "properties": {
- "employee_profile_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
- }
- }
- },
- "ApiV1EmployeesProfileRulesController.update_response": {
- "type": "object",
- "properties": {
- "employee_profile_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleSerializer"
- }
- }
- },
- "ApiV1EmployeesProfileRulesController.update_body": {
- "type": "object",
- "required": [
- "company_id",
- "year",
- "month",
- "employee_profile_rule"
- ],
- "properties": {
- "company_id": {
+ "total_early_leaving_mins_for_deduction": {
"type": "integer",
- "minimum": 1,
- "maximum": 2147483647,
- "description": "更新対象事業所ID（必須）",
- "format": "int32"
+ "description": "控除対象の早退時間（分）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "year": {
+ "num_paid_holidays": {
+ "type": "number",
+ "description": "有給取得日数",
+ "format": "float",
+ "minimum": 0,
+ "maximum": 31
+ },
+ "total_shortage_work_mins": {
"type": "integer",
- "minimum": 2000,
- "maximum": 2100,
- "description": "更新対象年（必須）",
- "format": "int32"
+ "description": "不足時間（分）（フレックスタイム制でのみ使用）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "month": {
+ "total_deemed_paid_excess_statutory_work_mins": {
"type": "integer",
- "minimum": 1,
- "maximum": 12,
- "description": "更新対象月（必須）
\n締日支払日設定が翌月払いの従業員情報の場合は、\n指定したmonth + 1の値が更新されます。",
- "format": "int32"
+ "description": "支給対象の法定内残業時間（分）（裁量労働制でのみ使用）",
+ "minimum": 0,
+ "maximum": 2147483647
},
- "employee_profile_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesProfileRuleUpdateRequestSerializer"
+ "total_deemed_paid_overtime_except_normal_work_mins": {
+ "type": "integer",
+ "description": "支給対象の法定内残業時間（分）（裁量労働制でのみ使用）",
+ "minimum": 0,
+ "maximum": 2147483647
}
}
},
- "ApiV1EmployeesHealthInsuranceRulesController.show_response": {
- "type": "object",
- "properties": {
- "employee_health_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
- }
+ "ApiV1EmployeesTimeClocksController.index_response": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
}
},
- "ApiV1EmployeesHealthInsuranceRulesController.update_response": {
+ "ApiV1EmployeesTimeClocksController.show_response": {
"type": "object",
"properties": {
- "employee_health_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleSerializer"
+ "employee_time_clock": {
+ "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
}
}
},
- "ApiV1EmployeesHealthInsuranceRulesController.update_body": {
+ "ApiV1EmployeesTimeClocksController.available_types_response": {
"type": "object",
- "required": [
- "company_id",
- "year",
- "month",
- "employee_health_insurance_rule"
- ],
"properties": {
- "company_id": {
- "type": "integer",
- "description": "更新対象事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647,
- "example": 1
- },
- "year": {
- "type": "integer",
- "description": "更新対象年（必須）",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100,
- "example": 2021
- },
- "month": {
- "type": "integer",
- "description": "更新対象月（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 12,
- "example": 1
+ "available_types": {
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "clock_in",
+ "break_begin",
+ "break_end",
+ "clock_out"
+ ],
+ "example": "clock_in"
+ }
},
- "employee_health_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesHealthInsuranceRuleUpdateRequestSerializer"
- }
- }
- },
- "ApiV1EmployeesWelfarePensionInsuranceRulesController.show_response": {
- "type": "object",
- "properties": {
- "employee_welfare_pension_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ "base_date": {
+ "type": "string",
+ "description": "打刻基準日",
+ "format": "date",
+ "example": "2018-07-31"
}
}
},
- "ApiV1EmployeesWelfarePensionInsuranceRulesController.update_response": {
+ "ApiV1EmployeesTimeClocksController.create_response": {
"type": "object",
"properties": {
- "employee_welfare_pension_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleSerializer"
+ "employee_time_clock": {
+ "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
}
}
},
- "ApiV1EmployeesWelfarePensionInsuranceRulesController.update_body": {
+ "ApiV1EmployeesTimeClocksController.create_body": {
"type": "object",
"required": [
"company_id",
- "year",
- "month",
- "employee_welfare_pension_insurance_rule"
+ "type"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "更新対象事業所ID（必須）",
+ "description": "(required)",
"format": "int32",
"minimum": 1,
"maximum": 2147483647
},
- "year": {
- "type": "integer",
- "description": "更新対象年（必須）",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100
+ "type": {
+ "type": "string",
+ "description": "打刻種別（required）['clock_in','break_begin','break_end','clock_out']の何れか",
+ "enum": [
+ "clock_in",
+ "break_begin",
+ "break_end",
+ "clock_out"
+ ]
},
- "month": {
- "type": "integer",
- "description": "更新対象月（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 12
+ "base_date": {
+ "type": "string",
+ "description": "打刻日。打刻が日をまたぐ場合に、前日の日付を指定します。(YYYY-MM-DD)(例:2018-07-31)",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "employee_welfare_pension_insurance_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesWelfarePensionInsuranceRuleUpdateRequestSerializer"
+ "datetime": {
+ "type": "string",
+ "description": "打刻時刻。(YYYY-MM-DD HH:MM:SS)(例:2018-07-31 08:00:00)",
+ "format": "date-time",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": "2018-07-31 08:00:00"
}
}
},
- "ApiV1EmployeesDependentRulesController.index_response": {
+ "ApiV1SalariesEmployeePayrollStatementsController.index_response": {
"type": "object",
"properties": {
- "employee_dependent_rules": {
+ "employee_payroll_statements": {
"type": "array",
"items": {
- "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
+ "$ref": "#/components/schemas/ApiV1SalariesEmployeePayrollStatementSerializer"
}
}
}
},
- "ApiV1EmployeesDependentRulesController.bulk_update_response": {
+ "ApiV1SalariesEmployeePayrollStatementsController.show_response": {
"type": "object",
"properties": {
- "employee_dependent_rules": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleSerializer"
- }
+ "employee_payroll_statement": {
+ "$ref": "#/components/schemas/ApiV1SalariesEmployeePayrollStatementSerializer"
}
}
},
- "ApiV1EmployeesDependentRulesController.bulk_update_body": {
+ "ApiV1BonusesEmployeePayrollStatementsController.show_response": {
+ "type": "object",
+ "properties": {
+ "employee_payroll_statement": {
+ "$ref": "#/components/schemas/ApiV1BonusesEmployeePayrollStatementSerializer"
+ }
+ }
+ },
+ "ApiV1GroupCreateRequest": {
"type": "object",
"required": [
"company_id",
- "year",
- "month",
- "employee_dependent_rules"
+ "group"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "更新対象事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
- },
- "year": {
- "type": "integer",
- "description": "更新対象年（必須）",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100
- },
- "month": {
- "type": "integer",
- "description": "更新対象月（必須）",
+ "description": "作成対象事業所ID（必須）",
"format": "int32",
"minimum": 1,
- "maximum": 12
+ "maximum": 2147483647,
+ "example": 1
},
- "employee_dependent_rules": {
- "type": "array",
- "description": "扶養親族ルール",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesDependentRuleUpdateRequestSerializer"
- }
- }
- }
- },
- "ApiV1EmployeesBankAccountRulesController.show_response": {
- "type": "object",
- "properties": {
- "employee_bank_account_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
+ "group": {
+ "$ref": "#/components/schemas/ApiV1GroupCreateRequestParams"
}
}
},
- "ApiV1EmployeesBankAccountRulesController.update_response": {
+ "ApiV1GroupResponse": {
"type": "object",
+ "required": [
+ "group"
+ ],
"properties": {
- "employee_bank_account_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleSerializer"
+ "group": {
+ "$ref": "#/components/schemas/ApiV1GroupResponseParams"
}
}
},
- "ApiV1EmployeesBankAccountRulesController.update_body": {
+ "ApiV1GroupUpdateRequest": {
"type": "object",
"required": [
"company_id",
- "year",
- "month",
- "employee_bank_account_rule"
+ "group"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "更新対象事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
- },
- "year": {
- "type": "integer",
- "description": "更新対象年（必須）",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100
- },
- "month": {
- "type": "integer",
- "description": "更新対象月（必須）",
+ "description": "作成対象事業所ID（必須）",
"format": "int32",
"minimum": 1,
- "maximum": 12
+ "maximum": 2147483647,
+ "example": 1
},
- "employee_bank_account_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBankAccountRuleUpdateRequestSerializer"
- }
- }
- },
- "ApiV1EmployeesBasicPayRulesController.show_response": {
- "type": "object",
- "properties": {
- "employee_basic_pay_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
+ "group": {
+ "$ref": "#/components/schemas/ApiV1GroupUpdateRequestParams"
}
}
},
- "ApiV1EmployeesBasicPayRulesController.update_response": {
+ "ApiV1PositionResponse": {
"type": "object",
+ "required": [
+ "position"
+ ],
"properties": {
- "employee_basic_pay_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleSerializer"
+ "position": {
+ "$ref": "#/components/schemas/ApiV1PositionResponseParams"
}
}
},
- "ApiV1EmployeesBasicPayRulesController.update_body": {
+ "ApiV1PositionRequest": {
"type": "object",
"required": [
"company_id",
- "year",
- "month",
- "employee_basic_pay_rule"
+ "position"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "更新対象事業所ID（必須）",
+ "description": "作成対象事業所ID（必須）",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"example": 1
},
- "year": {
- "type": "integer",
- "description": "更新対象年（必須）",
- "format": "int32",
- "minimum": 2000,
- "maximum": 2100,
- "example": 2021
- },
- "month": {
- "type": "integer",
- "description": "更新対象月（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 12,
- "example": 1
- },
- "employee_basic_pay_rule": {
- "$ref": "#/components/schemas/ApiV1EmployeesBasicPayRuleUpdateRequestSerializer"
+ "position": {
+ "$ref": "#/components/schemas/ApiV1PositionRequestParams"
}
}
},
- "ApiV1EmployeesWorkRecordsController.update_body": {
+ "ApiV1MonthlyAttendanceIndexResponse": {
"type": "object",
"required": [
- "company_id"
+ "monthly_attendances",
+ "total_count"
],
"properties": {
- "company_id": {
- "type": "integer",
- "description": "事業所ID（必須）",
- "format": "int32",
- "minimum": 1,
- "maximum": 2147483647
- },
- "break_records": {
+ "monthly_attendances": {
"type": "array",
- "description": "休憩時間のリスト",
"items": {
- "$ref": "#/components/schemas/ApiV1EmployeesWorkRecordTimeRangeSerializer"
+ "$ref": "#/components/schemas/ApiV1MonthlyAttendanceIndexResponseParams"
}
},
- "clock_in_at": {
- "type": "string",
- "description": "出勤時刻",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
- },
- "clock_out_at": {
- "type": "string",
- "description": "退勤時刻",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
- },
- "day_pattern": {
- "type": "string",
- "description": "勤務パターン（所定労働日: normal_day, 所定休日: prescribed_holiday, 法定休日: legal_holiday）",
- "enum": [
- "normal_day",
- "prescribed_holiday",
- "legal_holiday"
- ]
- },
- "early_leaving_mins": {
- "type": "integer",
- "description": "早退分の時間（分単位）",
- "format": "int32",
- "minimum": 0,
- "maximum": 1440
- },
- "is_absence": {
- "type": "boolean",
- "description": "欠勤かどうか"
- },
- "lateness_mins": {
- "type": "integer",
- "description": "遅刻分の時間（分単位）",
- "format": "int32",
- "minimum": 0,
- "maximum": 1440
- },
- "normal_work_clock_in_at": {
- "type": "string",
- "description": "所定労働開始時刻。指定しない場合はデフォルト設定が使用されます。",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
- },
- "normal_work_clock_out_at": {
- "type": "string",
- "description": "所定労働終了時刻。指定しない場合はデフォルト設定が使用されます。",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
- },
- "normal_work_mins": {
- "type": "integer",
- "description": "所定労働時間。指定しない場合はデフォルト設定が使用されます。",
- "format": "int32",
- "minimum": 0,
- "maximum": 1440
- },
- "normal_work_mins_by_paid_holiday": {
+ "total_count": {
"type": "integer",
- "description": "有給によって計上される所定労働時間（分）",
"format": "int32",
"minimum": 0,
- "maximum": 1440
- },
- "note": {
- "type": "string",
- "description": "勤怠メモ",
- "maxLength": 255
- },
- "paid_holiday": {
- "type": "number",
- "description": "この日の有休取得数。0.5日単位で指定します。",
- "format": "float",
- "minimum": 0,
- "maximum": 1
- },
- "use_attendance_deduction": {
- "type": "boolean",
- "description": "欠勤・遅刻・早退を控除対象時間に算入するかどうか"
- },
- "use_default_work_pattern": {
- "type": "boolean",
- "description": "デフォルトの勤務設定を使うかどうか。"
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1EmployeesWorkRecordSummaryController.update_body": {
+ "ApiV1MonthlyAttendanceResponse": {
"type": "object",
"required": [
- "company_id"
+ "monthly_attendance"
+ ],
+ "properties": {
+ "monthly_attendance": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1MonthlyAttendanceResponseParams"
+ }
+ }
+ }
+ },
+ "ApiV1MonthlyAttendanceCreateRequest": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "target_year",
+ "target_month",
+ "approval_flow_route_id"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "事業所ID（必須）",
+ "description": "作成対象事業所ID（必須）",
"format": "int32",
"minimum": 1,
- "maximum": 2147483647
- },
- "work_days": {
- "type": "number",
- "description": "総勤務日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
- },
- "work_days_on_weekdays": {
- "type": "number",
- "description": "所定労働日の勤務日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
- },
- "work_days_on_prescribed_holidays": {
- "type": "number",
- "description": "所定休日の勤務日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
- },
- "work_days_on_legal_holidays": {
- "type": "number",
- "description": "法定休日の勤務日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
- },
- "total_work_mins": {
- "type": "integer",
- "description": "労働時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "total_normal_work_mins": {
- "type": "integer",
- "description": "所定労働時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "total_excess_statutory_work_mins": {
- "type": "integer",
- "description": "給与計算に用いられる法定内残業時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "total_holiday_work_mins": {
- "type": "integer",
- "description": "法定休日労働時間（分）",
- "minimum": 0,
- "maximum": 2147483647
+ "maximum": 2147483647,
+ "example": 1
},
- "total_latenight_work_mins": {
+ "target_year": {
"type": "integer",
- "description": "深夜労働時間（分）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "対象年（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "total_actual_excess_statutory_work_mins": {
+ "target_month": {
"type": "integer",
- "description": "実労働時間ベースの法定内残業時間（分）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "対象月（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 12,
+ "example": 1
},
- "total_overtime_work_mins": {
+ "approval_flow_route_id": {
"type": "integer",
- "description": "時間外労働時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "num_absences": {
- "type": "number",
- "description": "欠勤日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
- },
- "num_absences_for_deduction": {
- "type": "number",
- "description": "控除対象の欠勤日数",
- "format": "float",
- "minimum": 0,
- "maximum": 9999.999
+ "description": "申請経路ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "total_lateness_mins": {
+ "approver_id": {
"type": "integer",
- "description": "遅刻時間（分）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
},
- "total_lateness_mins_for_deduction": {
+ "group_id": {
"type": "integer",
- "description": "控除対象の遅刻時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "total_early_leaving_mins": {
+ "description": "部門ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
+ }
+ },
+ "ApiV1MonthlyAttendanceUpdateRequest": {
+ "type": "object",
+ "required": [
+ "company_id",
+ "approval_flow_route_id"
+ ],
+ "properties": {
+ "company_id": {
"type": "integer",
- "description": "早退時間（分）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
},
- "total_early_leaving_mins_for_deduction": {
+ "approval_flow_route_id": {
"type": "integer",
- "description": "控除対象の早退時間（分）",
- "minimum": 0,
- "maximum": 2147483647
- },
- "num_paid_holidays": {
- "type": "number",
- "description": "有給取得日数",
- "format": "float",
- "minimum": 0,
- "maximum": 31
+ "description": "申請経路ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
},
- "total_shortage_work_mins": {
+ "approver_id": {
"type": "integer",
- "description": "不足時間（分）（フレックスタイム制でのみ使用）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
},
- "total_deemed_paid_excess_statutory_work_mins": {
+ "group_id": {
"type": "integer",
- "description": "支給対象の法定内残業時間（分）（裁量労働制でのみ使用）",
- "minimum": 0,
- "maximum": 2147483647
+ "description": "部門ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ }
+ }
+ },
+ "ApiV1PaidHolidayIndexResponse": {
+ "type": "object",
+ "required": [
+ "paid_holidays",
+ "total_count"
+ ],
+ "properties": {
+ "paid_holidays": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1PaidHolidayIndexResponseParams"
+ }
},
- "total_deemed_paid_overtime_except_normal_work_mins": {
+ "total_count": {
"type": "integer",
- "description": "支給対象の法定内残業時間（分）（裁量労働制でのみ使用）",
+ "format": "int32",
"minimum": 0,
- "maximum": 2147483647
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1EmployeesTimeClocksController.index_response": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
+ "ApiV1PaidHolidayResponse": {
+ "type": "object",
+ "required": [
+ "paid_holiday"
+ ],
+ "properties": {
+ "paid_holiday": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1PaidHolidayResponseParams"
+ }
+ }
}
},
- "ApiV1EmployeesTimeClocksController.show_response": {
+ "ApiV1PaidHolidayRequest": {
"type": "object",
+ "required": [
+ "company_id",
+ "target_date",
+ "holiday_type",
+ "approval_flow_route_id"
+ ],
"properties": {
- "employee_time_clock": {
- "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
+ "company_id": {
+ "type": "integer",
+ "description": "事業所ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "target_date": {
+ "type": "string",
+ "description": "対象日（必須）",
+ "format": "date",
+ "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$",
+ "nullable": true
+ },
+ "holiday_type": {
+ "type": "string",
+ "description": "取得単位（必須）（full:全休、half:半休、hour:時間休）",
+ "enum": [
+ "full",
+ "half",
+ "hour"
+ ],
+ "example": "half"
+ },
+ "start_at": {
+ "type": "string",
+ "description": "取得予定開始時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": 43200
+ },
+ "end_at": {
+ "type": "string",
+ "description": "取得予定終了時間",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": 86340
+ },
+ "comment": {
+ "type": "string",
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
+ },
+ "approval_flow_route_id": {
+ "type": "integer",
+ "description": "申請経路ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "approver_id": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "group_id": {
+ "type": "integer",
+ "description": "部門ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
}
}
},
- "ApiV1EmployeesTimeClocksController.available_types_response": {
+ "ApiV1OvertimeWorkIndexResponse": {
"type": "object",
+ "required": [
+ "overtime_works",
+ "total_count"
+ ],
"properties": {
- "available_types": {
+ "overtime_works": {
"type": "array",
"items": {
- "type": "string",
- "enum": [
- "clock_in",
- "break_begin",
- "break_end",
- "clock_out"
- ],
- "example": "clock_in"
+ "$ref": "#/components/schemas/ApiV1OvertimeWorkIndexResponseParams"
}
},
- "base_date": {
- "type": "string",
- "description": "打刻基準日",
- "format": "date",
- "example": "2018-07-31"
+ "total_count": {
+ "type": "integer",
+ "format": "int32",
+ "minimum": 0,
+ "maximum": 2147483647,
+ "example": 1
}
}
},
- "ApiV1EmployeesTimeClocksController.create_response": {
+ "ApiV1OvertimeWorkResponse": {
"type": "object",
+ "required": [
+ "overtime_work"
+ ],
"properties": {
- "employee_time_clock": {
- "$ref": "#/components/schemas/ApiV1EmployeesTimeClockSerializer"
+ "overtime_works": {
+ "type": "array",
+ "items": {
+ "$ref": "#/components/schemas/ApiV1OvertimeWorkResponseParams"
+ }
}
}
},
- "ApiV1EmployeesTimeClocksController.create_body": {
+ "ApiV1OvertimeWorkRequest": {
"type": "object",
"required": [
"company_id",
- "type"
+ "target_date",
+ "start_at",
+ "end_at",
+ "approval_flow_route_id"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "(required)",
+ "description": "作成対象事業所ID（必須）",
"format": "int32",
"minimum": 1,
- "maximum": 2147483647
- },
- "type": {
- "type": "string",
- "description": "打刻種別（required）['clock_in','break_begin','break_end','clock_out']の何れか",
- "enum": [
- "clock_in",
- "break_begin",
- "break_end",
- "clock_out"
- ]
+ "maximum": 2147483647,
+ "example": 1
},
- "base_date": {
+ "target_date": {
"type": "string",
- "description": "打刻日。打刻が日をまたぐ場合に、前日の日付を指定します。(YYYY-MM-DD)(例:2018-07-31)",
+ "description": "対象日（必須）",
"format": "date",
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
},
- "datetime": {
+ "start_at": {
"type": "string",
- "description": "打刻時刻。(YYYY-MM-DD HH:MM:SS)(例:2018-07-31 08:00:00)",
- "format": "date-time",
- "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
- "example": "2018-07-31 08:00:00"
- }
- }
- },
- "ApiV1SalariesEmployeePayrollStatementsController.index_response": {
- "type": "object",
- "properties": {
- "employee_payroll_statements": {
- "type": "array",
- "items": {
- "$ref": "#/components/schemas/ApiV1SalariesEmployeePayrollStatementSerializer"
- }
- }
- }
- },
- "ApiV1SalariesEmployeePayrollStatementsController.show_response": {
- "type": "object",
- "properties": {
- "employee_payroll_statement": {
- "$ref": "#/components/schemas/ApiV1SalariesEmployeePayrollStatementSerializer"
- }
- }
- },
- "ApiV1BonusesEmployeePayrollStatementsController.show_response": {
- "type": "object",
- "properties": {
- "employee_payroll_statement": {
- "$ref": "#/components/schemas/ApiV1BonusesEmployeePayrollStatementSerializer"
+ "description": "取得予定開始時間（必須）",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": 43200
+ },
+ "end_at": {
+ "type": "string",
+ "description": "取得予定終了時間（必須）",
+ "pattern": "^[0-9]{2}:[0-9]{2}(:[0-9]{2})?$",
+ "example": 86340
+ },
+ "comment": {
+ "type": "string",
+ "description": "申請理由",
+ "nullable": true,
+ "example": "申請理由"
+ },
+ "approval_flow_route_id": {
+ "type": "integer",
+ "description": "申請経路ID（必須）",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "example": 1
+ },
+ "approver_id": {
+ "type": "integer",
+ "description": "承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "group_id": {
+ "type": "integer",
+ "description": "部門ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
}
}
},
- "ApiV1GroupCreateRequest": {
+ "ApiV1ApprovalActionRequest": {
"type": "object",
"required": [
"company_id",
- "group"
+ "action",
+ "target_round",
+ "target_step_id"
],
"properties": {
"company_id": {
"type": "integer",
- "description": "作成対象事業所ID（必須）",
+ "description": "事業所ID",
"format": "int32",
"minimum": 1,
"maximum": 2147483647,
"example": 1
},
- "group": {
- "$ref": "#/components/schemas/ApiV1GroupCreateRequestParams"
+ "action": {
+ "type": "string",
+ "description": "申請操作。（approve:承認、cancel:取り消し、feedback:差戻し、force_feedback:承認取り消し）",
+ "enum": [
+ "approve",
+ "cancel",
+ "feedback",
+ "force_feedback"
+ ],
+ "example": "approve"
+ },
+ "target_round": {
+ "type": "integer",
+ "description": "対象round。操作がcancelのとき必須です。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。取得APIレスポンス.current_roundを送信してください。",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "target_step_id": {
+ "type": "integer",
+ "description": "対象承認ステップID 操作がcancelのとき必須です。取得APIレスポンス.current_step_idを送信してください。",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "next_approver_id": {
+ "type": "integer",
+ "description": "次のステップの承認者の従業員ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
+ },
+ "next_group_id": {
+ "type": "integer",
+ "description": "次のステップの部門ID",
+ "format": "int32",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "nullable": true,
+ "example": 1
}
}
},
- "ApiV1GroupResponse": {
+ "ApiV1ApprovalFlowRoutesIndexResponse": {
"type": "object",
"required": [
- "group"
+ "approval_flow_routes"
],
"properties": {
- "group": {
- "$ref": "#/components/schemas/ApiV1GroupResponseParams"
+ "approval_flow_routes": {
+ "$ref": "#/components/schemas/ApiV1ApprovalFlowRouteIndexResponseParams"
}
}
},
- "ApiV1GroupUpdateRequest": {
+ "ApiV1ApprovalFlowRouteIndexResponseParams": {
"type": "object",
"required": [
- "company_id",
- "group"
+ "id"
],
"properties": {
- "company_id": {
+ "id": {
"type": "integer",
- "description": "作成対象事業所ID（必須）",
- "format": "int32",
"minimum": 1,
"maximum": 2147483647,
+ "description": "申請経路ID",
"example": 1
},
- "group": {
- "$ref": "#/components/schemas/ApiV1GroupUpdateRequestParams"
+ "name": {
+ "type": "string",
+ "description": "申請経路名",
+ "example": "申請経路"
+ },
+ "description": {
+ "type": "string",
+ "description": "申請経路の説明",
+ "example": "申請経路の説明"
+ },
+ "user_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "更新したユーザーのユーザーID",
+ "example": 1,
+ "nullable": true
+ },
+ "definition_system": {
+ "type": "boolean",
+ "description": "システム作成の申請経路かどうか",
+ "example": true
+ },
+ "first_step_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "最初の承認ステップのID",
+ "example": 1
+ },
+ "usages": {
+ "type": "array",
+ "description": "申請種別（申請経路を使用できる申請種別を示します。例えば、AttendanceWorkflow の場合は、勤怠申請で使用できる申請経路です。）\n- AttendanceWorkflow - 勤怠申請\n- PersonalDataWorkflow - 身上変更申請",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AttendanceWorkflow",
+ "PersonalDataWorkflow"
+ ],
+ "example": "AttendanceWorkflow"
+ }
}
}
},
- "ApiV1PositionResponse": {
+ "ApiV1ApprovalFlowRouteResponse": {
"type": "object",
"required": [
- "position"
+ "approval_flow_route"
],
"properties": {
- "position": {
- "$ref": "#/components/schemas/ApiV1PositionResponseParams"
+ "approval_flow_route": {
+ "$ref": "#/components/schemas/ApiV1ApprovalFlowRouteResponseParams"
}
}
},
- "ApiV1PositionRequest": {
+ "ApiV1ApprovalFlowRouteResponseParams": {
"type": "object",
"required": [
- "company_id",
- "position"
+ "id"
],
"properties": {
- "company_id": {
+ "id": {
"type": "integer",
- "description": "作成対象事業所ID（必須）",
- "format": "int32",
"minimum": 1,
"maximum": 2147483647,
+ "description": "申請経路ID",
"example": 1
},
- "position": {
- "$ref": "#/components/schemas/ApiV1PositionRequestParams"
+ "name": {
+ "type": "string",
+ "description": "申請経路名",
+ "example": "申請経路"
+ },
+ "description": {
+ "type": "string",
+ "description": "申請経路の説明",
+ "example": "申請経路の説明"
+ },
+ "user_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "更新したユーザーのユーザーID",
+ "example": 1,
+ "nullable": true
+ },
+ "definition_system": {
+ "type": "boolean",
+ "description": "システム作成の申請経路かどうか",
+ "example": true
+ },
+ "first_step_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "最初の承認ステップのID",
+ "example": 1
+ },
+ "usages": {
+ "type": "array",
+ "description": "申請種別（申請経路を使用できる申請種別を示します。例えば、AttendanceWorkflow の場合は、勤怠申請で使用できる申請経路です。）\n- AttendanceWorkflow - 勤怠申請\n- PersonalDataWorkflow - 身上変更申請",
+ "items": {
+ "type": "string",
+ "enum": [
+ "AttendanceWorkflow",
+ "PersonalDataWorkflow"
+ ],
+ "example": "AttendanceWorkflow"
+ }
+ },
+ "steps": {
+ "$ref": "#/components/schemas/ApiV1FlowRouteStepSrializer"
+ }
+ }
+ },
+ "ApiV1FlowRouteStepSrializer": {
+ "type": "array",
+ "description": "承認ステップ（配列）",
+ "items": {
+ "type": "object",
+ "required": [
+ "id",
+ "next_step_id",
+ "resource_type"
+ ],
+ "properties": {
+ "id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "承認ステップID",
+ "example": 1
+ },
+ "next_step_id": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "次の承認ステップID",
+ "nullable": true,
+ "example": 2
+ },
+ "resource_type": {
+ "type": "string",
+ "description": "承認方法( predefined_user: メンバー指定 (1人), selected_user: 申請時にメンバー指定,unspecified: 指定なし, and_resource: メンバー指定 (複数、全員の承認), or_resource: メンバー指定 (複数、1人の承認), and_position: 役職指定 (複数、全員の承認), or_position: 役職指定 (複数、1人の承認) ) ",
+ "enum": [
+ "predefined_user",
+ "selected_user",
+ "unspecified",
+ "and_resource",
+ "or_resource",
+ "and_position",
+ "or_position"
+ ],
+ "example": "predefined_user"
+ },
+ "user_ids": {
+ "type": "array",
+ "description": "承認者のユーザーID (配列)",
+ "items": {
+ "type": "integer",
+ "minimum": 1,
+ "maximum": 2147483647,
+ "description": "承認者のユーザーID",
+ "example": 3
+ }
+ }
}
}
},