{ "info": { "title": "SmartHR API", "description": "SmartHR の各種データを操作する API です", "license": { "name": "SmartHR, Inc" }, "version": "0.0.1" }, "swagger": "2.0", "produces": [ "application/json;charset=utf-8" ], "host": "app.smarthr.jp", "basePath": "/api", "schemes": [ "https" ], "tags": [ { "name": "従業員", "description": "従業員を操作します" }, { "name": "カスタム従業員項目", "description": "カスタム従業員項目を操作します" }, { "name": "家族情報", "description": "家族情報を操作します" }, { "name": "産休育休情報", "description": "産休育休情報を操作します" }, { "name": "カスタム従業員項目グループ", "description": "カスタム従業員項目グループを操作します" }, { "name": "カスタム従業員項目テンプレート", "description": "カスタム従業員項目テンプレートを操作します" }, { "name": "カスタム家族項目テンプレート", "description": "カスタム家族項目テンプレートを操作します" }, { "name": "部署", "description": "部署を操作します" }, { "name": "雇用形態", "description": "雇用形態を操作します" }, { "name": "従業員情報収集フォーム", "description": "従業員情報収集フォームを操作します" }, { "name": "メールフォーマット", "description": "メールフォーマットを操作します" }, { "name": "ユーザー", "description": "ログインユーザーを操作します" }, { "name": "Webhook", "description": "Webhook を操作します" }, { "name": "会社情報", "description": "会社情報を操作します" }, { "name": "事業所", "description": "事業所を操作します" }, { "name": "口座情報", "description": "口座情報を操作します" }, { "name": "給与支給形態", "description": "給与支給形態を操作します" }, { "name": "役職", "description": "役職を操作します" }, { "name": "等級", "description": "等級を操作します" }, { "name": "職種", "description": "職種を操作します" }, { "name": "採用区分", "description": "採用区分を操作します" }, { "name": "続柄", "description": "続柄を操作します" }, { "name": "給与明細グループ", "description": "給与明細グループを操作します" }, { "name": "給与明細", "description": "給与明細を操作します" }, { "name": "源泉徴収票グループ", "description": "源泉徴収票グループを操作します" }, { "name": "源泉徴収票", "description": "源泉徴収票を操作します" }, { "name": "バックグラウンド処理", "description": "バックグラウンド処理を操作します" }, { "name": "バックグラウンド処理添付ファイル", "description": "バックグラウンド処理添付ファイルを操作します" }, { "name": "Addon", "description": "Addonを操作します" }, { "name": "マイナンバー", "description": "マイナンバー情報を操作します" }, { "name": "ロール", "description": "ロールを操作します" } ], "paths": { "/v1/crews": { "get": { "summary": "リストの取得", "description": "指定した条件に合致する従業員をリストで取得します。\n\n**雇用形態の表現について**\n\n雇用形態データの構造変更に伴い、`emp_type` 項目の利用は非推奨となりました。\n今後は `employment_type` 項目をご利用ください。\n\nなお、`emp_type` 項目には、登録されている雇用形態が「プリセット雇用形態」の時のみ、その preset_type の値が入ります。出力形式は従来と変更ありません。\n\n**部署の表現について**\n\n部署データの構造変更に伴い、`department` 項目の利用は非推奨となりました。\n今後は `departments` 項目をご利用ください。\n\nなお、`department` 項目には、1番目に登録されている部署について、各階層の名称を `/` で連結した文字列が出力されます。\n\n**役職の表現について**\n\n役職データの構造変更に伴い、`position` 項目の利用は非推奨となりました。\n今後は `positions` 項目をご利用ください。\n\n**社会保険の資格取得年月日・社会保険の資格喪失年月日の表現について**\n\n社会保険データの構造変更に伴い、`soc_ins_qualified_at`、`soc_ins_disqualified_at` 項目の利用は非推奨となりました。\n今後は `health_insurance_qualified_at` (= 健康保険の資格取得年月日)、`health_insurance_disqualified_at` (= 健康保険の資格喪失年月日)、`employees_pension_insurance_qualified_at` (= 厚生年金保険の資格取得年月日)、`employees_pension_insurance_disqualified_at` (= 厚生年金保険の資格喪失年月日) 項目をご利用ください。\n\nなお、従来の `soc_ins_qualified_at`、`soc_ins_disqualified_at` 項目は健康保険と厚生年金保険を区別せず同一の日付を返していましたが、新しい項目では保険種別ごとに個別の日付を設定できます。\n\n詳しくは [お知らせ](https://support.smarthr.jp/ja/info/update/jev3_1nugv3h/#hf7b55de2c2) をご確認ください。\n\n**カスタム項目の表現について**\n\n`custom_fields` に含まれるカスタム項目設定値は、テンプレート種別によって形式が変わります。\n\n- テキスト（1行）（type: string）\n - String 型\n- テキスト（複数行）（type: text）\n - String 型\n- 数値（type: decimal）\n - Integer 型\n- 日付（type: date）\n - `yyyy-MM-dd` 形式の String 型\n- ドロップダウンリスト（type: enum）\n - ドロップダウンリスト項目の ID（String 型）\n - ドロップダウンリスト項目に `physical_name` が設定されている場合は、その値（String 型）\n- ファイル（type: file）\n - アップロードしたファイルへの期限付き URL（String 型）\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "emp_code", "description": "社員番号", "type": "string", "required": false }, { "in": "query", "name": "emp_type", "description": "雇用形態の preset_type。本パラメーターは非推奨であり、代わりにemployment_type_id の利用を推奨します。", "type": "string", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ], "required": false }, { "in": "query", "name": "employment_type_id", "description": "雇用形態ID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "emp_status", "description": "在籍状況", "type": "string", "enum": [ "employed", "absent", "retired" ], "required": false }, { "in": "query", "name": "gender", "description": "戸籍上の性別", "type": "string", "enum": [ "male", "female" ], "required": false }, { "in": "query", "name": "sort", "description": "並び順", "type": "string", "required": false }, { "in": "query", "name": "entered_at_from", "description": "指定した日以降に入社した従業員に絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "entered_at_to", "description": "指定した日以前に入社した従業員に絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "resigned_at_from", "description": "指定した日以降に退職した従業員に絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "resigned_at_to", "description": "指定した日以前に退職した従業員に絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "user_id", "description": "ユーザーID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "department_id", "description": "取得したい従業員の所属する部署ID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "position_id", "description": "取得したい従業員の役職ID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "q", "description": "氏名・ビジネスネーム・部署名・役職名でフリーワード検索をします", "type": "string", "required": false }, { "in": "query", "name": "prefer_business_name", "description": "氏名・ビジネスネーム・部署名・役職名でフリーワード検索をする際にビジネスネームを優先して検索するかどうか", "type": "boolean", "required": false }, { "in": "query", "name": "id", "description": "取得したい従業員のID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "fields", "description": "取得する項目名（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Crew" } } } }, "tags": [ "従業員" ], "operationId": "getV1Crews" }, "post": { "summary": "登録", "description": "従業員情報を新規登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"last_name\": \"山田\",\n \"first_name\": \"太郎\",\n \"gender\": \"male\"\n}\n```\n\n新規登録に際して、特に必須項目はありません。\n\nレスポンスヘッダーの `Location` には **SmartHR 上でのエンドポイント URL** が含まれます。\n\n**雇用形態の設定について**\n\n雇用形態データの構造変更に伴い、`emp_type` パラメータの利用は非推奨となりました。\n今後は `employment_type_id` パラメータをご利用ください。\n\nなお、`emp_type` パラメータに雇用形態種別を指定した場合は、以下のような挙動になります。\n\n- 指定した雇用形態種別を preset_type に持つ雇用形態が設定されます\n- 存在しない雇用形態種別を指定した場合はリクエストエラーとなります\n\n**部署項目値の設定について**\n\n部署データの構造変更に伴い、`department` パラメータの利用は非推奨となりました。\n今後は `department_ids` パラメータをご利用ください。\n\nなお、`department` パラメータに部署名を指定した場合は、以下のような挙動になります。\n\n- 指定した部署名を持つ部署が存在する場合\n - 存在する部署を設定します\n - トップレベルにある部署のみ検索対象とします\n- 指定した部署名を持つ部署が存在しない場合\n - その部署名で部署を新規登録し、設定します\n - 部署の階層はトップレベルになります\n\n**役職の設定について**\n\n役職データの構造変更に伴い、`position` パラメータの利用は非推奨となりました。\n今後は `positions` パラメータをご利用ください。\n\nなお、`position` パラメータに役職名を指定した場合は、以下のような挙動になります。\n\n- 指定した役職名を持つ役職が存在する場合\n - 存在する役職を設定します\n- 指定した役職名を持つ役職が存在しない場合\n - その役職名で役職を新規登録し、設定します\n\n**社会保険の資格取得年月日・社会保険の資格喪失年月日の設定について**\n\n社会保険データの構造変更に伴い、`soc_ins_qualified_at`、`soc_ins_disqualified_at` パラメータの利用は非推奨となりました。\n今後は `health_insurance_qualified_at` (= 健康保険の資格取得年月日)、`health_insurance_disqualified_at` (= 健康保険の資格喪失年月日)、`employees_pension_insurance_qualified_at` (= 厚生年金保険の資格取得年月日)、`employees_pension_insurance_disqualified_at` (= 厚生年金保険の資格喪失年月日) パラメータをご利用ください。\n\nなお、従来の `soc_ins_qualified_at`、`soc_ins_disqualified_at` パラメータは健康保険と厚生年金保険を区別せず同一の日付を設定していましたが、新しいパラメータでは保険種別ごとに個別の日付を設定できます。\n\n詳しくは [お知らせ](https://support.smarthr.jp/ja/info/update/jev3_1nugv3h/#hf7b55de2c2) をご確認ください。\n\n**口座情報について**\n\n口座情報データの構造変更に伴い、bank_accounts パラメータのオブジェクトに `bank_account_setting_id` (= 口座設定ID) の指定が可能になりました。\n\n`bank_account_setting_id` を指定した場合は、以下のような挙動になります。\n\n- `bank_account_setting_id` を含まないパラメータが混在している場合、リクエストエラーとなります\n- 存在しない `bank_account_setting_id` を指定した場合はリクエストエラーとなります\n\n`bank_account_setting_id` を指定しなかった場合は、以下のような挙動になります。\n\n- パラメータの先頭から順にデータを突合し、登録・更新を行ないます\n- 有効な口座設定の数を越えたパラメータが指定された場合、リクエストエラーとなります\n- `bank_account_setting_id` を含むパラメータが混在している場合、リクエストエラーとなります\n\n**カスタム項目値の設定について**\n\nカスタム項目値の設定は `custom_fields` パラメータで行ないます。 `value` に設定する値は、テンプレート種別に対応させてください。\n\nJSON 例\n```\n{\n \"custom_fields\": [\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789aa\",\n \"value\": \"string\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ab\",\n \"value\": \"text\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ac\",\n \"value\": 0\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ad\",\n \"value\": \"2017-03-09\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ae\",\n \"value\": \"enum_element_physical_name\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789af\",\n \"value\": \"/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AK...\",\n \"file_name\": \"awesome_image.jpg\"\n }\n ]\n}\n```\n\n- ドロップダウンリスト（type: enum）は、ドロップダウンリスト要素の ID か、`physical_name` の設定値を使って指定します\n- ファイルは、データを Base64 エンコードした文字列を指定し、かつ `file_name` にデータの名前を拡張子付きで指定します\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1Crews", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1Crews" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Crew" } } }, "tags": [ "従業員" ], "operationId": "postV1Crews" } }, "/v1/crews/{id}": { "get": { "summary": "取得", "description": "指定した ID の従業員情報を取得します。\n\n**雇用形態の表現について**\n\n雇用形態データの構造変更に伴い、`emp_type` 項目の利用は非推奨となりました。\n今後は `employment_type` 項目をご利用ください。\n\nなお、`emp_type` 項目には、登録されている雇用形態が「プリセット雇用形態」の時のみ、その preset_type の値が入ります。出力形式は従来と変更ありません。\n\n**部署の表現について**\n\n部署データの構造変更に伴い、`department` 項目の利用は非推奨となりました。\n今後は `departments` 項目をご利用ください。\n\nなお、`department` 項目には、1番目に登録されている部署について、各階層の名称を `/` で連結した文字列が出力されます。\n\n**役職の表現について**\n\n役職データの構造変更に伴い、`position` 項目の利用は非推奨となりました。\n今後は `positions` 項目をご利用ください。\n\n**社会保険の資格取得年月日・社会保険の資格喪失年月日の表現について**\n\n社会保険データの構造変更に伴い、`soc_ins_qualified_at`、`soc_ins_disqualified_at` 項目の利用は非推奨となりました。\n今後は `health_insurance_qualified_at` (= 健康保険の資格取得年月日)、`health_insurance_disqualified_at` (= 健康保険の資格喪失年月日)、`employees_pension_insurance_qualified_at` (= 厚生年金保険の資格取得年月日)、`employees_pension_insurance_disqualified_at` (= 厚生年金保険の資格喪失年月日) 項目をご利用ください。\n\nなお、従来の `soc_ins_qualified_at`、`soc_ins_disqualified_at` 項目は健康保険と厚生年金保険を区別せず同一の日付を返していましたが、新しい項目では保険種別ごとに個別の日付を設定できます。\n\n詳しくは [お知らせ](https://support.smarthr.jp/ja/info/update/jev3_1nugv3h/#hf7b55de2c2) をご確認ください。\n\n**カスタム項目の表現について**\n\n`custom_fields` に含まれるカスタム項目設定値は、テンプレート種別によって形式が変わります。\n\n- テキスト（1行）（type: string）\n - String 型\n- テキスト（複数行）（type: text）\n - String 型\n- 数値（type: decimal）\n - Integer 型\n- 日付（type: date）\n - `yyyy-MM-dd` 形式の String 型\n- ドロップダウンリスト（type: enum）\n - ドロップダウンリスト要素の ID（String 型）\n - ドロップダウンリスト要素に `physical_name` が設定されている場合は、その値（String 型）\n- ファイル（type: file）\n - アップロードしたファイルへの期限付き URL（String 型）\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員ID", "type": "string", "required": true }, { "in": "query", "name": "fields", "description": "取得する項目名（カンマ区切り）", "type": "string", "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Crew" } } }, "tags": [ "従業員" ], "operationId": "getV1CrewsId" }, "put": { "summary": "更新", "description": "**このエンドポイントは利用非推奨です**\n\n2020年12月16日より、従業員の更新は「部分更新（PATCH ）」のみの提供となりました。\nこのエンドポイント自体は利用可能ですが、挙動は部分更新と同等になります。\nリクエスト元の制限で PATCH メソッドが使用できないような場合に、エイリアスとしてご利用ください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員ID", "type": "string", "required": true }, { "name": "putV1CrewsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1CrewsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/Crew" } } }, "tags": [ "従業員" ], "operationId": "putV1CrewsId", "deprecated": true }, "patch": { "summary": "部分更新", "description": "指定した ID の従業員情報を部分更新します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"last_name\": \"山田\",\n \"first_name\": \"太郎\",\n \"gender\": \"male\"\n}\n```\n\n以下の項目が入力済みの従業員に対して、**これらのいずれかを欠けさせる**更新はできません。\n- last_name\n- first_name\n- last_name_yomi\n- first_name_yomi\n- gender\n- birth_at\n- address\n\n\n**雇用形態の設定について**\n\n雇用形態データの構造変更に伴い、`emp_type` パラメータの利用は非推奨となりました。\n今後は `employment_type_id` パラメータをご利用ください。\n\nなお、`emp_type` パラメータに雇用形態種別を指定した場合は、以下のような挙動になります。\n\n- 指定した雇用形態種別を preset_type に持つ雇用形態が設定されます\n- 存在しない雇用形態種別を指定した場合はリクエストエラーとなります\n- 従業員にプリセット雇用形態以外が設定されている場合、`emp_type` パラメータではそれを null にできません\n\n**部署項目値の設定について**\n\n部署データの構造変更に伴い、`department` パラメータの利用は非推奨となりました。\n今後は `department_ids` パラメータをご利用ください。\n\nなお、`department` パラメータに部署名を指定した場合は、以下のような挙動になります。\n\n- 指定した部署名を持つ部署が存在する場合\n - 存在する部署を設定します\n - トップレベルにある部署のみ検索対象とします\n- 指定した部署名を持つ部署が存在しない場合\n - その部署名で部署を新規登録し、設定します\n - 部署の階層はトップレベルになります\n\n**役職の設定について**\n\n役職データの構造変更に伴い、`position` パラメータの利用は非推奨となりました。\n今後は `positions` パラメータをご利用ください。\n\nなお、`position` パラメータに役職名を指定した場合は、以下のような挙動になります。\n\n- 指定した役職名を持つ役職が存在する場合\n - 存在する役職を設定します\n- 指定した役職名を持つ役職が存在しない場合\n - その役職名で役職を新規登録し、設定します\n\n**社会保険の資格取得年月日・社会保険の資格喪失年月日の設定について**\n\n社会保険データの構造変更に伴い、`soc_ins_qualified_at`、`soc_ins_disqualified_at` パラメータの利用は非推奨となりました。\n今後は `health_insurance_qualified_at` (= 健康保険の資格取得年月日)、`health_insurance_disqualified_at` (= 健康保険の資格喪失年月日)、`employees_pension_insurance_qualified_at` (= 厚生年金保険の資格取得年月日)、`employees_pension_insurance_disqualified_at` (= 厚生年金保険の資格喪失年月日) パラメータをご利用ください。\n\nなお、従来の `soc_ins_qualified_at`、`soc_ins_disqualified_at` パラメータは健康保険と厚生年金保険を区別せず同一の日付を設定していましたが、新しいパラメータでは保険種別ごとに個別の日付を設定できます。\n\n詳しくは [お知らせ](https://support.smarthr.jp/ja/info/update/jev3_1nugv3h/#hf7b55de2c2) をご確認ください。\n\n**口座情報について**\n\n口座情報データの構造変更に伴い、bank_accounts パラメータのオブジェクトに `bank_account_setting_id` (= 口座設定ID) の指定が可能になりました。\n\n`bank_account_setting_id` を指定した場合は、以下のような挙動になります。\n\n- `bank_account_setting_id` を含まないパラメータが混在している場合、リクエストエラーとなります\n- 存在しない `bank_account_setting_id` を指定した場合はリクエストエラーとなります\n\n`bank_account_setting_id` を指定しなかった場合は、以下のような挙動になります。\n\n- パラメータの先頭から順にデータを突合し、登録・更新を行ないます\n- 有効な口座設定の数を越えたパラメータが指定された場合、リクエストエラーとなります\n- `bank_account_setting_id` を含むパラメータが混在している場合、リクエストエラーとなります\n\n**カスタム項目値の設定について**\n\nカスタム項目値の設定は `custom_fields` パラメータで行ないます。 `value` に設定する値は、テンプレート種別に対応させてください。\n\nJSON 例\n```\n{\n \"custom_fields\": [\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789aa\",\n \"value\": \"string\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ab\",\n \"value\": \"text\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ac\",\n \"value\": 0\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ad\",\n \"value\": \"2017-03-09\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ae\",\n \"value\": \"enum_element_physical_name\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789af\",\n \"value\": \"/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AK...\",\n \"file_name\": \"awesome_image.jpg\"\n }\n ]\n}\n```\n\n- ドロップダウンリスト（type: enum）は、ドロップダウンリスト要素の ID か、`physical_name` の設定値を使って指定します\n- ファイルは、データを Base64 エンコードした文字列を指定し、かつ `file_name` にデータの名前を拡張子付きで指定します\n- 指定した `template_id` の値がすでにある場合は、それを更新します\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員ID", "type": "string", "required": true }, { "name": "patchV1CrewsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1CrewsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Crew" } } }, "tags": [ "従業員" ], "operationId": "patchV1CrewsId" }, "delete": { "summary": "削除", "description": "指定した ID の従業員情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Crew" } } }, "tags": [ "従業員" ], "operationId": "deleteV1CrewsId" } }, "/v1/crews/{id}/invite": { "put": { "summary": "招待", "description": "指定した ID の従業員に設定されているメールアドレスでユーザーを招待します。\n\n- 指定した従業員情報収集フォームに紐づくメールフォーマットで招待メールが送信されます\n- 一度招待した従業員に対する2回目以降の招待リクエストは、再招待扱いになります\n - 従業員のメールアドレスが変わっていた場合は、招待中ユーザーのメールアドレスが更新されます\n - 招待を承認済みの従業員に対しての再招待はできません\n- 招待者のユーザーには管理者権限を持つユーザーを指定してください\n- 権限はメンバー権限が適用されます（権限の指定はできません）\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員ID", "type": "string", "required": true }, { "name": "putV1CrewsIdInvite", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1CrewsIdInvite" } } ], "responses": { "204": { "description": "(no content)" } }, "tags": [ "従業員" ], "operationId": "putV1CrewsIdInvite" } }, "/v1/crews/{crew_id}/departments": { "delete": { "summary": "部署情報の削除", "description": "指定した ID の従業員の部署情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)" } }, "tags": [ "従業員" ], "operationId": "deleteV1CrewsCrewIdDepartments" } }, "/v1/crews/{crew_id}/dependents": { "get": { "summary": "リストの取得", "description": "指定した従業員に紐づく家族情報をリストで取得します。\n\n**カスタム項目の表現について**\n\n`custom_fields` に含まれるカスタム項目設定値は、テンプレート種別によって形式が変わります。\n\n- テキスト（1行）（type: string）\n - String 型\n- テキスト（複数行）（type: text）\n - String 型\n- 数値（type: decimal）\n - Integer 型\n- 日付（type: date）\n - `yyyy-MM-dd` 形式の String 型\n- ドロップダウンリスト（type: enum）\n - ドロップダウンリスト項目の ID（String 型）\n - ドロップダウンリスト項目に `physical_name` が設定されている場合は、その値（String 型）\n- ファイル（type: file）\n - アップロードしたファイルへの期限付き URL（String 型）\n\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Dependent" } } } }, "tags": [ "家族情報" ], "operationId": "getV1CrewsCrewIdDependents" }, "post": { "summary": "登録", "description": "家族情報を新規登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"last_name\": \"山田\",\n \"first_name\": \"太郎\",\n \"relation_id\": \"xxxx\",\n \"gender\": \"male\",\n \"birth_at\": \"1960-01-01\",\n \"live_together_type\": \"living_together\"\n}\n```\n\n- `tax_law_support_type` パラメータを指定しない場合、`supported` を設定します。\n- `social_insurance_support_type` パラメータを指定しない場合、`supported` を設定します。\n\n**カスタム項目の値の設定について**\n\nカスタム項目の値の設定は `custom_fields` パラメータで行ないます。 `value` に設定する値は、テンプレート種別に対応させてください。\n\nJSON 例\n```\n{\n \"custom_fields\": [\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789aa\",\n \"value\": \"string\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ab\",\n \"value\": \"text\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ac\",\n \"value\": 0\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ad\",\n \"value\": \"2017-03-09\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ae\",\n \"value\": \"enum_element_physical_name\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789af\",\n \"value\": \"/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AK...\",\n \"file_name\": \"awesome_image.jpg\"\n }\n ]\n}\n```\n\n- ドロップダウンリスト（type: enum）の場合、 `value` にはドロップダウンリスト項目の ID か、 `physical_name` の値を指定します\n- ファイル（type: file）の場合、 `value` にはデータを Base64 エンコードした文字列を指定し、かつ `file_name` にデータの名前を拡張子付きで指定します\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "name": "postV1CrewsCrewIdDependents", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1CrewsCrewIdDependents" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Dependent" } } }, "tags": [ "家族情報" ], "operationId": "postV1CrewsCrewIdDependents" } }, "/v1/crews/{crew_id}/dependents/{id}": { "get": { "summary": "取得", "description": "指定した ID の家族情報を取得します。\n\n**カスタム項目の表現について**\n\n`custom_fields` に含まれるカスタム項目設定値は、テンプレート種別によって形式が変わります。\n\n- テキスト（1行）（type: string）\n - String 型\n- テキスト（複数行）（type: text）\n - String 型\n- 数値（type: decimal）\n - Integer 型\n- 日付（type: date）\n - `yyyy-MM-dd` 形式の String 型\n- ドロップダウンリスト（type: enum）\n - ドロップダウンリスト項目の ID（String 型）\n - ドロップダウンリスト項目に `physical_name` が設定されている場合は、その値（String 型）\n- ファイル（type: file）\n - アップロードしたファイルへの期限付き URL（String 型）\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "家族ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Dependent" } } }, "tags": [ "家族情報" ], "operationId": "getV1CrewsCrewIdDependentsId" }, "put": { "summary": "更新", "description": "**このエンドポイントは利用非推奨です**\n\nこのエンドポイント自体は利用可能ですが、挙動は部分更新と同等になります。\nリクエスト元の制限で PATCH メソッドが使用できないような場合に、エイリアスとしてご利用ください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "家族ID", "type": "string", "required": true }, { "name": "putV1CrewsCrewIdDependentsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1CrewsCrewIdDependentsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/Dependent" } } }, "tags": [ "家族情報" ], "operationId": "putV1CrewsCrewIdDependentsId", "deprecated": true }, "patch": { "summary": "部分更新", "description": "指定した ID の家族情報を部分更新します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"last_name\": \"山田\",\n \"first_name\": \"五朗\"\n}\n```\n\n**カスタム項目の値の設定について**\n\nカスタム項目の値の設定は `custom_fields` パラメータで行ないます。 `value` に設定する値は、テンプレート種別に対応させてください。\n\nJSON 例\n```\n{\n \"custom_fields\": [\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789aa\",\n \"value\": \"string\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ab\",\n \"value\": \"text\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ac\",\n \"value\": 0\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ad\",\n \"value\": \"2017-03-09\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789ae\",\n \"value\": \"enum_element_physical_name\"\n },\n {\n \"template_id\": \"1234567a-123a-123a-123a-123456789af\",\n \"value\": \"/9j/4AAQSkZJRgABAQAASABIAAD/4QCMRXhpZgAATU0AK...\",\n \"file_name\": \"awesome_image.jpg\"\n }\n ]\n}\n```\n\n- ドロップダウンリスト（type: enum）の場合、 `value` にはドロップダウンリスト項目の ID か、 `physical_name` の値を指定します\n- ファイル（type: file）の場合、 `value` にはデータを Base64 エンコードした文字列を指定し、かつ `file_name` にデータの名前を拡張子付きで指定します\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "家族ID", "type": "string", "required": true }, { "name": "patchV1CrewsCrewIdDependentsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1CrewsCrewIdDependentsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Dependent" } } }, "tags": [ "家族情報" ], "operationId": "patchV1CrewsCrewIdDependentsId" }, "delete": { "summary": "削除", "description": "指定した ID の家族情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "家族ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Dependent" } } }, "tags": [ "家族情報" ], "operationId": "deleteV1CrewsCrewIdDependentsId" } }, "/v1/crews/{crew_id}/maternity_childcare_leaves": { "get": { "summary": "リストの取得", "description": "指定した従業員に紐づく産休育休情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "crew_id", "description": "従業員ID", "type": "string", "required": true }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/MaternityChildcareLeave" } } } }, "tags": [ "産休育休情報" ], "operationId": "getV1CrewsCrewIdMaternityChildcareLeaves" } }, "/v1/crew_custom_field_template_groups/{id}": { "get": { "summary": "取得", "description": "指定した ID のカスタム従業員項目グループ情報を取得します。\n\n`embed=templates` を指定すると、そのグループに属するカスタム項目テンプレート情報も合わせて取得できます。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目グループID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "templates" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "getV1CrewCustomFieldTemplateGroupsId" }, "put": { "summary": "更新", "description": "指定した ID のカスタム従業員項目グループ情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目グループID", "type": "string", "required": true }, { "name": "putV1CrewCustomFieldTemplateGroupsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1CrewCustomFieldTemplateGroupsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "putV1CrewCustomFieldTemplateGroupsId" }, "patch": { "summary": "部分更新", "description": "指定した ID のカスタム従業員項目グループ情報を部分更新します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目グループID", "type": "string", "required": true }, { "name": "patchV1CrewCustomFieldTemplateGroupsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1CrewCustomFieldTemplateGroupsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "patchV1CrewCustomFieldTemplateGroupsId" }, "delete": { "summary": "削除", "description": "指定した ID のカスタム従業員項目グループ情報を削除します。\n\n**グループに属するカスタム項目テンプレート、およびそれらのテンプレートに対して設定されている値がすべて削除されます。**\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目グループID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "deleteV1CrewCustomFieldTemplateGroupsId" } }, "/v1/crew_custom_field_template_groups": { "get": { "summary": "リスト取得", "description": "カスタム従業員項目グループをリストで取得します。\n\n`embed=templates` を指定すると、そのグループに属するカスタム項目テンプレート情報も合わせて取得できます。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "templates" ], "required": false } ], "responses": { "200": { "description": "リスト取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "getV1CrewCustomFieldTemplateGroups" }, "post": { "summary": "登録", "description": "カスタム従業員項目グループを新規登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1CrewCustomFieldTemplateGroups", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1CrewCustomFieldTemplateGroups" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } } }, "tags": [ "カスタム従業員項目グループ" ], "operationId": "postV1CrewCustomFieldTemplateGroups" } }, "/v1/crew_custom_field_templates": { "get": { "summary": "リストの取得", "description": "カスタム従業員項目をリストで取得します。\n\n`embed=group` を指定すると、属するカスタム項目グループ情報も合わせて取得できます。（ `group_id` が `group` に置き換わります）\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "group" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "getV1CrewCustomFieldTemplates" }, "post": { "summary": "登録", "description": "カスタム従業員項目を新規登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"name\": \"身長\",\n \"type\": \"decimal\",\n \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\nJSON 例\n```\n{\n \"name\": \"血液型\",\n \"type\": \"enum\",\n \"elements\": [\n { \"name\": \"A型\", \"position\": 1 },\n { \"name\": \"B型\", \"position\": 2 },\n ...\n ]\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1CrewCustomFieldTemplates", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1CrewCustomFieldTemplates" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "postV1CrewCustomFieldTemplates" } }, "/v1/crew_custom_field_templates/{id}": { "get": { "summary": "取得", "description": "指定した ID のカスタム従業員項目情報を取得します。\n\n`embed=group` を指定すると、属するカスタム項目グループ情報も合わせて取得できます。（ `group_id` が `group` に置き換わります）\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目ID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "group" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "getV1CrewCustomFieldTemplatesId" }, "put": { "summary": "更新", "description": "指定した ID のカスタム従業員項目情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"name\": \"身長\",\n \"type\": \"decimal\",\n \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\n既存の elements 要素を更新する場合は `id` を指定してください。この時、指定されなかった既存の要素はすべて削除されます。\n\nJSON 例\n```\n{\n \"name\": \"血液型\",\n \"type\": \"enum\",\n \"elements\": [\n { \"id\", 1, \"name\": \"A型\", \"position\": 1 },\n { \"name\": \"AB型\", \"position\": 3 },\n ...\n ]\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目ID", "type": "string", "required": true }, { "name": "putV1CrewCustomFieldTemplatesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1CrewCustomFieldTemplatesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "putV1CrewCustomFieldTemplatesId" }, "patch": { "summary": "部分更新", "description": "指定した ID のカスタム従業員項目情報を部分更新します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"name\": \"身長\",\n \"type\": \"decimal\",\n \"scale\": 1\n}\n```\n\nなお、種別がドロップダウンリスト項目（type: enum）の時のみ、 `elements` アトリビュートで要素を指定できます。\n\n既存の elements 要素を更新する場合は `id` を指定してください。\n\nJSON 例\n```\n{\n \"name\": \"血液型\",\n \"type\": \"enum\",\n \"elements\": [\n { \"id\", 1, \"name\": \"A型\", \"position\": 1 },\n { \"name\": \"AB型\", \"position\": 3 },\n ...\n ]\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目ID", "type": "string", "required": true }, { "name": "patchV1CrewCustomFieldTemplatesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1CrewCustomFieldTemplatesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "patchV1CrewCustomFieldTemplatesId" }, "delete": { "summary": "削除", "description": "指定した ID のカスタム従業員項目情報を削除します。\n\n**テンプレートに対して設定されている値がすべて削除されます。**\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "カスタム従業員項目ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/CrewCustomFieldTemplate" } } }, "tags": [ "カスタム従業員項目テンプレート" ], "operationId": "deleteV1CrewCustomFieldTemplatesId" } }, "/v1/departments": { "get": { "summary": "リストの取得", "description": "部署をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "code", "description": "コード", "type": "string", "required": false }, { "in": "query", "name": "sort", "description": "並び順", "type": "string", "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Department" } } } }, "tags": [ "部署" ], "operationId": "getV1Departments" }, "post": { "summary": "登録", "description": "部署情報を新規登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0,\n \"parent_id\": 0\n}\n```\n\n- `name` には `/` を含められません\n- `position` を指定しなかった場合は、自動で採番されます。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1Departments", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1Departments" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Department" } } }, "tags": [ "部署" ], "operationId": "postV1Departments" } }, "/v1/departments/{id}": { "get": { "summary": "取得", "description": "指定した ID の部署情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "部署ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Department" } } }, "tags": [ "部署" ], "operationId": "getV1DepartmentsId" }, "put": { "summary": "更新", "description": "指定した ID の部署情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0,\n \"parent_id\": 0\n}\n```\n\n`name` には `/` を含められません\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "部署ID", "type": "string", "required": true }, { "name": "putV1DepartmentsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1DepartmentsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/Department" } } }, "tags": [ "部署" ], "operationId": "putV1DepartmentsId" }, "patch": { "summary": "部分更新", "description": "指定した ID の部署情報を部分更新します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"position\": 0,\n \"parent_id\": 0\n}\n```\n\n`name` には `/` を含められません\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "部署ID", "type": "string", "required": true }, { "name": "patchV1DepartmentsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1DepartmentsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Department" } } }, "tags": [ "部署" ], "operationId": "patchV1DepartmentsId" }, "delete": { "summary": "削除", "description": "**このエンドポイントは利用非推奨です**\n\n「廃止日」を指定できる「廃止（POST）」のリリースに伴い、このエンドポイントは利用非推奨となりました。\n今後は、「廃止（POST）」をご利用ください。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "部署ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Department" } } }, "tags": [ "部署" ], "operationId": "deleteV1DepartmentsId", "deprecated": true } }, "/v1/departments/{id}/discontinue": { "post": { "summary": "廃止", "description": "指定した ID の部署を廃止します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n\n```\n{\n \"discontinued_date\": \"string\"\n}\n```\n\n** `discontinued_date` (廃止日)について**\n\n- 部署が存続していた最後の日を指定してください。\n- 過去の日付のみ指定できます。\n- その他、「部署の廃止」そのものの注意点については、[部署マスターを廃止する](https://support.smarthr.jp/ja/help/articles/1b1300f0-23ed-4d63-ba2b-acf99a97732a/)を参照してください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "部署ID", "type": "string", "required": true }, { "name": "postV1DepartmentsIdDiscontinue", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1DepartmentsIdDiscontinue" } } ], "responses": { "204": { "description": "(no content)" } }, "tags": [ "部署" ], "operationId": "postV1DepartmentsIdDiscontinue" } }, "/v1/employment_types": { "get": { "summary": "リストの取得", "description": "雇用形態をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/EmploymentType" } } } }, "tags": [ "雇用形態" ], "operationId": "getV1EmploymentTypes" }, "post": { "summary": "登録", "description": "雇用形態情報を新規登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"code\": \"string\"\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1EmploymentTypes", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1EmploymentTypes" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/EmploymentType" } } }, "tags": [ "雇用形態" ], "operationId": "postV1EmploymentTypes" } }, "/v1/employment_types/{id}": { "get": { "summary": "取得", "description": "指定した ID の雇用形態情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "雇用形態ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/EmploymentType" } } }, "tags": [ "雇用形態" ], "operationId": "getV1EmploymentTypesId" }, "put": { "summary": "更新", "description": "指定した ID の雇用形態情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\"\n}\n```\n\nなお、以下に該当する雇用形態の更新はできません。\n - システム標準の雇用形態\n - 適用日を迎えていない従業員情報の更新が予定されている雇用形態\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "雇用形態ID", "type": "string", "required": true }, { "name": "putV1EmploymentTypesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1EmploymentTypesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/EmploymentType" } } }, "tags": [ "雇用形態" ], "operationId": "putV1EmploymentTypesId" }, "patch": { "summary": "部分更新", "description": "指定した ID の雇用形態情報を部分更新します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"code\": \"string\"\n}\n```\n\nなお、以下に該当する雇用形態の更新はできません。\n - システム標準の雇用形態の名称\n - 適用日を迎えていない従業員情報の更新が予定されている雇用形態\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "雇用形態ID", "type": "string", "required": true }, { "name": "patchV1EmploymentTypesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1EmploymentTypesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/EmploymentType" } } }, "tags": [ "雇用形態" ], "operationId": "patchV1EmploymentTypesId" }, "delete": { "summary": "削除", "description": "指定した ID の雇用形態情報を削除します。\n\nなお、以下に該当する雇用形態の削除はできません。\n - システム標準の雇用形態\n - 適用日を迎えていない従業員情報の更新が予定されている雇用形態\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "雇用形態ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/EmploymentType" } } }, "tags": [ "雇用形態" ], "operationId": "deleteV1EmploymentTypesId" } }, "/v1/crew_input_forms": { "get": { "summary": "リストの取得", "description": "従業員情報収集フォーム情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "mail_format" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/CrewInputForm" } } } }, "tags": [ "従業員情報収集フォーム" ], "operationId": "getV1CrewInputForms" } }, "/v1/crew_input_forms/{id}": { "get": { "summary": "取得", "description": "指定した ID の従業員情報収集フォーム情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "従業員情報収集フォームID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/CrewInputForm" } } }, "tags": [ "従業員情報収集フォーム" ], "operationId": "getV1CrewInputFormsId" } }, "/v1/mail_formats": { "get": { "summary": "リストの取得", "description": "メールフォーマット情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "crew_input_forms" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/MailFormat" } } } }, "tags": [ "メールフォーマット" ], "operationId": "getV1MailFormats" } }, "/v1/mail_formats/{id}": { "get": { "summary": "取得", "description": "指定した ID のメールフォーマット情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "メールフォーマットID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "crew_input_forms" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/MailFormat" } } }, "tags": [ "メールフォーマット" ], "operationId": "getV1MailFormatsId" } }, "/v1/users": { "get": { "summary": "リストの取得", "description": "ユーザー情報をリストで取得します。\n\n**招待のステータスについて**\n\nユーザーに送信した招待は項目の値によって以下のように判定できます。\n\n- 従業員登録済み\n - `invitation_answered_at` に値が入っている\n- ユーザー登録済み\n - `invitation_created_at` が `null` である\n- 招待メール開封済み\n - `invitation_opened_at` に値が入っている\n- 招待メール送信済み\n - `invitation_created_at` に値が入っている\n\n**招待メールの送信エラーについて**\n\nメールフィルターやアドレス不備によって送信されない場合は `suppressed_email_logs` にエラー内容が記載されます。\n\n詳しくは [メールが届かない場合の原因は？](https://support.smarthr.jp/ja/help/articles/360026264593/) をご確認ください。\n\n- bounced\n - バウンス\n- spam_reported\n - スパムレポート\n- blocked\n - ブロック\n- malformed\n - 無効なメール\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "sort", "description": "並び順", "type": "string", "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "crew", "biz_establishment", "biz_establishment_company", "department_company" ], "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/User" } } } }, "tags": [ "ユーザー" ], "operationId": "getV1Users" } }, "/v1/users/{id}": { "get": { "summary": "取得", "description": "指定した ID のユーザー情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "crew", "biz_establishment", "biz_establishment_company", "department_company" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/User" } } }, "tags": [ "ユーザー" ], "operationId": "getV1UsersId" } }, "/v1/users/{id}/saml_user": { "get": { "summary": "SAML SSOアカウントを取得", "description": "指定した ID のユーザーの「SAML SSOアカウント」を取得します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true } ], "responses": { "200": { "description": "SAML SSOアカウントを取得" } }, "tags": [ "ユーザー" ], "operationId": "getV1UsersIdSamlUser" }, "post": { "summary": "SAML SSOアカウントの作成", "description": "指定した ID のユーザーのSAML SSOアカウントを作成します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true }, { "name": "postV1UsersIdSamlUser", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1UsersIdSamlUser" } } ], "responses": { "201": { "description": "SAML SSOアカウントの作成", "schema": { "$ref": "#/definitions/SamlUser" } } }, "tags": [ "ユーザー" ], "operationId": "postV1UsersIdSamlUser" }, "patch": { "summary": "SAML SSOアカウントを更新", "description": "指定した ID のユーザーのSAML SSOアカウントを更新します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true }, { "name": "patchV1UsersIdSamlUser", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1UsersIdSamlUser" } } ], "responses": { "200": { "description": "SAML SSOアカウントを更新", "schema": { "$ref": "#/definitions/SamlUser" } } }, "tags": [ "ユーザー" ], "operationId": "patchV1UsersIdSamlUser" }, "delete": { "summary": "SAML SSOアカウントを削除", "description": "指定した ID のユーザーのSAML SSOアカウントを削除します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true } ], "responses": { "204": { "description": "SAML SSOアカウントを削除" } }, "tags": [ "ユーザー" ], "operationId": "deleteV1UsersIdSamlUser" } }, "/v1/users/{id}/saml_user/enable": { "patch": { "summary": "SAML SSOアカウントを有効に変更", "description": "指定した ID のユーザーのSAML SSOアカウントを有効状態に変更します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true } ], "responses": { "200": { "description": "SAML SSOアカウントを有効に変更" } }, "tags": [ "ユーザー" ], "operationId": "patchV1UsersIdSamlUserEnable" } }, "/v1/users/{id}/saml_user/disable": { "patch": { "summary": "SAML SSOアカウントを無効に変更", "description": "指定した ID のユーザーのSAML SSOアカウントを無効状態に変更します。\n利用には SAML/SSOオプションの契約が必要です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "ユーザーID", "type": "string", "required": true } ], "responses": { "200": { "description": "SAML SSOアカウントを無効に変更" } }, "tags": [ "ユーザー" ], "operationId": "patchV1UsersIdSamlUserDisable" } }, "/v1/companies": { "get": { "summary": "リストの取得", "description": "会社情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "owner" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Company" } } } }, "tags": [ "会社情報" ], "operationId": "getV1Companies" } }, "/v1/biz_establishments": { "get": { "summary": "リストの取得", "description": "事業所情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "soc_ins_owner", "lab_ins_owner", "company" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/BizEstablishment" } } } }, "tags": [ "事業所" ], "operationId": "getV1BizEstablishments" } }, "/v1/webhooks/{id}": { "get": { "summary": "取得", "description": "指定した ID の Webhook 情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Webhook ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Webhook" } } }, "tags": [ "Webhook" ], "operationId": "getV1WebhooksId" }, "put": { "summary": "更新", "description": "指定した ID の Webhook 情報を更新します。\n未指定の属性は情報が削除されます。未指定の属性を消したくない場合は「部分更新」をご利用ください。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"url\": \"https://example.com/\",\n \"crew_created\": true,\n \"crew_updated\": false,\n \"crew_deleted\": true,\n \"crew_imported\": false\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Webhook ID", "type": "string", "required": true }, { "name": "putV1WebhooksId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1WebhooksId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/Webhook" } } }, "tags": [ "Webhook" ], "operationId": "putV1WebhooksId" }, "patch": { "summary": "部分更新", "description": "指定した ID の Webhook 情報を部分更新します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"crew_created\": false,\n \"crew_updated\": true\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Webhook ID", "type": "string", "required": true }, { "name": "patchV1WebhooksId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1WebhooksId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Webhook" } } }, "tags": [ "Webhook" ], "operationId": "patchV1WebhooksId" }, "delete": { "summary": "削除", "description": "指定した ID の Webhook 情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "Webhook ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Webhook" } } }, "tags": [ "Webhook" ], "operationId": "deleteV1WebhooksId" } }, "/v1/webhooks": { "get": { "summary": "リストの取得", "description": "Webhook をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Webhook" } } } }, "tags": [ "Webhook" ], "operationId": "getV1Webhooks" }, "post": { "summary": "登録", "description": "Webhook を新規登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"url\": \"https://example.com/\",\n \"crew_created\": true,\n \"crew_updated\": false,\n \"crew_deleted\": true,\n \"crew_imported\": false\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1Webhooks", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1Webhooks" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Webhook" } } }, "tags": [ "Webhook" ], "operationId": "postV1Webhooks" } }, "/v1/dependent_relations": { "get": { "summary": "リストの取得", "description": "続柄のリストを取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "filter", "description": "フィルター条件", "type": "string", "enum": [ "spouse" ], "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/DependentRelation" } } } }, "tags": [ "続柄" ], "operationId": "getV1DependentRelations" } }, "/v1/dependent_custom_field_templates": { "get": { "summary": "リストの取得", "description": "カスタム家族項目をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/DependentCustomFieldTemplate" } } } }, "tags": [ "カスタム家族項目テンプレート" ], "operationId": "getV1DependentCustomFieldTemplates" } }, "/v1/payment_periods": { "get": { "summary": "リストの取得", "description": "給与支給形態をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "sort", "description": "並び順", "type": "string", "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/PaymentPeriod" } } } }, "tags": [ "給与支給形態" ], "operationId": "getV1PaymentPeriods" } }, "/v1/payment_periods/{id}": { "get": { "summary": "取得", "description": "指定した ID の給与支給形態情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与支給形態のID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/PaymentPeriod" } } }, "tags": [ "給与支給形態" ], "operationId": "getV1PaymentPeriodsId" } }, "/v1/job_titles/{id}": { "get": { "summary": "取得", "description": "指定した ID の役職情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "役職ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/JobTitle" } } }, "tags": [ "役職" ], "operationId": "getV1JobTitlesId" }, "put": { "summary": "更新", "description": "指定した ID の役職情報を更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている役職の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "役職ID", "type": "string", "required": true }, { "name": "putV1JobTitlesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1JobTitlesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/JobTitle" } } }, "tags": [ "役職" ], "operationId": "putV1JobTitlesId" }, "patch": { "summary": "部分更新", "description": "指定した ID の役職情報を部分更新します。\n更新できるのは 役職の名前(name), 役職のランク(rank), 役職コード(code) です。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている役職の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "役職ID", "type": "string", "required": true }, { "name": "patchV1JobTitlesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1JobTitlesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/JobTitle" } } }, "tags": [ "役職" ], "operationId": "patchV1JobTitlesId" }, "delete": { "summary": "削除", "description": "指定した ID の役職情報を削除します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている役職の削除はできません。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "役職ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/JobTitle" } } }, "tags": [ "役職" ], "operationId": "deleteV1JobTitlesId" } }, "/v1/job_titles": { "get": { "summary": "リストの取得", "description": "役職情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "sort", "description": "並び順", "type": "string", "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/JobTitle" } } } }, "tags": [ "役職" ], "operationId": "getV1JobTitles" }, "post": { "summary": "作成", "description": "役職情報を新規登録します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1JobTitles", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1JobTitles" } } ], "responses": { "201": { "description": "作成", "schema": { "$ref": "#/definitions/JobTitle" } } }, "tags": [ "役職" ], "operationId": "postV1JobTitles" } }, "/v1/grades/{id}": { "get": { "summary": "取得", "description": "指定した ID の等級情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "等級ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Grade" } } }, "tags": [ "等級" ], "operationId": "getV1GradesId" }, "put": { "summary": "更新", "description": "指定した ID の等級情報を更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている等級の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "等級ID", "type": "string", "required": true }, { "name": "putV1GradesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1GradesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/Grade" } } }, "tags": [ "等級" ], "operationId": "putV1GradesId" }, "patch": { "summary": "部分更新", "description": "指定した ID の等級情報を部分更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている等級の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "等級ID", "type": "string", "required": true }, { "name": "patchV1GradesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1GradesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Grade" } } }, "tags": [ "等級" ], "operationId": "patchV1GradesId" }, "delete": { "summary": "削除", "description": "指定した ID の等級情報を削除します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている等級の削除はできません。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "等級ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Grade" } } }, "tags": [ "等級" ], "operationId": "deleteV1GradesId" } }, "/v1/grades": { "get": { "summary": "リストの取得", "description": "等級情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Grade" } } } }, "tags": [ "等級" ], "operationId": "getV1Grades" }, "post": { "summary": "作成", "description": "等級情報を新規登録します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1Grades", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1Grades" } } ], "responses": { "201": { "description": "作成", "schema": { "$ref": "#/definitions/Grade" } } }, "tags": [ "等級" ], "operationId": "postV1Grades" } }, "/v1/job_categories/{id}": { "get": { "summary": "取得", "description": "指定した ID の職種情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "職種ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/JobCategory" } } }, "tags": [ "職種" ], "operationId": "getV1JobCategoriesId" }, "put": { "summary": "更新", "description": "指定した ID の職種情報を更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている職種の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "職種ID", "type": "string", "required": true }, { "name": "putV1JobCategoriesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1JobCategoriesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/JobCategory" } } }, "tags": [ "職種" ], "operationId": "putV1JobCategoriesId" }, "patch": { "summary": "部分更新", "description": "指定した ID の職種情報を部分更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている職種の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "職種ID", "type": "string", "required": true }, { "name": "patchV1JobCategoriesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1JobCategoriesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/JobCategory" } } }, "tags": [ "職種" ], "operationId": "patchV1JobCategoriesId" }, "delete": { "summary": "削除", "description": "指定した ID の職種情報を削除します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている職種の削除はできません。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "職種ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/JobCategory" } } }, "tags": [ "職種" ], "operationId": "deleteV1JobCategoriesId" } }, "/v1/job_categories": { "get": { "summary": "リストの取得", "description": "職種情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/JobCategory" } } } }, "tags": [ "職種" ], "operationId": "getV1JobCategories" }, "post": { "summary": "作成", "description": "職種情報を新規登録します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1JobCategories", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1JobCategories" } } ], "responses": { "201": { "description": "作成", "schema": { "$ref": "#/definitions/JobCategory" } } }, "tags": [ "職種" ], "operationId": "postV1JobCategories" } }, "/v1/recruitment_types/{id}": { "get": { "summary": "取得", "description": "指定した ID の採用区分情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "採用区分ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/RecruitmentType" } } }, "tags": [ "採用区分" ], "operationId": "getV1RecruitmentTypesId" }, "put": { "summary": "更新", "description": "指定した ID の採用区分情報を更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている採用区分の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "採用区分ID", "type": "string", "required": true }, { "name": "putV1RecruitmentTypesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1RecruitmentTypesId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/RecruitmentType" } } }, "tags": [ "採用区分" ], "operationId": "putV1RecruitmentTypesId" }, "patch": { "summary": "部分更新", "description": "指定した ID の採用区分情報を部分更新します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている採用区分の更新はできません。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "採用区分ID", "type": "string", "required": true }, { "name": "patchV1RecruitmentTypesId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1RecruitmentTypesId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/RecruitmentType" } } }, "tags": [ "採用区分" ], "operationId": "patchV1RecruitmentTypesId" }, "delete": { "summary": "削除", "description": "指定した ID の採用区分情報を削除します。\n\nなお、適用日を迎えていない従業員情報の更新が予定されている採用区分の削除はできません。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "採用区分ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/RecruitmentType" } } }, "tags": [ "採用区分" ], "operationId": "deleteV1RecruitmentTypesId" } }, "/v1/recruitment_types": { "get": { "summary": "リストの取得", "description": "採用区分情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/RecruitmentType" } } } }, "tags": [ "採用区分" ], "operationId": "getV1RecruitmentTypes" }, "post": { "summary": "作成", "description": "採用区分情報を新規登録します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1RecruitmentTypes", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1RecruitmentTypes" } } ], "responses": { "201": { "description": "作成", "schema": { "$ref": "#/definitions/RecruitmentType" } } }, "tags": [ "採用区分" ], "operationId": "postV1RecruitmentTypes" } }, "/v1/bank_account_settings": { "get": { "summary": "リストの取得", "description": "口座情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/BankAccountSetting" } } } }, "tags": [ "口座情報" ], "operationId": "getV1BankAccountSettings" } }, "/v1/tax_withholdings": { "get": { "summary": "リストの取得", "description": "源泉徴収票グループをリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/TaxWithholding" } } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "getV1TaxWithholdings" }, "post": { "summary": "登録", "description": "源泉徴収票グループを新規登録します。\nステータスは未確定で登録されます。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n\"name\": \"string\",\n\"year\": \"R02\"\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1TaxWithholdings", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1TaxWithholdings" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/TaxWithholding" } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "postV1TaxWithholdings" } }, "/v1/tax_withholdings/{id}": { "get": { "summary": "取得", "description": "指定した ID の源泉徴収票グループを取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "源泉徴収ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/TaxWithholding" } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "getV1TaxWithholdingsId" }, "put": { "summary": "更新", "description": "指定した ID の源泉徴収票グループを更新します。\nなお、確定後の源泉徴収の更新はできません。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\n```\n{\n \"name\": \"string\",\n \"year\": \"R02\",\n \"status\": \"wip\"\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "源泉徴収ID", "type": "string", "required": true }, { "name": "putV1TaxWithholdingsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1TaxWithholdingsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/TaxWithholding" } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "putV1TaxWithholdingsId" }, "patch": { "summary": "部分更新", "description": "指定した ID の源泉徴収票グループを部分更新します。\nなお、確定後の源泉徴収の更新はできません。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n(必要な項目だけにすることで部分更新が可能です）\n\n```\n{\n \"name\": \"string\",\n \"year\": \"R02\",\n \"status\": \"wip\"\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "源泉徴収ID", "type": "string", "required": true }, { "name": "patchV1TaxWithholdingsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1TaxWithholdingsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/TaxWithholding" } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "patchV1TaxWithholdingsId" }, "delete": { "summary": "削除", "description": "指定した ID の源泉徴収票グループを削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "源泉徴収ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/TaxWithholding" } } }, "tags": [ "源泉徴収票グループ" ], "operationId": "deleteV1TaxWithholdingsId" } }, "/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips": { "get": { "summary": "リストの取得", "description": "源泉徴収票情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収ID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "company" ], "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/TaxWithholdingSlip" } } } }, "tags": [ "源泉徴収票" ], "operationId": "getV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips" }, "post": { "summary": "登録", "description": "源泉徴収票情報を新規登録します。\nファイルを登録もしくは、源泉徴収票の項目を登録できます。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nファイルを登録する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"file\": {\n \"file_name\": \"file.pdf\",\n \"content\": \"base64 content\"\n }\n}\n```\n\n源泉徴収票の各項目(tax_withholding_slip_attribute)を登録する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"crew_address_literal\": \"string\",\n \"crew_position\": \"string\",\n \"crew_full_name_yomi\": \"string\",\n \"crew_full_name\": \"string\",\n \"slip_type\": \"string\",\n \"payment_amount\": 123456,\n \"payment_after_emp_income_deduction_amount\": 1234567,\n \"payment_after_income_deduction_amount\": 1234567,\n \"withholding_tax_amount\": 123456,\n \"spouse_deduction\": \"1\",\n \"spouse_deduction_sub\": \"1\",\n \"spouse_deduction_elderly\": \"1\",\n \"spouse_special_deduction_amount\": 123456,\n \"specific_dependent_count\": 9,\n \"specific_dependent_sub_count\": 9,\n \"elderly_dependent_live_together_count\": 9,\n \"elderly_dependent_count\": 9,\n \"elderly_dependent_sub_count\": 9,\n \"other_dependent_count\": 9,\n \"other_dependent_sub_count\": 9,\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"under_16_years_dependent_count\": 9,\n \"special_handicapped_dependent_live_together_count\": 9,\n \"special_handicapped_dependent_count\": 9,\n \"other_handicapped_dependent_count\": 9,\n \"non_resident_relative_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456,\n \"soc_ins_payment_amount\": 123456,\n \"life_ins_deduction_amount\": 123456,\n \"earthquake_ins_deduction_amount\": 123456,\n \"housing_loan_deduction_amount\": 123456,\n \"memo\": \"string\",\n \"new_life_ins_payment_amount\": 123456,\n \"old_life_ins_payment_amount\": 123456,\n \"care_health_payment_amount\": 123456,\n \"new_personal_pension_ins_payment_amount\": 123456,\n \"old_personal_pension_ins_payment_amount\": 123456,\n \"housing_loan_deduction_count\": 9,\n \"housing_loan_special_deduction_amount\": 123456,\n \"housing_loan_1_started_at\": \"1999-09-23\",\n \"housing_loan_1_deduction_type\": \"XXX\",\n \"housing_loan_1_deduction_balance_amount\": 123456,\n \"housing_loan_2_started_at\": \"1999-09-23\",\n \"housing_loan_2_deduction_type\": \"XXX\",\n \"housing_loan_2_deduction_balance_amount\": 123456,\n \"national_pension_payment_amount\": 123456,\n \"old_long_term_property_ins_payment_amount\": 123456,\n \"basic_deduction_amount\": 123456,\n \"income_adjustment_deduction_amount\": 123456,\n \"spouse_full_name_yomi\": \"string\",\n \"spouse_full_name\": \"string\",\n \"spouse_non_resident\": \"1\",\n \"spouse_total_income\": 123456,\n \"dependent_1_full_name_yomi\": \"string\",\n \"dependent_1_full_name\": \"string\",\n \"dependent_1_non_resident\": \"1\",\n \"dependent_under_16_years_1_full_name_yomi\": \"string\",\n \"dependent_under_16_years_1_full_name\": \"string\",\n \"dependent_under_16_years_1_non_resident\": 1,\n \"underage\": \"1\",\n \"foreigner\": \"1\",\n \"resigned_by_death\": \"1\",\n \"disaster_victim\": \"1\",\n \"column_b\": \"1\",\n \"special_handicapped\": \"1\",\n \"other_handicapped\": \"1\",\n \"widow\": \"1\",\n \"single_parent\": \"1\",\n \"working_student\": \"1\",\n \"mid_term_entered\": \"1\",\n \"mid_term_resigned\": \"1\",\n \"mid_term_entered_or_resigned_at\": \"1999-09-23\",\n \"crew_birth_at\": \"1980-09-23\",\n \"biz_establishment_address_literal\": \"string\",\n \"owner_full_name\": \"string\",\n \"biz_establishment_tel_number\": \"03-3030-3030\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR01以前の場合に有効な項目になります\n\n```\n{\n \"special_widow\": \"1\",\n \"widower\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR02以降の場合に有効な項目になります\n\n```\n{\n \"basic_deduction_amount\": 12346,\n \"income_adjustment_deduction_amount\": 123456,\n \"single_parent\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR07以降の場合に有効な項目になります。\n```\n{\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456\n}\n```\n\n控除対象扶養親族（区分）項目(dependent_N_non_resident)は、 \nR04以前の場合、「1」または「0」を指定してください。 \nR05以降の場合、「00」、「01」、「02」、「03」または「04」を指定してください。\nR07以降の場合、「00」、「01」、「02」、「03」、「04」、「10」、「11」、「20」、「21」、「30」、「31」、「40」、「41」、「50」、「51」、「60」、「61」、「70」、「71」、「80」、「81」、「90」、「91」のいずれかを指定してください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収グループID", "type": "string", "required": true }, { "name": "postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/TaxWithholdingSlip" } } }, "tags": [ "源泉徴収票" ], "operationId": "postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips" } }, "/v1/tax_withholdings/{tax_withholding_id}/tax_withholding_slips/{id}": { "get": { "summary": "取得", "description": "指定した ID の源泉徴収票情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "源泉徴収票ID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "company" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/TaxWithholdingSlip" } } }, "tags": [ "源泉徴収票" ], "operationId": "getV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" }, "put": { "summary": "更新", "description": "指定した ID の源泉徴収票情報を更新します。\n\nなお、確定後の源泉徴収票の更新はできません。\nファイルで登録されている場合はファイルを更新できます。\n源泉徴収票の各項目(tax_withholding_slip_attribute)で登録されている場合は各項目を更新できます。\nファイルとtax_withholding_slip_attribute の入れ替え更新をしたい場合は一度削除してから新規登録してください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nファイルを更新する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"file\": {\n \"file_name\": \"file.pdf\",\n \"content\": \"base64 content\"\n }\n}\n```\n\n源泉徴収票の各項目(tax_withholding_slip_attribute)を更新する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"crew_address_literal\": \"string\",\n \"crew_position\": \"string\",\n \"crew_full_name_yomi\": \"string\",\n \"crew_full_name\": \"string\",\n \"slip_type\": \"string\",\n \"payment_amount\": 123456,\n \"payment_after_emp_income_deduction_amount\": 1234567,\n \"payment_after_income_deduction_amount\": 1234567,\n \"withholding_tax_amount\": 123456,\n \"spouse_deduction\": \"1\",\n \"spouse_deduction_sub\": \"1\",\n \"spouse_deduction_elderly\": \"1\",\n \"spouse_special_deduction_amount\": 123456,\n \"specific_dependent_count\": 9,\n \"specific_dependent_sub_count\": 9,\n \"elderly_dependent_live_together_count\": 9,\n \"elderly_dependent_count\": 9,\n \"elderly_dependent_sub_count\": 9,\n \"other_dependent_count\": 9,\n \"other_dependent_sub_count\": 9,\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"under_16_years_dependent_count\": 9,\n \"special_handicapped_dependent_live_together_count\": 9,\n \"special_handicapped_dependent_count\": 9,\n \"other_handicapped_dependent_count\": 9,\n \"non_resident_relative_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456,\n \"soc_ins_payment_amount\": 123456,\n \"life_ins_deduction_amount\": 123456,\n \"earthquake_ins_deduction_amount\": 123456,\n \"housing_loan_deduction_amount\": 123456,\n \"memo\": \"string\",\n \"new_life_ins_payment_amount\": 123456,\n \"old_life_ins_payment_amount\": 123456,\n \"care_health_payment_amount\": 123456,\n \"new_personal_pension_ins_payment_amount\": 123456,\n \"old_personal_pension_ins_payment_amount\": 123456,\n \"housing_loan_deduction_count\": 9,\n \"housing_loan_special_deduction_amount\": 123456,\n \"housing_loan_1_started_at\": \"1999-09-23\",\n \"housing_loan_1_deduction_type\": \"XXX\",\n \"housing_loan_1_deduction_balance_amount\": 123456,\n \"housing_loan_2_started_at\": \"1999-09-23\",\n \"housing_loan_2_deduction_type\": \"XXX\",\n \"housing_loan_2_deduction_balance_amount\": 123456,\n \"national_pension_payment_amount\": 123456,\n \"old_long_term_property_ins_payment_amount\": 123456,\n \"basic_deduction_amount\": 123456,\n \"income_adjustment_deduction_amount\": 123456,\n \"spouse_full_name_yomi\": \"string\",\n \"spouse_full_name\": \"string\",\n \"spouse_non_resident\": \"1\",\n \"spouse_total_income\": 123456,\n \"dependent_1_full_name_yomi\": \"string\",\n \"dependent_1_full_name\": \"string\",\n \"dependent_1_non_resident\": \"1\",\n \"dependent_under_16_years_1_full_name_yomi\": \"string\",\n \"dependent_under_16_years_1_full_name\": \"string\",\n \"dependent_under_16_years_1_non_resident\": 1,\n \"underage\": \"1\",\n \"foreigner\": \"1\",\n \"resigned_by_death\": \"1\",\n \"disaster_victim\": \"1\",\n \"column_b\": \"1\",\n \"special_handicapped\": \"1\",\n \"other_handicapped\": \"1\",\n \"widow\": \"1\",\n \"single_parent\": \"1\",\n \"working_student\": \"1\",\n \"mid_term_entered\": \"1\",\n \"mid_term_resigned\": \"1\",\n \"mid_term_entered_or_resigned_at\": \"1999-09-23\",\n \"crew_birth_at\": \"1980-09-23\",\n \"biz_establishment_address_literal\": \"string\",\n \"owner_full_name\": \"string\",\n \"biz_establishment_tel_number\": \"03-3030-3030\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR01以前の場合に有効な項目になります\n\n```\n{\n \"special_widow\": \"1\",\n \"widower\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR02以降の場合に有効な項目になります\n\n```\n{\n \"basic_deduction_amount\": 12346,\n \"income_adjustment_deduction_amount\": 123456,\n \"single_parent\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR07以降の場合に有効な項目になります。\n```\n{\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456\n}\n```\n\n控除対象扶養親族（区分）項目(dependent_N_non_resident)は、 \nR04以前の場合、「1」または「0」を指定してください。 \nR05以降の場合、「00」、「01」、「02」、「03」または「04」を指定してください。\nR07以降の場合、「00」、「01」、「02」、「03」、「04」、「10」、「11」、「20」、「21」、「30」、「31」、「40」、「41」、「50」、「51」、「60」、「61」、「70」、「71」、「80」、「81」、「90」、「91」のいずれかを指定してください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収グループID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "源泉徴収票ID", "type": "string", "required": true }, { "name": "putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" } } ], "responses": { "200": { "description": "更新", "schema": { "$ref": "#/definitions/TaxWithholdingSlip" } } }, "tags": [ "源泉徴収票" ], "operationId": "putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" }, "patch": { "summary": "部分更新", "description": "指定した ID の源泉徴収票情報を部分更新します。\n\nなお、確定後の源泉徴収票の更新はできません。\nファイルで登録されている場合はファイルを更新できます。\n源泉徴収票の各項目(tax_withholding_slip_attribute)で登録されている場合は各項目を更新できます。\nファイルとtax_withholding_slip_attribute の入れ替え更新をしたい場合は一度削除してから新規登録してください。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nファイルを更新する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"file\": {\n \"file_name\": \"file.pdf\",\n \"content\": \"base64 content\"\n }\n}\n```\n\n源泉徴収票の各項目(tax_withholding_slip_attribute)を更新する場合\n\n```\n{\n \"crew_id\": \"string\",\n \"crew_address_literal\": \"string\",\n \"crew_position\": \"string\",\n \"crew_full_name_yomi\": \"string\",\n \"crew_full_name\": \"string\",\n \"slip_type\": \"string\",\n \"payment_amount\": 123456,\n \"payment_after_emp_income_deduction_amount\": 1234567,\n \"payment_after_income_deduction_amount\": 1234567,\n \"withholding_tax_amount\": 123456,\n \"spouse_deduction\": \"1\",\n \"spouse_deduction_sub\": \"1\",\n \"spouse_deduction_elderly\": \"1\",\n \"spouse_special_deduction_amount\": 123456,\n \"specific_dependent_count\": 9,\n \"specific_dependent_sub_count\": 9,\n \"elderly_dependent_live_together_count\": 9,\n \"elderly_dependent_count\": 9,\n \"elderly_dependent_sub_count\": 9,\n \"other_dependent_count\": 9,\n \"other_dependent_sub_count\": 9,\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"under_16_years_dependent_count\": 9,\n \"special_handicapped_dependent_live_together_count\": 9,\n \"special_handicapped_dependent_count\": 9,\n \"other_handicapped_dependent_count\": 9,\n \"non_resident_relative_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456,\n \"soc_ins_payment_amount\": 123456,\n \"life_ins_deduction_amount\": 123456,\n \"earthquake_ins_deduction_amount\": 123456,\n \"housing_loan_deduction_amount\": 123456,\n \"memo\": \"string\",\n \"new_life_ins_payment_amount\": 123456,\n \"old_life_ins_payment_amount\": 123456,\n \"care_health_payment_amount\": 123456,\n \"new_personal_pension_ins_payment_amount\": 123456,\n \"old_personal_pension_ins_payment_amount\": 123456,\n \"housing_loan_deduction_count\": 9,\n \"housing_loan_special_deduction_amount\": 123456,\n \"housing_loan_1_started_at\": \"1999-09-23\",\n \"housing_loan_1_deduction_type\": \"XXX\",\n \"housing_loan_1_deduction_balance_amount\": 123456,\n \"housing_loan_2_started_at\": \"1999-09-23\",\n \"housing_loan_2_deduction_type\": \"XXX\",\n \"housing_loan_2_deduction_balance_amount\": 123456,\n \"national_pension_payment_amount\": 123456,\n \"old_long_term_property_ins_payment_amount\": 123456,\n \"basic_deduction_amount\": 123456,\n \"income_adjustment_deduction_amount\": 123456,\n \"spouse_full_name_yomi\": \"string\",\n \"spouse_full_name\": \"string\",\n \"spouse_non_resident\": \"1\",\n \"spouse_total_income\": 123456,\n \"dependent_1_full_name_yomi\": \"string\",\n \"dependent_1_full_name\": \"string\",\n \"dependent_1_non_resident\": \"1\",\n \"dependent_under_16_years_1_full_name_yomi\": \"string\",\n \"dependent_under_16_years_1_full_name\": \"string\",\n \"dependent_under_16_years_1_non_resident\": 1,\n \"underage\": \"1\",\n \"foreigner\": \"1\",\n \"resigned_by_death\": \"1\",\n \"disaster_victim\": \"1\",\n \"column_b\": \"1\",\n \"special_handicapped\": \"1\",\n \"other_handicapped\": \"1\",\n \"widow\": \"1\",\n \"single_parent\": \"1\",\n \"working_student\": \"1\",\n \"mid_term_entered\": \"1\",\n \"mid_term_resigned\": \"1\",\n \"mid_term_entered_or_resigned_at\": \"1999-09-23\",\n \"crew_birth_at\": \"1980-09-23\",\n \"biz_establishment_address_literal\": \"string\",\n \"owner_full_name\": \"string\",\n \"biz_establishment_tel_number\": \"03-3030-3030\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR01以前の場合に有効な項目になります\n\n```\n{\n \"special_widow\": \"1\",\n \"widower\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR02以降の場合に有効な項目になります\n\n```\n{\n \"basic_deduction_amount\": 12346,\n \"income_adjustment_deduction_amount\": 123456,\n \"single_parent\": \"1\"\n}\n```\n\n以下の項目は源泉徴収の印字される年がR07以降の場合に有効な項目になります。\n```\n{\n \"specific_relative_dependent_count\": 9,\n \"specific_relative_dependent_sub_count\": 9,\n \"specific_relative_special_deduction_amount\": 123456\n}\n```\n\n控除対象扶養親族（区分）項目(dependent_N_non_resident)は、 \nR04以前の場合、「1」または「0」を指定してください。 \nR05以降の場合、「00」、「01」、「02」、「03」または「04」を指定してください。\nR07以降の場合、「00」、「01」、「02」、「03」、「04」、「10」、「11」、「20」、「21」、「30」、「31」、「40」、「41」、「50」、「51」、「60」、「61」、「70」、「71」、「80」、「81」、「90」、「91」のいずれかを指定してください。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収グループID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "源泉徴収票ID", "type": "string", "required": true }, { "name": "patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/TaxWithholdingSlip" } } }, "tags": [ "源泉徴収票" ], "operationId": "patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" }, "delete": { "summary": "削除", "description": "指定した ID の源泉徴収票情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "tax_withholding_id", "description": "源泉徴収ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "源泉徴収票ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/TaxWithholdingSlip" } } }, "tags": [ "源泉徴収票" ], "operationId": "deleteV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId" } }, "/v1/payrolls": { "get": { "summary": "リストの取得", "description": "給与明細グループをリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false }, { "in": "query", "name": "paid_at_from", "description": "指定した日以降の支給日で絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "paid_at_to", "description": "指定した日以前の支給日で絞り込みます", "type": "string", "format": "date", "required": false }, { "in": "query", "name": "payment_type", "description": "支給タイプで絞り込みます", "type": "string", "enum": [ "salary", "bonus" ], "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Payroll" } } } }, "tags": [ "給与明細グループ" ], "operationId": "getV1Payrolls" }, "post": { "summary": "登録", "description": "給与明細グループを新規登録します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1Payrolls", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1Payrolls" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "postV1Payrolls" } }, "/v1/payrolls/{id}": { "get": { "summary": "取得", "description": "指定した ID の給与明細グループを取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "getV1PayrollsId" }, "patch": { "summary": "部分更新", "description": "指定した ID の給与明細グループを部分更新します。\n更新できるのは 給与明細グループの名前（管理者向け）(name_for_admin), 給与明細グループの名前（従業員向け）(name_for_crew) です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true }, { "name": "patchV1PayrollsId", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1PayrollsId" } } ], "responses": { "200": { "description": "部分更新", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "patchV1PayrollsId" }, "delete": { "summary": "削除", "description": "指定した ID の給与明細グループを削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "deleteV1PayrollsId" } }, "/v1/payrolls/{id}/fix": { "patch": { "summary": "確定処理", "description": "指定した ID の給与明細グループを確定処理します。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true } ], "responses": { "200": { "description": "確定処理", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "patchV1PayrollsIdFix" } }, "/v1/payrolls/{id}/unfix": { "patch": { "summary": "確定解除処理", "description": "指定した ID の給与明細グループを未確定処理します。\n公開済みの場合は、未公開になります。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true } ], "responses": { "200": { "description": "確定解除処理", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "patchV1PayrollsIdUnfix" } }, "/v1/payrolls/{id}/publish": { "patch": { "summary": "公開処理", "description": "指定した ID の給与明細グループを公開処理します。\n公開時刻(published_at) と 公開と同時に通知を行なう(notify_with_publish)が未設定の場合は、即時公開、通知なしで公開されます。\n公開時刻に過去の日時は登録できません。\n公開時刻の予約可能な期間は、1ヶ月以内です。\n未来の公開時刻が設定されている場合は、更新可能です。\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "給与ID", "type": "string", "required": true }, { "name": "patchV1PayrollsIdPublish", "in": "body", "required": true, "schema": { "$ref": "#/definitions/patchV1PayrollsIdPublish" } } ], "responses": { "200": { "description": "公開処理", "schema": { "$ref": "#/definitions/Payroll" } } }, "tags": [ "給与明細グループ" ], "operationId": "patchV1PayrollsIdPublish" } }, "/v1/payrolls/{payroll_id}/payslips": { "get": { "summary": "リストの取得", "description": "給与明細情報をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "payroll_id", "description": "給与ID", "type": "string", "required": true }, { "in": "query", "name": "crew_id", "description": "取得したい従業員のID（カンマ区切り）", "type": "string", "required": false }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "company" ], "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/Payslip" } } } }, "tags": [ "給与明細" ], "operationId": "getV1PayrollsPayrollIdPayslips" }, "post": { "summary": "登録", "description": "給与明細情報を登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\nvalues の配列に給与明細項目の値を設定してください。\n```\n{\n \"crew_id\": \"従業員ID\",\n \"memo\": \"string\",\n \"values\": [\n { \"key\": \"支給項目1\", \"value\": \"10000\" },\n { \"key\": \"支給項目2\", \"value\": \"100000\" },\n { \"key\": \"支給項目3\", \"value\": \"200000\" },\n { \"key\": \"控除項目1\", \"value\": \"3000\" },\n { \"key\": \"控除項目2\", \"value\": \"30000\" },\n { \"key\": \"控除項目3\", \"value\": \"4000\" },\n { \"key\": \"勤怠項目1\", \"value\": \"160\" },\n { \"key\": \"勤怠項目2\", \"value\": \"20\" },\n { \"key\": \"勤怠項目3\", \"value\": \"10\" },\n { \"key\": \"合計項目1\", \"value\": \"9000000\" },\n { \"key\": \"合計項目2\", \"value\": \"5000000\" },\n { \"key\": \"合計項目3\", \"value\": \"4000000\" }\n ]\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "payroll_id", "description": "給与明細グループID", "type": "string", "required": true }, { "name": "postV1PayrollsPayrollIdPayslips", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1PayrollsPayrollIdPayslips" } } ], "responses": { "201": { "description": "登録", "schema": { "$ref": "#/definitions/Payslip" } } }, "tags": [ "給与明細" ], "operationId": "postV1PayrollsPayrollIdPayslips" } }, "/v1/payrolls/{payroll_id}/payslips/{id}": { "get": { "summary": "取得", "description": "指定した ID の給与明細情報を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "payroll_id", "description": "給与ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "給与明細ID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "company" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/Payslip" } } }, "tags": [ "給与明細" ], "operationId": "getV1PayrollsPayrollIdPayslipsId" }, "delete": { "summary": "削除", "description": "指定した ID の給与明細情報を削除します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "payroll_id", "description": "給与ID", "type": "string", "required": true }, { "in": "path", "name": "id", "description": "給与明細ID", "type": "string", "required": true } ], "responses": { "204": { "description": "(no content)", "schema": { "$ref": "#/definitions/Payslip" } } }, "tags": [ "給与明細" ], "operationId": "deleteV1PayrollsPayrollIdPayslipsId" } }, "/v1/payrolls/{payroll_id}/payslips/bulk": { "post": { "summary": "一括登録", "description": "給与明細情報を一括登録します。\n\n以下のスキーマで JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\npaysplipsのkeyに配列で従業員ごとの給与明細情報を設定してください。\n最大100件まで一括登録可能です。\n```\n{\n \"payslips\": [\n {\n \"crew_id\": \"従業員ID_1\",\n \"memo\": \"string\",\n \"values\": [\n { \"key\": \"支給項目1\", \"value\": \"10000\" },\n { \"key\": \"支給項目2\", \"value\": \"100000\" },\n { \"key\": \"支給項目3\", \"value\": \"200000\" },\n { \"key\": \"控除項目1\", \"value\": \"3000\" },\n { \"key\": \"控除項目2\", \"value\": \"30000\" },\n { \"key\": \"控除項目3\", \"value\": \"4000\" },\n { \"key\": \"勤怠項目1\", \"value\": \"160\" },\n { \"key\": \"勤怠項目2\", \"value\": \"20\" },\n { \"key\": \"勤怠項目3\", \"value\": \"10\" },\n { \"key\": \"合計項目1\", \"value\": \"9000000\" },\n { \"key\": \"合計項目2\", \"value\": \"5000000\" },\n { \"key\": \"合計項目3\", \"value\": \"4000000\" }\n ]\n },\n {\n \"crew_id\": \"従業員ID_2\",\n \"memo\": \"string\",\n \"values\": [\n { \"key\": \"支給項目1\", \"value\": \"10000\" },\n { \"key\": \"支給項目2\", \"value\": \"100000\" },\n { \"key\": \"支給項目3\", \"value\": \"200000\" },\n { \"key\": \"控除項目1\", \"value\": \"3000\" },\n { \"key\": \"控除項目2\", \"value\": \"30000\" },\n { \"key\": \"控除項目3\", \"value\": \"4000\" },\n { \"key\": \"勤怠項目1\", \"value\": \"160\" },\n { \"key\": \"勤怠項目2\", \"value\": \"20\" },\n { \"key\": \"勤怠項目3\", \"value\": \"10\" },\n { \"key\": \"合計項目1\", \"value\": \"9000000\" },\n { \"key\": \"合計項目2\", \"value\": \"5000000\" },\n { \"key\": \"合計項目3\", \"value\": \"4000000\" }\n ]\n }\n ]\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "in": "path", "name": "payroll_id", "description": "給与明細グループID", "type": "string", "required": true }, { "name": "postV1PayrollsPayrollIdPayslipsBulk", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1PayrollsPayrollIdPayslipsBulk" } } ], "responses": { "201": { "description": "一括登録", "schema": { "$ref": "#/definitions/Payslip" } } }, "tags": [ "給与明細" ], "operationId": "postV1PayrollsPayrollIdPayslipsBulk" } }, "/v1/batch_jobs": { "get": { "summary": "リストの取得", "description": "バックグラウンド処理をリストで取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "attachments" ], "required": false }, { "in": "query", "name": "sort", "description": "並び順", "type": "string", "default": "created_at", "enum": [ "created_at", "-created_at", "updated_at", "-updated_at" ], "required": false }, { "in": "query", "name": "page", "description": "Page of results to fetch.", "type": "integer", "format": "int32", "default": 1, "required": false }, { "in": "query", "name": "per_page", "description": "Number of results to return per page.", "type": "integer", "format": "int32", "default": 10, "required": false } ], "responses": { "200": { "description": "リストの取得", "schema": { "type": "array", "items": { "$ref": "#/definitions/BatchJob" } } } }, "tags": [ "バックグラウンド処理" ], "operationId": "getV1BatchJobs" } }, "/v1/batch_jobs/{id}": { "get": { "summary": "取得", "description": "指定した ID のバックグラウンド処理を取得します。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "BatchJob ID", "type": "string", "required": true }, { "in": "query", "name": "embed", "description": "埋め込むオブジェクト", "type": "string", "enum": [ "attachments" ], "required": false } ], "responses": { "200": { "description": "取得", "schema": { "$ref": "#/definitions/BatchJob" } } }, "tags": [ "バックグラウンド処理" ], "operationId": "getV1BatchJobsId" } }, "/v1/batch_jobs/job_types/crew_export": { "post": { "summary": "従業員情報ダウンロードの登録", "description": "バックグラウンド処理（従業員情報ダウンロード）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"crew_export_format_id\": \"8d155019-0a3d-4c75-ab5e-8948a0d7b423\"\n}\n```\n\n事前にカスタムダウンロードフォーマットを作成し、その ID を指定してください。ID は URL のパスより確認が可能です。\n\n例: 「/admin/crew_export_formats/8d155019-0a3d-4c75-ab5e-8948a0d7b423」であれば「8d155019-0a3d-4c75-ab5e-8948a0d7b423」\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1BatchJobsJobTypesCrewExport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1BatchJobsJobTypesCrewExport" } } ], "responses": { "201": { "description": "従業員情報ダウンロードの登録" } }, "tags": [ "バックグラウンド処理" ], "operationId": "postV1BatchJobsJobTypesCrewExport" } }, "/v1/batch_jobs/job_types/crew_import": { "post": { "summary": "従業員一括登録・更新の登録", "description": "バックグラウンド処理（従業員一括登録・更新）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"mode\": \"insert\",\n \"file\": {\n \"name\": \"sample.csv\",\n \"content\": \"5YiXMSzliJcyCmEsYgpjLGQKZSxmCg==\"\n }\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1BatchJobsJobTypesCrewImport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1BatchJobsJobTypesCrewImport" } } ], "responses": { "201": { "description": "従業員一括登録・更新の登録", "schema": { "$ref": "#/definitions/BatchJob" } } }, "tags": [ "バックグラウンド処理" ], "operationId": "postV1BatchJobsJobTypesCrewImport" } }, "/v1/batch_jobs/job_types/dependent_import": { "post": { "summary": "家族情報一括更新の登録", "description": "バックグラウンド処理（家族情報一括更新）を登録します。\n\nBODY SAMPLE と BODY SCHEMA を参考に JSON 文字列を構築してリクエストボディに詰め、リクエストヘッダーの `Content-Type` に `application/json` を指定してリクエストしてください。\n\nJSON 例\n```\n{\n \"file\": {\n \"name\": \"sample.csv\",\n \"content\": \"5YiXMSzliJcyCmEsYgpjLGQKZSxmCg==\"\n }\n}\n```\n", "produces": [ "application/json" ], "consumes": [ "application/json" ], "parameters": [ { "name": "postV1BatchJobsJobTypesDependentImport", "in": "body", "required": true, "schema": { "$ref": "#/definitions/postV1BatchJobsJobTypesDependentImport" } } ], "responses": { "201": { "description": "家族情報一括更新の登録", "schema": { "$ref": "#/definitions/BatchJob" } } }, "tags": [ "バックグラウンド処理" ], "operationId": "postV1BatchJobsJobTypesDependentImport" } }, "/v1/batch_job_attachments/{id}/file": { "get": { "summary": "ファイル取得", "description": "指定した ID のバックグラウンド処理添付ファイルを取得します。\n\n取得してから5分後にファイルは削除され、アクセスできなくなります。\n", "produces": [ "application/json" ], "parameters": [ { "in": "path", "name": "id", "description": "BatchJobAttachment ID", "type": "string", "required": true } ], "responses": { "200": { "description": "ファイル取得" } }, "tags": [ "バックグラウンド処理添付ファイル" ], "operationId": "getV1BatchJobAttachmentsIdFile" } } }, "definitions": { "CrewParams": { "type": "object", "properties": { "user_id": { "type": "string", "description": "ユーザーID" }, "biz_establishment_id": { "type": "string", "description": "事業所ID" }, "emp_code": { "type": "string", "description": "社員番号" }, "emp_type": { "type": "string", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ], "description": "雇用形態" }, "emp_status": { "type": "string", "enum": [ "employed", "absent", "retired" ], "description": "在籍状況" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "business_last_name": { "type": "string", "description": "ビジネスネーム：姓" }, "business_first_name": { "type": "string", "description": "ビジネスネーム：名" }, "business_last_name_yomi": { "type": "string", "description": "ビジネスネーム：姓（カタカナ）" }, "business_first_name_yomi": { "type": "string", "description": "ビジネスネーム：名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "gender": { "type": "string", "enum": [ "male", "female" ], "description": "戸籍上の性別" }, "tel_number": { "type": "string", "description": "電話番号" }, "address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "現住所" }, "address_head_of_family": { "type": "string", "description": "世帯主" }, "address_relation_name": { "type": "string", "description": "世帯主の続柄" }, "email": { "type": "string", "description": "メールアドレス" }, "emergency_relation_name": { "type": "string", "description": "緊急連絡先の続柄" }, "emergency_last_name": { "type": "string", "description": "緊急連絡先の姓" }, "emergency_first_name": { "type": "string", "description": "緊急連絡先の名" }, "emergency_last_name_yomi": { "type": "string", "description": "緊急連絡先の姓（カタカナ）" }, "emergency_first_name_yomi": { "type": "string", "description": "緊急連絡先の名（カタカナ）" }, "emergency_tel_number": { "type": "string", "description": "緊急連絡先の電話番号" }, "emergency_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "緊急連絡先の住所" }, "resident_card_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住民票住所" }, "resident_card_address_head_of_family": { "type": "string", "description": "住民票住所の世帯主" }, "resident_card_address_relation_name": { "type": "string", "description": "続柄（住民票住所の世帯主）" }, "position": { "type": "string", "description": "役職" }, "positions": { "type": "array", "items": { "type": "string" }, "description": "役職名" }, "grade": { "type": "string", "description": "等級名" }, "job_category": { "type": "string", "description": "職種名" }, "occupation": { "type": "string", "description": "業務内容" }, "entered_at": { "type": "string", "format": "date", "description": "入社年月日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職年月日" }, "resigned_reason": { "type": "string", "description": "退職事由" }, "recruitment_type": { "type": "string", "description": "採用区分名" }, "emp_ins_insured_person_number": { "type": "string", "description": "雇用保険の被保険者番号" }, "emp_ins_insured_person_number_unknown_reason_type": { "type": "string", "enum": [ "no_work_experience", "never_joined", "unknown" ], "description": "雇用保険の被保険者番号がない場合の理由" }, "emp_ins_qualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格取得年月日" }, "emp_ins_disqualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格喪失年月日" }, "previous_workplace": { "type": "string", "description": "雇用保険に加入していた会社名" }, "previous_employment_start_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍開始日" }, "previous_employment_end_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍終了日" }, "soc_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "厚生年金保険の被保険者整理番号" }, "hel_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "健康保険の被保険者整理番号" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "first_enrolling_in_emp_pns_ins_flag": { "type": "boolean", "description": "厚生年金初加入フラグ" }, "basic_pension_number_unknown_reason_type": { "type": "string", "enum": [ "non_pensionable", "unknown" ], "description": "基礎年金番号が不明な場合の理由" }, "first_workplace": { "type": "string", "description": "最初に厚生年金へ加入した会社名" }, "first_workplace_address_text": { "type": "string", "description": "最初に厚生年金へ加入した会社の住所文字列" }, "first_employment_start_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍開始日" }, "first_employment_end_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍終了日" }, "last_workplace": { "type": "string", "description": "最後に厚生年金へ加入した会社名" }, "last_workplace_address_text": { "type": "string", "description": "最後に厚生年金へ加入した会社の住所文字列" }, "last_employment_start_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍開始日" }, "last_employment_end_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍終了日" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の資格取得年月日" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の資格喪失年月日" }, "employees_pension_insurance_qualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格取得年月日" }, "employees_pension_insurance_disqualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格喪失年月日" }, "health_insurance_qualified_at": { "type": "string", "format": "date", "description": "健康保険の資格取得年月日" }, "health_insurance_disqualified_at": { "type": "string", "format": "date", "description": "健康保険の資格喪失年月日" }, "insurance_premium_calculation_type": { "type": "string", "enum": [ "rate", "fixed" ], "description": "給与計算機能で利用する社会保険料の設定方法" }, "health_insurance_premium_company": { "type": "integer", "format": "int32", "description": "健康保険料（会社負担分）" }, "health_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "健康保険料（本人負担分）" }, "care_insurance_premium_company": { "type": "integer", "format": "int32", "description": "介護保険料（会社負担分）" }, "care_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "介護保険料（本人負担分）" }, "child_care_support_fund_company": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（会社負担分）" }, "child_care_support_fund_individual": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（本人負担分）" }, "employees_pension_insurance_premium_company": { "type": "integer", "format": "int32", "description": "厚生年金保険料（会社負担分）" }, "employees_pension_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "厚生年金保険料（本人負担分）" }, "child_care_contribution": { "type": "integer", "format": "int32", "description": "子ども・子育て拠出金" }, "having_spouse": { "type": "boolean", "description": "配偶者の有無" }, "spouse_yearly_income": { "type": "integer", "format": "int32", "description": "配偶者の年収" }, "monthly_income_currency": { "type": "integer", "format": "int32", "description": "報酬月額（通貨）" }, "monthly_income_goods": { "type": "integer", "format": "int32", "description": "報酬月額（現物）" }, "monthly_base_salary": { "type": "integer", "format": "int32", "description": "基本給（月給）" }, "monthly_standard_income_updated_at": { "type": "string", "format": "date", "description": "標準報酬月額の改定年月" }, "monthly_standard_income_hel": { "type": "integer", "format": "int32", "description": "健康保険の標準報酬月額" }, "monthly_standard_income_pns": { "type": "integer", "format": "int32", "description": "厚生年金の標準報酬月額" }, "nearest_station_and_line": { "type": "string", "description": "通勤経路" }, "commutation_1_expenses": { "type": "integer", "format": "int32", "description": "通勤手当1の定期券代" }, "commutation_1_period": { "type": "string", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ], "description": "通勤手当1の期間" }, "commutation_1_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当1の片道運賃" }, "commutation_2_expenses": { "type": "integer", "format": "int32", "description": "通勤手当2の定期券代" }, "commutation_2_period": { "type": "string", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ], "description": "通勤手当2の期間" }, "commutation_2_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当2の片道運賃" }, "foreign_resident_last_name": { "type": "string", "description": "在留資格情報：姓" }, "foreign_resident_first_name": { "type": "string", "description": "在留資格情報：名" }, "foreign_resident_middle_name": { "type": "string", "description": "在留資格情報：ミドルネーム" }, "foreign_resident_card_number": { "type": "string", "description": "在留カード番号" }, "nationality_code": { "type": "string", "description": "国籍 / 国籍コード" }, "resident_status_type": { "type": "string", "description": "在留資格" }, "resident_status_other_reason": { "type": "string", "description": "在留資格不明理由" }, "resident_end_at": { "type": "string", "format": "date", "description": "在留期日" }, "having_ex_activity_permission": { "type": "string", "enum": [ "permitted", "none" ], "description": "資格外活動許可の有無" }, "other_be_workable_type": { "type": "string", "enum": [ "other_be_workable", "others" ], "description": "派遣・請負就労区分" }, "department": { "type": "string", "description": "部署" }, "contract_type": { "type": "string", "enum": [ "unlimited", "fixed_term" ], "description": "契約種別" }, "contract_start_on": { "type": "string", "format": "date", "description": "契約開始日" }, "contract_end_on": { "type": "string", "format": "date", "description": "契約終了日" }, "contract_renewal_type": { "type": "string", "enum": [ "renewal", "none", "auto_renewal" ], "description": "契約更新の有無" }, "tax_cd": { "type": "string", "enum": [ "kou", "otsu", "hei", "reward", "non_resident", "no_taxation_required" ], "description": "課税区分" }, "handicapped_type": { "type": "string", "enum": [ "ordinary_handicapped", "special_handicapped" ], "description": "障害者区分" }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "working_student_flag": { "type": "boolean", "description": "勤労学生フラグ" }, "school_name": { "type": "string", "description": "勤労学生：学校名" }, "enrolled_at": { "type": "string", "format": "date", "description": "勤労学生：入学年月日" }, "working_student_income": { "type": "integer", "format": "int32", "description": "勤労学生：所得の見積額" }, "employment_income_flag": { "type": "boolean", "description": "給与所得フラグ" }, "business_income_flag": { "type": "boolean", "description": "事業所得フラグ" }, "devidend_income_flag": { "type": "boolean", "description": "配当所得フラグ" }, "estate_income_flag": { "type": "boolean", "description": "不動産所得フラグ" }, "widow_type": { "type": "string", "enum": [ "widow", "single_parent" ], "description": "寡婦・ひとり親" }, "widow_reason_type": { "type": "string", "enum": [ "divorce", "bereavement", "missing", "unmarried" ], "description": "寡婦・ひとり親の理由" }, "widow_memo": { "type": "string", "description": "寡婦・ひとり親の備考" }, "employment_type_id": { "type": "string", "description": "雇用形態のID" }, "department_ids": { "type": "array", "items": { "type": "string" }, "description": "所属する部署のID" }, "payment_period_id": { "type": "string", "description": "給与支給形態" }, "profile_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "プロフィール画像" }, "resume1": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "履歴書・職務経歴書1" }, "resume2": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "履歴書・職務経歴書2" }, "identity_card_image1": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "本人確認書類1" }, "identity_card_image2": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "本人確認書類2" }, "address_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "住所を確認できる書類" }, "emp_ins_insured_person_number_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "雇用保険被保険者番号添付画像" }, "basic_pension_number_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "基礎年金番号添付画像" }, "foreign_resident_card_image1": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "在留カード（特定在留カード）の画像1" }, "foreign_resident_card_image2": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "在留カード（特定在留カード）の画像2" }, "handicapped_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "障害者手帳の画像" }, "student_card_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "勤労学生：学生証の画像" }, "bank_accounts": { "type": "array", "items": { "$ref": "#/definitions/BankAccount" }, "description": "口座情報" }, "custom_fields": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomFieldParam" }, "description": "カスタム項目" } }, "required": [ "emp_status", "last_name", "first_name", "last_name_yomi", "first_name_yomi", "gender", "recruitment_type" ] }, "Address": { "type": "object", "properties": { "country_number": { "type": "string", "description": "国コード" }, "zip_code": { "type": "string", "description": "郵便番号" }, "pref": { "type": "string", "description": "都道府県" }, "city": { "type": "string", "description": "市区町村" }, "street": { "type": "string", "description": "丁目・番地" }, "building": { "type": "string", "description": "建物名・部屋番号" }, "literal_yomi": { "type": "string", "description": "ヨミガナ" } }, "required": [ "city" ] }, "AttachmentParams": { "type": "object", "properties": { "file_name": { "type": "string", "description": "ファイル名" }, "content": { "type": "string", "description": "登録したいデータを Base64 エンコードした文字列。ファイル（エンコード前）の最大サイズは 10MB で、次の拡張子のファイルを受け付けます: png, jpeg (jpg), pdf, text (txt), csv, conf, log, docx (doc), xlsx (xls), gif" } } }, "BankAccount": { "type": "object", "properties": { "bank_code": { "type": "string", "description": "銀行コード" }, "bank_branch_code": { "type": "string", "description": "支店コード" }, "account_type": { "type": "string", "enum": [ "saving", "checking", "deposit" ], "description": "預金種別" }, "account_number": { "type": "string", "description": "口座番号" }, "account_holder_name": { "type": "string", "description": "名義（カタカナ）" }, "transfer_type": { "type": "string", "enum": [ "full", "specified", "remaining" ], "description": "支給区分" }, "specified_transfer_amount": { "type": "integer", "format": "int32", "description": "固定額" }, "transfer_category": { "type": "string", "enum": [ "salary_and_bonus", "salary", "bonus" ], "description": "支給種別" }, "bankbook_image": { "allOf": [ { "$ref": "#/definitions/AttachmentParams" } ], "description": "口座情報を確認できる画像" }, "bank_account_setting_id": { "type": "string", "description": "口座設定ID" } }, "required": [ "bank_code", "bank_branch_code", "account_type", "account_number", "account_holder_name" ] }, "Attachment": { "type": "object", "properties": { "file_name": { "type": "string", "description": "ファイル名" }, "url": { "type": "string", "description": "URL" } } }, "CrewCustomFieldParam": { "type": "object", "properties": { "value": { "type": "string", "description": "設定値。テンプレート種別に応じた形式になります。" }, "template_id": { "type": "string", "description": "設定先のテンプレートID" }, "file_name": { "type": "string", "description": "テンプレート種別がファイルの場合のファイル名" } }, "required": [ "template_id" ] }, "CrewCustomFieldTemplateGroupParams": { "type": "object", "properties": { "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ], "description": "アクセス種別" } }, "required": [ "name" ] }, "CrewCustomFieldTemplateParams": { "type": "object", "properties": { "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "enum": [ "date", "decimal", "enum", "file", "string", "text" ], "description": "入力タイプ" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" }, "description": "ドロップダウンリスト項目" }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "name", "type", "group_id", "position" ] }, "CrewCustomEnumFieldTemplateElement": { "type": "object", "properties": { "id": { "type": "string", "description": "ドロップダウンリスト項目ID" }, "name": { "type": "string", "description": "名称" }, "physical_name": { "type": "string", "description": "物理名称" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "id", "name", "position" ] }, "Crew": { "type": "object", "properties": { "id": { "type": "string", "description": "従業員ID" }, "user_id": { "type": "string", "description": "ユーザーID" }, "biz_establishment_id": { "type": "string", "description": "事業所ID" }, "emp_code": { "type": "string", "description": "社員番号" }, "emp_type": { "type": "string", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ], "description": "雇用形態" }, "employment_type": { "allOf": [ { "$ref": "#/definitions/EmploymentTypeForCrew" } ], "description": "雇用形態" }, "emp_status": { "type": "string", "enum": [ "employed", "absent", "retired" ], "description": "在籍状況" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "business_last_name": { "type": "string", "description": "ビジネスネーム：姓" }, "business_first_name": { "type": "string", "description": "ビジネスネーム：名" }, "business_last_name_yomi": { "type": "string", "description": "ビジネスネーム：姓（カタカナ）" }, "business_first_name_yomi": { "type": "string", "description": "ビジネスネーム：名（カタカナ）" }, "preferred_last_name": { "type": "string", "description": "ビジネスネーム優先：姓" }, "preferred_first_name": { "type": "string", "description": "ビジネスネーム優先：名" }, "preferred_last_name_yomi": { "type": "string", "description": "ビジネスネーム優先：姓（カタカナ）" }, "preferred_first_name_yomi": { "type": "string", "description": "ビジネスネーム優先：名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "gender": { "type": "string", "enum": [ "male", "female" ], "description": "戸籍上の性別" }, "identity_card_image1": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "本人確認書類1" }, "identity_card_image2": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "本人確認書類2" }, "tel_number": { "type": "string", "description": "電話番号" }, "address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "現住所" }, "address_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "現住所を確認できる書類" }, "address_head_of_family": { "type": "string", "description": "世帯主" }, "address_relation_name": { "type": "string", "description": "世帯主の続柄" }, "email": { "type": "string", "description": "メールアドレス" }, "profile_images": { "type": "array", "items": { "$ref": "#/definitions/Image" }, "description": "プロフィール画像" }, "emergency_relation_name": { "type": "string", "description": "緊急連絡先の続柄" }, "emergency_last_name": { "type": "string", "description": "緊急連絡先の姓" }, "emergency_first_name": { "type": "string", "description": "緊急連絡先の名" }, "emergency_last_name_yomi": { "type": "string", "description": "緊急連絡先の姓（カタカナ）" }, "emergency_first_name_yomi": { "type": "string", "description": "緊急連絡先の名（カタカナ）" }, "emergency_tel_number": { "type": "string", "description": "緊急連絡先の電話番号" }, "emergency_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "緊急連絡先の住所" }, "resident_card_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住民票住所" }, "resident_card_address_head_of_family": { "type": "string", "description": "住民票住所の世帯主" }, "resident_card_address_relation_name": { "type": "string", "description": "続柄（住民票住所の世帯主）" }, "position": { "type": "string", "description": "役職" }, "positions": { "type": "array", "items": { "$ref": "#/definitions/Position" }, "description": "役職" }, "grade": { "allOf": [ { "$ref": "#/definitions/Grade" } ], "description": "等級" }, "job_category": { "allOf": [ { "$ref": "#/definitions/JobCategory" } ], "description": "職種" }, "occupation": { "type": "string", "description": "業務内容" }, "entered_at": { "type": "string", "format": "date", "description": "入社年月日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職年月日" }, "resigned_reason": { "type": "string", "description": "退職事由" }, "recruitment_type": { "allOf": [ { "$ref": "#/definitions/RecruitmentType" } ], "description": "採用区分" }, "resume1": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "履歴書・職務経歴書1" }, "resume2": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "履歴書・職務経歴書2" }, "emp_ins_insured_person_number": { "type": "string", "description": "雇用保険の被保険者番号" }, "emp_ins_insured_person_number_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "雇用保険被保険者番号添付画像" }, "emp_ins_insured_person_number_unknown_reason_type": { "type": "string", "enum": [ "no_work_experience", "never_joined", "unknown" ], "description": "雇用保険の被保険者番号がない場合の理由" }, "emp_ins_qualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格取得年月日" }, "emp_ins_disqualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格喪失年月日" }, "previous_workplace": { "type": "string", "description": "雇用保険に加入していた会社名" }, "previous_employment_start_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍開始日" }, "previous_employment_end_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍終了日" }, "soc_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "厚生年金保険の被保険者整理番号" }, "hel_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "健康保険の被保険者整理番号" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "basic_pension_number_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "基礎年金番号添付画像" }, "first_enrolling_in_emp_pns_ins_flag": { "type": "boolean", "description": "厚生年金初加入フラグ" }, "basic_pension_number_unknown_reason_type": { "type": "string", "enum": [ "non_pensionable", "unknown" ], "description": "基礎年金番号が不明な場合の理由" }, "first_workplace": { "type": "string", "description": "最初に厚生年金へ加入した会社名" }, "first_workplace_address_text": { "type": "string", "description": "最初に厚生年金へ加入した会社の住所文字列" }, "first_employment_start_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍開始日" }, "first_employment_end_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍終了日" }, "last_workplace": { "type": "string", "description": "最後に厚生年金へ加入した会社名" }, "last_workplace_address_text": { "type": "string", "description": "最後に厚生年金へ加入した会社の住所文字列" }, "last_employment_start_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍開始日" }, "last_employment_end_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍終了日" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の資格取得年月日" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の資格喪失年月日" }, "employees_pension_insurance_qualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格取得年月日" }, "employees_pension_insurance_disqualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格喪失年月日" }, "health_insurance_qualified_at": { "type": "string", "format": "date", "description": "健康保険の資格取得年月日" }, "health_insurance_disqualified_at": { "type": "string", "format": "date", "description": "健康保険の資格喪失年月日" }, "insurance_premium_calculation_type": { "type": "string", "enum": [ "rate", "fixed" ], "description": "給与計算機能で利用する社会保険料の設定方法" }, "health_insurance_premium_company": { "type": "integer", "format": "int32", "description": "健康保険料（会社負担分）" }, "health_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "健康保険料（本人負担分）" }, "care_insurance_premium_company": { "type": "integer", "format": "int32", "description": "介護保険料（会社負担分）" }, "care_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "介護保険料（本人負担分）" }, "child_care_support_fund_company": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（会社負担分）" }, "child_care_support_fund_individual": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（本人負担分）" }, "employees_pension_insurance_premium_company": { "type": "integer", "format": "int32", "description": "厚生年金保険料（会社負担分）" }, "employees_pension_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "厚生年金保険料（本人負担分）" }, "child_care_contribution": { "type": "integer", "format": "int32", "description": "子ども・子育て拠出金" }, "having_spouse": { "type": "boolean", "description": "配偶者の有無" }, "spouse_yearly_income": { "type": "integer", "format": "int32", "description": "配偶者の年収" }, "monthly_income_currency": { "type": "integer", "format": "int32", "description": "報酬月額（通貨）" }, "monthly_income_goods": { "type": "integer", "format": "int32", "description": "報酬月額（現物）" }, "payment_period": { "allOf": [ { "$ref": "#/definitions/PaymentPeriodForCrew" } ], "description": "給与支給形態" }, "monthly_base_salary": { "type": "integer", "format": "int32", "description": "基本給（月給）" }, "monthly_standard_income_updated_at": { "type": "string", "format": "date", "description": "標準報酬月額の改定年月" }, "monthly_standard_income_hel": { "type": "integer", "format": "int32", "description": "健康保険の標準報酬月額" }, "monthly_standard_income_pns": { "type": "integer", "format": "int32", "description": "厚生年金の標準報酬月額" }, "nearest_station_and_line": { "type": "string", "description": "通勤経路" }, "commutation_1_expenses": { "type": "integer", "format": "int32", "description": "通勤手当1の定期券代" }, "commutation_1_period": { "type": "string", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ], "description": "通勤手当1の期間" }, "commutation_1_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当1の片道運賃" }, "commutation_2_expenses": { "type": "integer", "format": "int32", "description": "通勤手当2の定期券代" }, "commutation_2_period": { "type": "string", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ], "description": "通勤手当2の期間" }, "commutation_2_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当2の片道運賃" }, "foreign_resident_last_name": { "type": "string", "description": "在留資格情報：姓" }, "foreign_resident_first_name": { "type": "string", "description": "在留資格情報：名" }, "foreign_resident_middle_name": { "type": "string", "description": "在留資格情報：ミドルネーム" }, "foreign_resident_card_number": { "type": "string", "description": "在留カード番号" }, "foreign_resident_card_image1": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "在留カード（特定在留カード）の画像1" }, "foreign_resident_card_image2": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "在留カード（特定在留カード）の画像2" }, "nationality_code": { "type": "string", "description": "国籍 / 国籍コード" }, "resident_status_type": { "type": "string", "description": "在留資格" }, "resident_status_other_reason": { "type": "string", "description": "在留資格不明理由" }, "resident_end_at": { "type": "string", "format": "date", "description": "在留期日" }, "having_ex_activity_permission": { "type": "string", "enum": [ "permitted", "none" ], "description": "資格外活動許可の有無" }, "other_be_workable_type": { "type": "string", "enum": [ "other_be_workable", "others" ], "description": "派遣・請負就労区分" }, "bank_accounts": { "type": "array", "items": { "$ref": "#/definitions/BankAccount" }, "description": "口座情報" }, "department": { "type": "string", "description": "部署" }, "departments": { "type": "array", "items": { "$ref": "#/definitions/Department" }, "description": "部署" }, "contract_type": { "type": "string", "enum": [ "unlimited", "fixed_term" ], "description": "契約種別" }, "contract_start_on": { "type": "string", "format": "date", "description": "契約開始日" }, "contract_end_on": { "type": "string", "format": "date", "description": "契約終了日" }, "contract_renewal_type": { "type": "string", "enum": [ "renewal", "none", "auto_renewal" ], "description": "契約更新の有無" }, "tax_cd": { "type": "string", "enum": [ "kou", "otsu", "hei", "reward", "non_resident", "no_taxation_required" ], "description": "課税区分" }, "handicapped_type": { "type": "string", "enum": [ "ordinary_handicapped", "special_handicapped" ], "description": "障害者区分" }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "handicapped_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "障害者手帳の画像" }, "working_student_flag": { "type": "boolean", "description": "勤労学生フラグ" }, "school_name": { "type": "string", "description": "勤労学生：学校名" }, "student_card_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "勤労学生：学生証の画像" }, "enrolled_at": { "type": "string", "format": "date", "description": "勤労学生：入学年月日" }, "working_student_income": { "type": "integer", "format": "int32", "description": "勤労学生：所得の見積額" }, "employment_income_flag": { "type": "boolean", "description": "給与所得フラグ" }, "business_income_flag": { "type": "boolean", "description": "事業所得フラグ" }, "devidend_income_flag": { "type": "boolean", "description": "配当所得フラグ" }, "estate_income_flag": { "type": "boolean", "description": "不動産所得フラグ" }, "widow_type": { "type": "string", "enum": [ "widow", "single_parent" ], "description": "寡婦・ひとり親" }, "widow_reason_type": { "type": "string", "enum": [ "divorce", "bereavement", "missing", "unmarried" ], "description": "寡婦・ひとり親の理由" }, "widow_memo": { "type": "string", "description": "寡婦・ひとり親の備考" }, "custom_fields": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomField" }, "description": "カスタム項目" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "id", "emp_status", "last_name", "first_name", "last_name_yomi", "first_name_yomi", "gender", "recruitment_type" ], "description": "Crew model" }, "EmploymentTypeForCrew": { "type": "object", "properties": { "id": { "type": "string", "description": "雇用形態ID" }, "name": { "type": "string", "description": "名称" }, "preset_type": { "type": "string", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ], "description": "プリセット種別" }, "code": { "type": "string", "description": "雇用形態コード" } }, "required": [ "name" ] }, "Image": { "type": "object", "properties": { "size_type": { "type": "string", "enum": [ "thumb", "small", "medium", "large", "original" ], "description": "サイズ種別" }, "height": { "type": "integer", "format": "int32", "description": "高さ" }, "width": { "type": "integer", "format": "int32", "description": "幅" }, "url": { "type": "string", "description": "URL（有効期限付き）" } } }, "Position": { "type": "object", "properties": { "id": { "type": "string", "description": "役職ID" }, "name": { "type": "string", "description": "役職の名前" }, "rank": { "type": "integer", "format": "int32", "description": "役職のランク (1 ~ 99999)" }, "code": { "type": "string", "description": "役職コード)" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "created_at" ] }, "Grade": { "type": "object", "properties": { "id": { "type": "string", "description": "等級ID" }, "name": { "type": "string", "description": "名称" }, "rank": { "type": "integer", "format": "int32", "description": "ランク (1 ~ 99999)" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "description": "Grade model" }, "JobCategory": { "type": "object", "properties": { "id": { "type": "string", "description": "職種ID" }, "name": { "type": "string", "description": "名称" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "description": "JobCategory model" }, "RecruitmentType": { "type": "object", "properties": { "id": { "type": "string", "description": "採用区分ID" }, "name": { "type": "string", "description": "名称" }, "preset_type": { "type": "string", "enum": [ "new_graduate", "mid_career", "part_time", "full_time_conversion", "rehire" ], "description": "プリセット種別" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "name" ], "description": "RecruitmentType model" }, "PaymentPeriodForCrew": { "type": "object", "properties": { "id": { "type": "string", "description": "給与支給形態ID" }, "name": { "type": "string", "description": "名称" }, "period_type": { "type": "string", "enum": [ "monthly", "weekly", "daily", "hourly", "etc" ], "description": "支払い期間種別" } }, "required": [ "id" ] }, "Department": { "type": "object", "properties": { "id": { "type": "string", "description": "部署ID" }, "name": { "type": "string", "description": "名称" }, "full_name": { "type": "string", "description": "部署名称(上位階層含む)" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "code": { "type": "string", "description": "コード" }, "parent": { "allOf": [ { "$ref": "#/definitions/DepartmentNested" } ], "description": "親の部署" }, "children": { "type": "array", "items": { "$ref": "#/definitions/Department" }, "description": "子の部署" }, "company_id": { "type": "string", "description": "会社ID" }, "company": { "allOf": [ { "$ref": "#/definitions/Company" } ], "description": "会社" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "name", "position", "updated_at", "created_at" ], "description": "Department model" }, "DepartmentNested": { "type": "object", "properties": { "id": { "type": "string", "description": "部署ID" }, "name": { "type": "string", "description": "名称" }, "full_name": { "type": "string", "description": "部署名称(上位階層含む)" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "code": { "type": "string", "description": "コード" }, "parent": { "allOf": [ { "$ref": "#/definitions/DepartmentNested" } ], "description": "親の部署" }, "company_id": { "type": "string", "description": "会社ID" } }, "required": [ "id", "name", "position" ] }, "Company": { "type": "object", "properties": { "id": { "type": "string", "description": "会社ID" }, "name": { "type": "string", "description": "名称" }, "code": { "type": "string", "description": "会社コード" }, "corporate_number": { "type": "string", "description": "法人番号" }, "address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住所" }, "tel_number": { "type": "string", "description": "電話番号" }, "owner_id": { "type": "string", "description": "代表者ID" }, "owner": { "allOf": [ { "$ref": "#/definitions/Crew" } ], "description": "代表者" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "name" ], "description": "Company model" }, "CrewCustomField": { "type": "object", "properties": { "value": { "type": "string", "description": "設定値。テンプレート種別に応じた形式になります。" }, "template": { "allOf": [ { "$ref": "#/definitions/CrewCustomFieldTemplateNested" } ], "description": "カスタム項目テンプレート" } } }, "CrewCustomFieldTemplateNested": { "type": "object", "properties": { "id": { "type": "string", "description": "カスタム従業員項目ID" }, "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "enum": [ "date", "decimal", "enum", "file", "string", "text" ], "description": "入力タイプ" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" }, "description": "ドロップダウンリスト項目" }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "name", "type", "group_id", "position", "updated_at", "created_at" ] }, "postV1Crews": { "type": "object", "properties": { "emp_status": { "type": "string", "description": "在籍状況", "enum": [ "employed", "absent", "retired" ] }, "user_id": { "type": "string", "description": "ユーザーID" }, "biz_establishment_id": { "type": "string", "description": "事業所ID" }, "emp_code": { "type": "string", "description": "社員番号" }, "emp_type": { "type": "string", "description": "雇用形態", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ] }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "business_last_name": { "type": "string", "description": "ビジネスネーム：姓" }, "business_first_name": { "type": "string", "description": "ビジネスネーム：名" }, "business_last_name_yomi": { "type": "string", "description": "ビジネスネーム：姓（カタカナ）" }, "business_first_name_yomi": { "type": "string", "description": "ビジネスネーム：名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "gender": { "type": "string", "description": "戸籍上の性別", "enum": [ "male", "female" ] }, "tel_number": { "type": "string", "description": "電話番号" }, "address": { "$ref": "#/definitions/Address", "description": "現住所" }, "address_head_of_family": { "type": "string", "description": "世帯主" }, "address_relation_name": { "type": "string", "description": "世帯主の続柄" }, "email": { "type": "string", "description": "メールアドレス" }, "emergency_relation_name": { "type": "string", "description": "緊急連絡先の続柄" }, "emergency_last_name": { "type": "string", "description": "緊急連絡先の姓" }, "emergency_first_name": { "type": "string", "description": "緊急連絡先の名" }, "emergency_last_name_yomi": { "type": "string", "description": "緊急連絡先の姓（カタカナ）" }, "emergency_first_name_yomi": { "type": "string", "description": "緊急連絡先の名（カタカナ）" }, "emergency_tel_number": { "type": "string", "description": "緊急連絡先の電話番号" }, "emergency_address": { "$ref": "#/definitions/Address", "description": "緊急連絡先の住所" }, "resident_card_address": { "$ref": "#/definitions/Address", "description": "住民票住所" }, "resident_card_address_head_of_family": { "type": "string", "description": "住民票住所の世帯主" }, "resident_card_address_relation_name": { "type": "string", "description": "続柄（住民票住所の世帯主）" }, "position": { "type": "string", "description": "役職" }, "positions": { "type": "array", "description": "役職名", "items": { "type": "string" } }, "grade": { "type": "string", "description": "等級名" }, "job_category": { "type": "string", "description": "職種名" }, "occupation": { "type": "string", "description": "業務内容" }, "entered_at": { "type": "string", "format": "date", "description": "入社年月日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職年月日" }, "resigned_reason": { "type": "string", "description": "退職事由" }, "recruitment_type": { "type": "string", "description": "採用区分名" }, "emp_ins_insured_person_number": { "type": "string", "description": "雇用保険の被保険者番号" }, "emp_ins_insured_person_number_unknown_reason_type": { "type": "string", "description": "雇用保険の被保険者番号がない場合の理由", "enum": [ "no_work_experience", "never_joined", "unknown" ] }, "emp_ins_qualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格取得年月日" }, "emp_ins_disqualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格喪失年月日" }, "previous_workplace": { "type": "string", "description": "雇用保険に加入していた会社名" }, "previous_employment_start_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍開始日" }, "previous_employment_end_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍終了日" }, "soc_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "厚生年金保険の被保険者整理番号" }, "hel_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "健康保険の被保険者整理番号" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "first_enrolling_in_emp_pns_ins_flag": { "type": "boolean", "description": "厚生年金初加入フラグ" }, "basic_pension_number_unknown_reason_type": { "type": "string", "description": "基礎年金番号が不明な場合の理由", "enum": [ "non_pensionable", "unknown" ] }, "first_workplace": { "type": "string", "description": "最初に厚生年金へ加入した会社名" }, "first_workplace_address_text": { "type": "string", "description": "最初に厚生年金へ加入した会社の住所文字列" }, "first_employment_start_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍開始日" }, "first_employment_end_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍終了日" }, "last_workplace": { "type": "string", "description": "最後に厚生年金へ加入した会社名" }, "last_workplace_address_text": { "type": "string", "description": "最後に厚生年金へ加入した会社の住所文字列" }, "last_employment_start_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍開始日" }, "last_employment_end_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍終了日" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の資格取得年月日" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の資格喪失年月日" }, "employees_pension_insurance_qualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格取得年月日" }, "employees_pension_insurance_disqualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格喪失年月日" }, "health_insurance_qualified_at": { "type": "string", "format": "date", "description": "健康保険の資格取得年月日" }, "health_insurance_disqualified_at": { "type": "string", "format": "date", "description": "健康保険の資格喪失年月日" }, "insurance_premium_calculation_type": { "type": "string", "description": "給与計算機能で利用する社会保険料の設定方法", "enum": [ "rate", "fixed" ] }, "health_insurance_premium_company": { "type": "integer", "format": "int32", "description": "健康保険料（会社負担分）" }, "health_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "健康保険料（本人負担分）" }, "care_insurance_premium_company": { "type": "integer", "format": "int32", "description": "介護保険料（会社負担分）" }, "care_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "介護保険料（本人負担分）" }, "child_care_support_fund_company": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（会社負担分）" }, "child_care_support_fund_individual": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（本人負担分）" }, "employees_pension_insurance_premium_company": { "type": "integer", "format": "int32", "description": "厚生年金保険料（会社負担分）" }, "employees_pension_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "厚生年金保険料（本人負担分）" }, "child_care_contribution": { "type": "integer", "format": "int32", "description": "子ども・子育て拠出金" }, "having_spouse": { "type": "boolean", "description": "配偶者の有無" }, "spouse_yearly_income": { "type": "integer", "format": "int32", "description": "配偶者の年収" }, "monthly_income_currency": { "type": "integer", "format": "int32", "description": "報酬月額（通貨）" }, "monthly_income_goods": { "type": "integer", "format": "int32", "description": "報酬月額（現物）" }, "monthly_base_salary": { "type": "integer", "format": "int32", "description": "基本給（月給）" }, "monthly_standard_income_updated_at": { "type": "string", "format": "date", "description": "標準報酬月額の改定年月" }, "monthly_standard_income_hel": { "type": "integer", "format": "int32", "description": "健康保険の標準報酬月額" }, "monthly_standard_income_pns": { "type": "integer", "format": "int32", "description": "厚生年金の標準報酬月額" }, "nearest_station_and_line": { "type": "string", "description": "通勤経路" }, "commutation_1_expenses": { "type": "integer", "format": "int32", "description": "通勤手当1の定期券代" }, "commutation_1_period": { "type": "string", "description": "通勤手当1の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_1_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当1の片道運賃" }, "commutation_2_expenses": { "type": "integer", "format": "int32", "description": "通勤手当2の定期券代" }, "commutation_2_period": { "type": "string", "description": "通勤手当2の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_2_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当2の片道運賃" }, "foreign_resident_last_name": { "type": "string", "description": "在留資格情報：姓" }, "foreign_resident_first_name": { "type": "string", "description": "在留資格情報：名" }, "foreign_resident_middle_name": { "type": "string", "description": "在留資格情報：ミドルネーム" }, "foreign_resident_card_number": { "type": "string", "description": "在留カード番号" }, "nationality_code": { "type": "string", "description": "国籍 / 国籍コード" }, "resident_status_type": { "type": "string", "description": "在留資格" }, "resident_status_other_reason": { "type": "string", "description": "在留資格不明理由" }, "resident_end_at": { "type": "string", "format": "date", "description": "在留期日" }, "having_ex_activity_permission": { "type": "string", "description": "資格外活動許可の有無", "enum": [ "permitted", "none" ] }, "other_be_workable_type": { "type": "string", "description": "派遣・請負就労区分", "enum": [ "other_be_workable", "others" ] }, "department": { "type": "string", "description": "部署" }, "contract_type": { "type": "string", "description": "契約種別", "enum": [ "unlimited", "fixed_term" ] }, "contract_start_on": { "type": "string", "format": "date", "description": "契約開始日" }, "contract_end_on": { "type": "string", "format": "date", "description": "契約終了日" }, "contract_renewal_type": { "type": "string", "description": "契約更新の有無", "enum": [ "renewal", "none", "auto_renewal" ] }, "tax_cd": { "type": "string", "description": "課税区分", "enum": [ "kou", "otsu", "hei", "reward", "non_resident", "no_taxation_required" ] }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "working_student_flag": { "type": "boolean", "description": "勤労学生フラグ" }, "school_name": { "type": "string", "description": "勤労学生：学校名" }, "enrolled_at": { "type": "string", "format": "date", "description": "勤労学生：入学年月日" }, "working_student_income": { "type": "integer", "format": "int32", "description": "勤労学生：所得の見積額" }, "employment_income_flag": { "type": "boolean", "description": "給与所得フラグ" }, "business_income_flag": { "type": "boolean", "description": "事業所得フラグ" }, "devidend_income_flag": { "type": "boolean", "description": "配当所得フラグ" }, "estate_income_flag": { "type": "boolean", "description": "不動産所得フラグ" }, "widow_type": { "type": "string", "description": "寡婦・ひとり親", "enum": [ "widow", "single_parent" ] }, "widow_reason_type": { "type": "string", "description": "寡婦・ひとり親の理由", "enum": [ "divorce", "bereavement", "missing", "unmarried" ] }, "widow_memo": { "type": "string", "description": "寡婦・ひとり親の備考" }, "employment_type_id": { "type": "string", "description": "雇用形態のID" }, "department_ids": { "type": "array", "description": "所属する部署のID", "items": { "type": "string" } }, "payment_period_id": { "type": "string", "description": "給与支給形態" }, "profile_image": { "$ref": "#/definitions/AttachmentParams", "description": "プロフィール画像" }, "resume1": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書1" }, "resume2": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書2" }, "identity_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類1" }, "identity_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類2" }, "address_image": { "$ref": "#/definitions/AttachmentParams", "description": "住所を確認できる書類" }, "emp_ins_insured_person_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "雇用保険被保険者番号添付画像" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号添付画像" }, "foreign_resident_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像1" }, "foreign_resident_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像2" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "student_card_image": { "$ref": "#/definitions/AttachmentParams", "description": "勤労学生：学生証の画像" }, "bank_accounts": { "type": "array", "description": "口座情報", "items": { "$ref": "#/definitions/BankAccount" } }, "custom_fields": { "type": "array", "description": "カスタム項目", "items": { "$ref": "#/definitions/CrewCustomFieldParam" } } }, "required": [ "emp_status", "last_name", "first_name", "last_name_yomi", "first_name_yomi", "gender" ], "description": "登録" }, "putV1CrewsId": { "type": "object", "properties": { "emp_status": { "type": "string", "description": "在籍状況", "enum": [ "employed", "absent", "retired" ] }, "user_id": { "type": "string", "description": "ユーザーID" }, "biz_establishment_id": { "type": "string", "description": "事業所ID" }, "emp_code": { "type": "string", "description": "社員番号" }, "emp_type": { "type": "string", "description": "雇用形態", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ] }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "business_last_name": { "type": "string", "description": "ビジネスネーム：姓" }, "business_first_name": { "type": "string", "description": "ビジネスネーム：名" }, "business_last_name_yomi": { "type": "string", "description": "ビジネスネーム：姓（カタカナ）" }, "business_first_name_yomi": { "type": "string", "description": "ビジネスネーム：名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "gender": { "type": "string", "description": "戸籍上の性別", "enum": [ "male", "female" ] }, "tel_number": { "type": "string", "description": "電話番号" }, "address": { "$ref": "#/definitions/Address", "description": "現住所" }, "address_head_of_family": { "type": "string", "description": "世帯主" }, "address_relation_name": { "type": "string", "description": "世帯主の続柄" }, "email": { "type": "string", "description": "メールアドレス" }, "emergency_relation_name": { "type": "string", "description": "緊急連絡先の続柄" }, "emergency_last_name": { "type": "string", "description": "緊急連絡先の姓" }, "emergency_first_name": { "type": "string", "description": "緊急連絡先の名" }, "emergency_last_name_yomi": { "type": "string", "description": "緊急連絡先の姓（カタカナ）" }, "emergency_first_name_yomi": { "type": "string", "description": "緊急連絡先の名（カタカナ）" }, "emergency_tel_number": { "type": "string", "description": "緊急連絡先の電話番号" }, "emergency_address": { "$ref": "#/definitions/Address", "description": "緊急連絡先の住所" }, "resident_card_address": { "$ref": "#/definitions/Address", "description": "住民票住所" }, "resident_card_address_head_of_family": { "type": "string", "description": "住民票住所の世帯主" }, "resident_card_address_relation_name": { "type": "string", "description": "続柄（住民票住所の世帯主）" }, "position": { "type": "string", "description": "役職" }, "positions": { "type": "array", "description": "役職名", "items": { "type": "string" } }, "grade": { "type": "string", "description": "等級名" }, "job_category": { "type": "string", "description": "職種名" }, "occupation": { "type": "string", "description": "業務内容" }, "entered_at": { "type": "string", "format": "date", "description": "入社年月日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職年月日" }, "resigned_reason": { "type": "string", "description": "退職事由" }, "recruitment_type": { "type": "string", "description": "採用区分名" }, "emp_ins_insured_person_number": { "type": "string", "description": "雇用保険の被保険者番号" }, "emp_ins_insured_person_number_unknown_reason_type": { "type": "string", "description": "雇用保険の被保険者番号がない場合の理由", "enum": [ "no_work_experience", "never_joined", "unknown" ] }, "emp_ins_qualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格取得年月日" }, "emp_ins_disqualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格喪失年月日" }, "previous_workplace": { "type": "string", "description": "雇用保険に加入していた会社名" }, "previous_employment_start_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍開始日" }, "previous_employment_end_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍終了日" }, "soc_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "厚生年金保険の被保険者整理番号" }, "hel_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "健康保険の被保険者整理番号" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "first_enrolling_in_emp_pns_ins_flag": { "type": "boolean", "description": "厚生年金初加入フラグ" }, "basic_pension_number_unknown_reason_type": { "type": "string", "description": "基礎年金番号が不明な場合の理由", "enum": [ "non_pensionable", "unknown" ] }, "first_workplace": { "type": "string", "description": "最初に厚生年金へ加入した会社名" }, "first_workplace_address_text": { "type": "string", "description": "最初に厚生年金へ加入した会社の住所文字列" }, "first_employment_start_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍開始日" }, "first_employment_end_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍終了日" }, "last_workplace": { "type": "string", "description": "最後に厚生年金へ加入した会社名" }, "last_workplace_address_text": { "type": "string", "description": "最後に厚生年金へ加入した会社の住所文字列" }, "last_employment_start_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍開始日" }, "last_employment_end_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍終了日" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の資格取得年月日" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の資格喪失年月日" }, "employees_pension_insurance_qualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格取得年月日" }, "employees_pension_insurance_disqualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格喪失年月日" }, "health_insurance_qualified_at": { "type": "string", "format": "date", "description": "健康保険の資格取得年月日" }, "health_insurance_disqualified_at": { "type": "string", "format": "date", "description": "健康保険の資格喪失年月日" }, "insurance_premium_calculation_type": { "type": "string", "description": "給与計算機能で利用する社会保険料の設定方法", "enum": [ "rate", "fixed" ] }, "health_insurance_premium_company": { "type": "integer", "format": "int32", "description": "健康保険料（会社負担分）" }, "health_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "健康保険料（本人負担分）" }, "care_insurance_premium_company": { "type": "integer", "format": "int32", "description": "介護保険料（会社負担分）" }, "care_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "介護保険料（本人負担分）" }, "child_care_support_fund_company": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（会社負担分）" }, "child_care_support_fund_individual": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（本人負担分）" }, "employees_pension_insurance_premium_company": { "type": "integer", "format": "int32", "description": "厚生年金保険料（会社負担分）" }, "employees_pension_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "厚生年金保険料（本人負担分）" }, "child_care_contribution": { "type": "integer", "format": "int32", "description": "子ども・子育て拠出金" }, "having_spouse": { "type": "boolean", "description": "配偶者の有無" }, "spouse_yearly_income": { "type": "integer", "format": "int32", "description": "配偶者の年収" }, "monthly_income_currency": { "type": "integer", "format": "int32", "description": "報酬月額（通貨）" }, "monthly_income_goods": { "type": "integer", "format": "int32", "description": "報酬月額（現物）" }, "monthly_base_salary": { "type": "integer", "format": "int32", "description": "基本給（月給）" }, "monthly_standard_income_updated_at": { "type": "string", "format": "date", "description": "標準報酬月額の改定年月" }, "monthly_standard_income_hel": { "type": "integer", "format": "int32", "description": "健康保険の標準報酬月額" }, "monthly_standard_income_pns": { "type": "integer", "format": "int32", "description": "厚生年金の標準報酬月額" }, "nearest_station_and_line": { "type": "string", "description": "通勤経路" }, "commutation_1_expenses": { "type": "integer", "format": "int32", "description": "通勤手当1の定期券代" }, "commutation_1_period": { "type": "string", "description": "通勤手当1の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_1_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当1の片道運賃" }, "commutation_2_expenses": { "type": "integer", "format": "int32", "description": "通勤手当2の定期券代" }, "commutation_2_period": { "type": "string", "description": "通勤手当2の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_2_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当2の片道運賃" }, "foreign_resident_last_name": { "type": "string", "description": "在留資格情報：姓" }, "foreign_resident_first_name": { "type": "string", "description": "在留資格情報：名" }, "foreign_resident_middle_name": { "type": "string", "description": "在留資格情報：ミドルネーム" }, "foreign_resident_card_number": { "type": "string", "description": "在留カード番号" }, "nationality_code": { "type": "string", "description": "国籍 / 国籍コード" }, "resident_status_type": { "type": "string", "description": "在留資格" }, "resident_status_other_reason": { "type": "string", "description": "在留資格不明理由" }, "resident_end_at": { "type": "string", "format": "date", "description": "在留期日" }, "having_ex_activity_permission": { "type": "string", "description": "資格外活動許可の有無", "enum": [ "permitted", "none" ] }, "other_be_workable_type": { "type": "string", "description": "派遣・請負就労区分", "enum": [ "other_be_workable", "others" ] }, "department": { "type": "string", "description": "部署" }, "contract_type": { "type": "string", "description": "契約種別", "enum": [ "unlimited", "fixed_term" ] }, "contract_start_on": { "type": "string", "format": "date", "description": "契約開始日" }, "contract_end_on": { "type": "string", "format": "date", "description": "契約終了日" }, "contract_renewal_type": { "type": "string", "description": "契約更新の有無", "enum": [ "renewal", "none", "auto_renewal" ] }, "tax_cd": { "type": "string", "description": "課税区分", "enum": [ "kou", "otsu", "hei", "reward", "non_resident", "no_taxation_required" ] }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "working_student_flag": { "type": "boolean", "description": "勤労学生フラグ" }, "school_name": { "type": "string", "description": "勤労学生：学校名" }, "enrolled_at": { "type": "string", "format": "date", "description": "勤労学生：入学年月日" }, "working_student_income": { "type": "integer", "format": "int32", "description": "勤労学生：所得の見積額" }, "employment_income_flag": { "type": "boolean", "description": "給与所得フラグ" }, "business_income_flag": { "type": "boolean", "description": "事業所得フラグ" }, "devidend_income_flag": { "type": "boolean", "description": "配当所得フラグ" }, "estate_income_flag": { "type": "boolean", "description": "不動産所得フラグ" }, "widow_type": { "type": "string", "description": "寡婦・ひとり親", "enum": [ "widow", "single_parent" ] }, "widow_reason_type": { "type": "string", "description": "寡婦・ひとり親の理由", "enum": [ "divorce", "bereavement", "missing", "unmarried" ] }, "widow_memo": { "type": "string", "description": "寡婦・ひとり親の備考" }, "employment_type_id": { "type": "string", "description": "雇用形態のID" }, "department_ids": { "type": "array", "description": "所属する部署のID", "items": { "type": "string" } }, "payment_period_id": { "type": "string", "description": "給与支給形態" }, "profile_image": { "$ref": "#/definitions/AttachmentParams", "description": "プロフィール画像" }, "resume1": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書1" }, "resume2": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書2" }, "identity_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類1" }, "identity_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類2" }, "address_image": { "$ref": "#/definitions/AttachmentParams", "description": "住所を確認できる書類" }, "emp_ins_insured_person_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "雇用保険被保険者番号添付画像" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号添付画像" }, "foreign_resident_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像1" }, "foreign_resident_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像2" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "student_card_image": { "$ref": "#/definitions/AttachmentParams", "description": "勤労学生：学生証の画像" }, "bank_accounts": { "type": "array", "description": "口座情報", "items": { "$ref": "#/definitions/BankAccount" } }, "custom_fields": { "type": "array", "description": "カスタム項目", "items": { "$ref": "#/definitions/CrewCustomFieldParam" } } }, "required": [ "emp_status", "last_name", "first_name", "last_name_yomi", "first_name_yomi", "gender" ], "description": "更新" }, "patchV1CrewsId": { "type": "object", "properties": { "emp_status": { "type": "string", "description": "在籍状況", "enum": [ "employed", "absent", "retired" ] }, "user_id": { "type": "string", "description": "ユーザーID" }, "biz_establishment_id": { "type": "string", "description": "事業所ID" }, "emp_code": { "type": "string", "description": "社員番号" }, "emp_type": { "type": "string", "description": "雇用形態", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ] }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "business_last_name": { "type": "string", "description": "ビジネスネーム：姓" }, "business_first_name": { "type": "string", "description": "ビジネスネーム：名" }, "business_last_name_yomi": { "type": "string", "description": "ビジネスネーム：姓（カタカナ）" }, "business_first_name_yomi": { "type": "string", "description": "ビジネスネーム：名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "gender": { "type": "string", "description": "戸籍上の性別", "enum": [ "male", "female" ] }, "tel_number": { "type": "string", "description": "電話番号" }, "address": { "$ref": "#/definitions/Address", "description": "現住所" }, "address_head_of_family": { "type": "string", "description": "世帯主" }, "address_relation_name": { "type": "string", "description": "世帯主の続柄" }, "email": { "type": "string", "description": "メールアドレス" }, "emergency_relation_name": { "type": "string", "description": "緊急連絡先の続柄" }, "emergency_last_name": { "type": "string", "description": "緊急連絡先の姓" }, "emergency_first_name": { "type": "string", "description": "緊急連絡先の名" }, "emergency_last_name_yomi": { "type": "string", "description": "緊急連絡先の姓（カタカナ）" }, "emergency_first_name_yomi": { "type": "string", "description": "緊急連絡先の名（カタカナ）" }, "emergency_tel_number": { "type": "string", "description": "緊急連絡先の電話番号" }, "emergency_address": { "$ref": "#/definitions/Address", "description": "緊急連絡先の住所" }, "resident_card_address": { "$ref": "#/definitions/Address", "description": "住民票住所" }, "resident_card_address_head_of_family": { "type": "string", "description": "住民票住所の世帯主" }, "resident_card_address_relation_name": { "type": "string", "description": "続柄（住民票住所の世帯主）" }, "position": { "type": "string", "description": "役職" }, "positions": { "type": "array", "description": "役職名", "items": { "type": "string" } }, "grade": { "type": "string", "description": "等級名" }, "job_category": { "type": "string", "description": "職種名" }, "occupation": { "type": "string", "description": "業務内容" }, "entered_at": { "type": "string", "format": "date", "description": "入社年月日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職年月日" }, "resigned_reason": { "type": "string", "description": "退職事由" }, "recruitment_type": { "type": "string", "description": "採用区分名" }, "emp_ins_insured_person_number": { "type": "string", "description": "雇用保険の被保険者番号" }, "emp_ins_insured_person_number_unknown_reason_type": { "type": "string", "description": "雇用保険の被保険者番号がない場合の理由", "enum": [ "no_work_experience", "never_joined", "unknown" ] }, "emp_ins_qualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格取得年月日" }, "emp_ins_disqualified_at": { "type": "string", "format": "date", "description": "雇用保険の資格喪失年月日" }, "previous_workplace": { "type": "string", "description": "雇用保険に加入していた会社名" }, "previous_employment_start_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍開始日" }, "previous_employment_end_on": { "type": "string", "format": "date", "description": "雇用保険に加入していた会社の在籍終了日" }, "soc_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "厚生年金保険の被保険者整理番号" }, "hel_ins_insured_person_number": { "type": "integer", "format": "int32", "description": "健康保険の被保険者整理番号" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "first_enrolling_in_emp_pns_ins_flag": { "type": "boolean", "description": "厚生年金初加入フラグ" }, "basic_pension_number_unknown_reason_type": { "type": "string", "description": "基礎年金番号が不明な場合の理由", "enum": [ "non_pensionable", "unknown" ] }, "first_workplace": { "type": "string", "description": "最初に厚生年金へ加入した会社名" }, "first_workplace_address_text": { "type": "string", "description": "最初に厚生年金へ加入した会社の住所文字列" }, "first_employment_start_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍開始日" }, "first_employment_end_on": { "type": "string", "format": "date", "description": "最初に厚生年金へ加入した会社の在籍終了日" }, "last_workplace": { "type": "string", "description": "最後に厚生年金へ加入した会社名" }, "last_workplace_address_text": { "type": "string", "description": "最後に厚生年金へ加入した会社の住所文字列" }, "last_employment_start_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍開始日" }, "last_employment_end_on": { "type": "string", "format": "date", "description": "最後に厚生年金へ加入した会社の在籍終了日" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の資格取得年月日" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の資格喪失年月日" }, "employees_pension_insurance_qualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格取得年月日" }, "employees_pension_insurance_disqualified_at": { "type": "string", "format": "date", "description": "厚生年金保険の資格喪失年月日" }, "health_insurance_qualified_at": { "type": "string", "format": "date", "description": "健康保険の資格取得年月日" }, "health_insurance_disqualified_at": { "type": "string", "format": "date", "description": "健康保険の資格喪失年月日" }, "insurance_premium_calculation_type": { "type": "string", "description": "給与計算機能で利用する社会保険料の設定方法", "enum": [ "rate", "fixed" ] }, "health_insurance_premium_company": { "type": "integer", "format": "int32", "description": "健康保険料（会社負担分）" }, "health_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "健康保険料（本人負担分）" }, "care_insurance_premium_company": { "type": "integer", "format": "int32", "description": "介護保険料（会社負担分）" }, "care_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "介護保険料（本人負担分）" }, "child_care_support_fund_company": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（会社負担分）" }, "child_care_support_fund_individual": { "type": "integer", "format": "int32", "description": "子ども・子育て支援金（本人負担分）" }, "employees_pension_insurance_premium_company": { "type": "integer", "format": "int32", "description": "厚生年金保険料（会社負担分）" }, "employees_pension_insurance_premium_individual": { "type": "integer", "format": "int32", "description": "厚生年金保険料（本人負担分）" }, "child_care_contribution": { "type": "integer", "format": "int32", "description": "子ども・子育て拠出金" }, "having_spouse": { "type": "boolean", "description": "配偶者の有無" }, "spouse_yearly_income": { "type": "integer", "format": "int32", "description": "配偶者の年収" }, "monthly_income_currency": { "type": "integer", "format": "int32", "description": "報酬月額（通貨）" }, "monthly_income_goods": { "type": "integer", "format": "int32", "description": "報酬月額（現物）" }, "monthly_base_salary": { "type": "integer", "format": "int32", "description": "基本給（月給）" }, "monthly_standard_income_updated_at": { "type": "string", "format": "date", "description": "標準報酬月額の改定年月" }, "monthly_standard_income_hel": { "type": "integer", "format": "int32", "description": "健康保険の標準報酬月額" }, "monthly_standard_income_pns": { "type": "integer", "format": "int32", "description": "厚生年金の標準報酬月額" }, "nearest_station_and_line": { "type": "string", "description": "通勤経路" }, "commutation_1_expenses": { "type": "integer", "format": "int32", "description": "通勤手当1の定期券代" }, "commutation_1_period": { "type": "string", "description": "通勤手当1の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_1_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当1の片道運賃" }, "commutation_2_expenses": { "type": "integer", "format": "int32", "description": "通勤手当2の定期券代" }, "commutation_2_period": { "type": "string", "description": "通勤手当2の期間", "enum": [ "commutation_period_1_month", "commutation_period_3_month", "commutation_period_6_month" ] }, "commutation_2_single_fare": { "type": "integer", "format": "int32", "description": "通勤手当2の片道運賃" }, "foreign_resident_last_name": { "type": "string", "description": "在留資格情報：姓" }, "foreign_resident_first_name": { "type": "string", "description": "在留資格情報：名" }, "foreign_resident_middle_name": { "type": "string", "description": "在留資格情報：ミドルネーム" }, "foreign_resident_card_number": { "type": "string", "description": "在留カード番号" }, "nationality_code": { "type": "string", "description": "国籍 / 国籍コード" }, "resident_status_type": { "type": "string", "description": "在留資格" }, "resident_status_other_reason": { "type": "string", "description": "在留資格不明理由" }, "resident_end_at": { "type": "string", "format": "date", "description": "在留期日" }, "having_ex_activity_permission": { "type": "string", "description": "資格外活動許可の有無", "enum": [ "permitted", "none" ] }, "other_be_workable_type": { "type": "string", "description": "派遣・請負就労区分", "enum": [ "other_be_workable", "others" ] }, "department": { "type": "string", "description": "部署" }, "contract_type": { "type": "string", "description": "契約種別", "enum": [ "unlimited", "fixed_term" ] }, "contract_start_on": { "type": "string", "format": "date", "description": "契約開始日" }, "contract_end_on": { "type": "string", "format": "date", "description": "契約終了日" }, "contract_renewal_type": { "type": "string", "description": "契約更新の有無", "enum": [ "renewal", "none", "auto_renewal" ] }, "tax_cd": { "type": "string", "description": "課税区分", "enum": [ "kou", "otsu", "hei", "reward", "non_resident", "no_taxation_required" ] }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "working_student_flag": { "type": "boolean", "description": "勤労学生フラグ" }, "school_name": { "type": "string", "description": "勤労学生：学校名" }, "enrolled_at": { "type": "string", "format": "date", "description": "勤労学生：入学年月日" }, "working_student_income": { "type": "integer", "format": "int32", "description": "勤労学生：所得の見積額" }, "employment_income_flag": { "type": "boolean", "description": "給与所得フラグ" }, "business_income_flag": { "type": "boolean", "description": "事業所得フラグ" }, "devidend_income_flag": { "type": "boolean", "description": "配当所得フラグ" }, "estate_income_flag": { "type": "boolean", "description": "不動産所得フラグ" }, "widow_type": { "type": "string", "description": "寡婦・ひとり親", "enum": [ "widow", "single_parent" ] }, "widow_reason_type": { "type": "string", "description": "寡婦・ひとり親の理由", "enum": [ "divorce", "bereavement", "missing", "unmarried" ] }, "widow_memo": { "type": "string", "description": "寡婦・ひとり親の備考" }, "employment_type_id": { "type": "string", "description": "雇用形態のID" }, "department_ids": { "type": "array", "description": "所属する部署のID", "items": { "type": "string" } }, "payment_period_id": { "type": "string", "description": "給与支給形態" }, "profile_image": { "$ref": "#/definitions/AttachmentParams", "description": "プロフィール画像" }, "resume1": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書1" }, "resume2": { "$ref": "#/definitions/AttachmentParams", "description": "履歴書・職務経歴書2" }, "identity_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類1" }, "identity_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "本人確認書類2" }, "address_image": { "$ref": "#/definitions/AttachmentParams", "description": "住所を確認できる書類" }, "emp_ins_insured_person_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "雇用保険被保険者番号添付画像" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号添付画像" }, "foreign_resident_card_image1": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像1" }, "foreign_resident_card_image2": { "$ref": "#/definitions/AttachmentParams", "description": "在留カード（特定在留カード）の画像2" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "student_card_image": { "$ref": "#/definitions/AttachmentParams", "description": "勤労学生：学生証の画像" }, "bank_accounts": { "type": "array", "description": "口座情報", "items": { "$ref": "#/definitions/BankAccount" } }, "custom_fields": { "type": "array", "description": "カスタム項目", "items": { "$ref": "#/definitions/CrewCustomFieldParam" } } }, "required": [ "emp_status", "last_name", "first_name", "last_name_yomi", "first_name_yomi", "gender" ], "description": "部分更新" }, "putV1CrewsIdInvite": { "type": "object", "properties": { "inviter_user_id": { "type": "string", "description": "招待者のユーザーID" }, "crew_input_form_id": { "type": "string", "description": "従業員情報収集フォームID" } }, "required": [ "inviter_user_id" ], "description": "招待" }, "Dependent": { "type": "object", "properties": { "id": { "type": "string", "description": "家族ID" }, "crew_id": { "type": "string", "description": "紐づく従業員のID" }, "relation_name": { "type": "string", "description": "続柄名（※ 非推奨項目。後方互換を保つため参照のみ可能）" }, "relation": { "allOf": [ { "$ref": "#/definitions/DependentRelation" } ], "description": "続柄" }, "is_spouse": { "type": "boolean", "description": "配偶者かどうか" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "moved_at": { "type": "string", "format": "date", "description": "住所変更年月日" }, "gender": { "type": "string", "enum": [ "male", "female" ], "description": "性別" }, "job": { "type": "string", "description": "職業" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "basic_pension_number_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "基礎年金番号の確認書類" }, "live_together_type": { "type": "string", "enum": [ "living_together", "living_separately" ], "description": "同居・別居の別" }, "address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住所" }, "tel_number": { "type": "string", "description": "電話番号" }, "handicapped_type": { "type": "string", "enum": [ "ordinary_handicapped", "special_handicapped", "special_handicapped_living_together" ], "description": "障害者区分" }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "handicapped_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "障害者手帳の画像" }, "remittance_to_relative": { "type": "integer", "format": "int32", "description": "海外居住時の送金額（単位：円）" }, "remittance_image1": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "送金関係書類1" }, "remittance_image2": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "送金関係書類2" }, "remittance_image3": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "送金関係書類3" }, "international_student": { "type": "boolean", "description": "留学生" }, "international_student_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "留学証明書類" }, "social_insurance_support_type": { "type": "string", "enum": [ "unsupported", "supported", "unknown" ], "description": "社会保険の扶養状況" }, "income": { "type": "integer", "format": "int32", "description": "社会保険の年間収入（単位:円）" }, "monthly_income": { "type": "integer", "format": "int32", "description": "社会保険の月間収入（単位:円）" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者になった日" }, "soc_ins_qualified_reason": { "type": "string", "description": "社会保険の被扶養者になった理由" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者でなくなった日" }, "disqualified_reason_type": { "type": "string", "enum": [ "death", "divorce", "employment", "income_increase", "aging_out_75", "disability_certificate", "others" ], "description": "社会保険の扶養から削除された理由" }, "disqualified_reason": { "type": "string", "description": "社会保険の扶養から削除された理由（その他の場合）" }, "tax_law_support_type": { "type": "string", "enum": [ "unsupported", "unsupported_same_living_spouse", "supported", "special_spousal_exemption", "unknown" ], "description": "税法上の扶養状況" }, "tax_deduction_income": { "type": "integer", "format": "int32", "description": "税法上の年間所得見積額（単位:円）" }, "tax_deduction_qualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者になった日" }, "tax_deduction_qualified_reason": { "type": "string", "description": "税法上の被扶養者になった理由" }, "tax_deduction_disqualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者でなくなった日" }, "tax_deduction_disqualified_reason_type": { "type": "string", "enum": [ "death", "divorce", "employment", "income_increase", "others" ], "description": "税法上の扶養から削除された理由" }, "tax_deduction_disqualified_reason": { "type": "string", "description": "税法上の扶養から削除された理由（その他の場合）" }, "maternity_handbook_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "母子手帳の画像" }, "kinship_image": { "allOf": [ { "$ref": "#/definitions/Attachment" } ], "description": "親族関係書類" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "code": { "type": "string", "description": "家族コード" }, "spouse_dependent_qualification_reason_type": { "type": "string", "enum": [ "joined_employee_ins", "changed_soc_ins_to_mutual_aid", "changed_mutual_aid_to_soc_ins", "changed_mutual_aid_to_mutual_aid", "marriage", "retired", "income_decrease", "others" ], "description": "被扶養者（第3号被保険者）になった理由" }, "spouse_dependent_disqualification_reason_type": { "type": "string", "enum": [ "dead", "others" ], "description": "被扶養者（第3号被保険者）でなくなった理由" }, "spouse_dependent_disqualification_dead_at": { "type": "string", "format": "date", "description": "死亡日" }, "spouse_dependent_disqualification_reason": { "type": "string", "description": "その他理由" }, "custom_fields": { "type": "array", "items": { "$ref": "#/definitions/DependentCustomField" }, "description": "カスタム家族項目の一覧。値がない項目は含まれません。" } }, "required": [ "id", "crew_id", "last_name", "first_name", "birth_at", "gender", "live_together_type" ], "description": "Dependent model" }, "DependentRelation": { "type": "object", "properties": { "id": { "type": "string", "description": "続柄ID" }, "name": { "type": "string", "description": "続柄名" }, "preset_type": { "type": "string", "description": "プリセット続柄" }, "is_child": { "type": "boolean", "description": "子であるかどうか" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "description": "DependentRelation model" }, "DependentCustomField": { "type": "object", "properties": { "value": { "type": "string", "description": "カスタム項目の値" }, "template": { "allOf": [ { "$ref": "#/definitions/DependentCustomFieldTemplate" } ], "description": "カスタム項目テンプレート情報" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日時" }, "updated_at": { "type": "string", "format": "date-time", "description": "更新日時" } } }, "DependentCustomFieldTemplate": { "type": "object", "properties": { "id": { "type": "string", "description": "カスタム家族項目ID" }, "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "enum": [ "date", "decimal", "enum", "file", "string", "text" ], "description": "入力タイプ" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/DependentCustomEnumFieldTemplateElement" }, "description": "ドロップダウンリスト項目" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "小数点以下の桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "順番" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "id", "name", "type" ], "description": "DependentCustomFieldTemplate model" }, "DependentCustomEnumFieldTemplateElement": { "type": "object", "properties": { "id": { "type": "string", "description": "ドロップダウンリスト項目ID" }, "name": { "type": "string", "description": "選択肢" }, "physical_name": { "type": "string", "description": "物理名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "id", "name", "position" ] }, "DependentCustomFieldParam": { "type": "object", "properties": { "value": { "type": "string", "description": "カスタム項目の値" }, "template_id": { "type": "string", "description": "設定先のカスタム家族項目テンプレートID" }, "file_name": { "type": "string", "description": "テンプレート種別がファイルの場合のファイル名" } }, "required": [ "template_id" ] }, "postV1CrewsCrewIdDependents": { "type": "object", "properties": { "tax_law_support_type": { "type": "string", "description": "税法上の扶養状況", "enum": [ "unsupported", "unsupported_same_living_spouse", "supported", "special_spousal_exemption", "unknown" ] }, "social_insurance_support_type": { "type": "string", "description": "社会保険の扶養状況", "enum": [ "unsupported", "supported", "unknown" ] }, "is_spouse": { "type": "boolean", "description": "配偶者かどうか" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "moved_at": { "type": "string", "format": "date", "description": "住所変更年月日" }, "gender": { "type": "string", "description": "性別", "enum": [ "male", "female" ] }, "job": { "type": "string", "description": "職業" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号の確認書類" }, "live_together_type": { "type": "string", "description": "同居・別居の別", "enum": [ "living_together", "living_separately" ] }, "address": { "$ref": "#/definitions/Address", "description": "住所" }, "tel_number": { "type": "string", "description": "電話番号" }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped", "special_handicapped_living_together" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "remittance_to_relative": { "type": "integer", "format": "int32", "description": "海外居住時の送金額（単位：円）" }, "remittance_image1": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類1" }, "remittance_image2": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類2" }, "remittance_image3": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類3" }, "international_student": { "type": "boolean", "description": "留学生" }, "international_student_image": { "$ref": "#/definitions/AttachmentParams", "description": "留学証明書類" }, "income": { "type": "integer", "format": "int32", "description": "社会保険の年間収入（単位:円）" }, "monthly_income": { "type": "integer", "format": "int32", "description": "社会保険の月間収入（単位:円）" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者になった日" }, "soc_ins_qualified_reason": { "type": "string", "description": "社会保険の被扶養者になった理由" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者でなくなった日" }, "disqualified_reason_type": { "type": "string", "description": "社会保険の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "aging_out_75", "disability_certificate", "others" ] }, "disqualified_reason": { "type": "string", "description": "社会保険の扶養から削除された理由（その他の場合）" }, "tax_deduction_income": { "type": "integer", "format": "int32", "description": "税法上の年間所得見積額（単位:円）" }, "tax_deduction_qualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者になった日" }, "tax_deduction_qualified_reason": { "type": "string", "description": "税法上の被扶養者になった理由" }, "tax_deduction_disqualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者でなくなった日" }, "tax_deduction_disqualified_reason_type": { "type": "string", "description": "税法上の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "others" ] }, "tax_deduction_disqualified_reason": { "type": "string", "description": "税法上の扶養から削除された理由（その他の場合）" }, "maternity_handbook_image": { "$ref": "#/definitions/AttachmentParams", "description": "母子手帳の画像" }, "kinship_image": { "$ref": "#/definitions/AttachmentParams", "description": "親族関係書類" }, "code": { "type": "string", "description": "家族コード" }, "spouse_dependent_qualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）になった理由", "enum": [ "joined_employee_ins", "changed_soc_ins_to_mutual_aid", "changed_mutual_aid_to_soc_ins", "changed_mutual_aid_to_mutual_aid", "marriage", "retired", "income_decrease", "others" ] }, "spouse_dependent_disqualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）でなくなった理由", "enum": [ "dead", "others" ] }, "spouse_dependent_disqualification_dead_at": { "type": "string", "format": "date", "description": "死亡日" }, "spouse_dependent_disqualification_reason": { "type": "string", "description": "その他理由" }, "custom_fields": { "type": "array", "description": "カスタム家族項目", "items": { "$ref": "#/definitions/DependentCustomFieldParam" } }, "relation_id": { "type": "string", "description": "続柄ID" } }, "required": [ "last_name", "first_name", "birth_at", "gender", "live_together_type", "relation_id" ], "description": "登録" }, "putV1CrewsCrewIdDependentsId": { "type": "object", "properties": { "tax_law_support_type": { "type": "string", "description": "税法上の扶養状況", "enum": [ "unsupported", "unsupported_same_living_spouse", "supported", "special_spousal_exemption", "unknown" ] }, "social_insurance_support_type": { "type": "string", "description": "社会保険の扶養状況", "enum": [ "unsupported", "supported", "unknown" ] }, "is_spouse": { "type": "boolean", "description": "配偶者かどうか" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "moved_at": { "type": "string", "format": "date", "description": "住所変更年月日" }, "gender": { "type": "string", "description": "性別", "enum": [ "male", "female" ] }, "job": { "type": "string", "description": "職業" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号の確認書類" }, "live_together_type": { "type": "string", "description": "同居・別居の別", "enum": [ "living_together", "living_separately" ] }, "address": { "$ref": "#/definitions/Address", "description": "住所" }, "tel_number": { "type": "string", "description": "電話番号" }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped", "special_handicapped_living_together" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "remittance_to_relative": { "type": "integer", "format": "int32", "description": "海外居住時の送金額（単位：円）" }, "remittance_image1": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類1" }, "remittance_image2": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類2" }, "remittance_image3": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類3" }, "international_student": { "type": "boolean", "description": "留学生" }, "international_student_image": { "$ref": "#/definitions/AttachmentParams", "description": "留学証明書類" }, "income": { "type": "integer", "format": "int32", "description": "社会保険の年間収入（単位:円）" }, "monthly_income": { "type": "integer", "format": "int32", "description": "社会保険の月間収入（単位:円）" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者になった日" }, "soc_ins_qualified_reason": { "type": "string", "description": "社会保険の被扶養者になった理由" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者でなくなった日" }, "disqualified_reason_type": { "type": "string", "description": "社会保険の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "aging_out_75", "disability_certificate", "others" ] }, "disqualified_reason": { "type": "string", "description": "社会保険の扶養から削除された理由（その他の場合）" }, "tax_deduction_income": { "type": "integer", "format": "int32", "description": "税法上の年間所得見積額（単位:円）" }, "tax_deduction_qualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者になった日" }, "tax_deduction_qualified_reason": { "type": "string", "description": "税法上の被扶養者になった理由" }, "tax_deduction_disqualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者でなくなった日" }, "tax_deduction_disqualified_reason_type": { "type": "string", "description": "税法上の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "others" ] }, "tax_deduction_disqualified_reason": { "type": "string", "description": "税法上の扶養から削除された理由（その他の場合）" }, "maternity_handbook_image": { "$ref": "#/definitions/AttachmentParams", "description": "母子手帳の画像" }, "kinship_image": { "$ref": "#/definitions/AttachmentParams", "description": "親族関係書類" }, "code": { "type": "string", "description": "家族コード" }, "spouse_dependent_qualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）になった理由", "enum": [ "joined_employee_ins", "changed_soc_ins_to_mutual_aid", "changed_mutual_aid_to_soc_ins", "changed_mutual_aid_to_mutual_aid", "marriage", "retired", "income_decrease", "others" ] }, "spouse_dependent_disqualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）でなくなった理由", "enum": [ "dead", "others" ] }, "spouse_dependent_disqualification_dead_at": { "type": "string", "format": "date", "description": "死亡日" }, "spouse_dependent_disqualification_reason": { "type": "string", "description": "その他理由" }, "custom_fields": { "type": "array", "description": "カスタム家族項目", "items": { "$ref": "#/definitions/DependentCustomFieldParam" } }, "relation_id": { "type": "string", "description": "続柄ID" } }, "required": [ "last_name", "first_name", "birth_at", "gender", "live_together_type", "relation_id" ], "description": "更新" }, "patchV1CrewsCrewIdDependentsId": { "type": "object", "properties": { "tax_law_support_type": { "type": "string", "description": "税法上の扶養状況", "enum": [ "unsupported", "unsupported_same_living_spouse", "supported", "special_spousal_exemption", "unknown" ] }, "social_insurance_support_type": { "type": "string", "description": "社会保険の扶養状況", "enum": [ "unsupported", "supported", "unknown" ] }, "is_spouse": { "type": "boolean", "description": "配偶者かどうか" }, "last_name": { "type": "string", "description": "姓" }, "first_name": { "type": "string", "description": "名" }, "last_name_yomi": { "type": "string", "description": "姓（カタカナ）" }, "first_name_yomi": { "type": "string", "description": "名（カタカナ）" }, "birth_at": { "type": "string", "format": "date", "description": "生年月日" }, "moved_at": { "type": "string", "format": "date", "description": "住所変更年月日" }, "gender": { "type": "string", "description": "性別", "enum": [ "male", "female" ] }, "job": { "type": "string", "description": "職業" }, "basic_pension_number": { "type": "string", "description": "基礎年金番号" }, "basic_pension_number_image": { "$ref": "#/definitions/AttachmentParams", "description": "基礎年金番号の確認書類" }, "live_together_type": { "type": "string", "description": "同居・別居の別", "enum": [ "living_together", "living_separately" ] }, "address": { "$ref": "#/definitions/Address", "description": "住所" }, "tel_number": { "type": "string", "description": "電話番号" }, "handicapped_type": { "type": "string", "description": "障害者区分", "enum": [ "ordinary_handicapped", "special_handicapped", "special_handicapped_living_together" ] }, "handicapped_note_type": { "type": "string", "description": "障害者手帳の種類" }, "handicapped_note_delivery_at": { "type": "string", "format": "date", "description": "障害者手帳の交付年月日" }, "handicapped_image": { "$ref": "#/definitions/AttachmentParams", "description": "障害者手帳の画像" }, "remittance_to_relative": { "type": "integer", "format": "int32", "description": "海外居住時の送金額（単位：円）" }, "remittance_image1": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類1" }, "remittance_image2": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類2" }, "remittance_image3": { "$ref": "#/definitions/AttachmentParams", "description": "送金関係書類3" }, "international_student": { "type": "boolean", "description": "留学生" }, "international_student_image": { "$ref": "#/definitions/AttachmentParams", "description": "留学証明書類" }, "income": { "type": "integer", "format": "int32", "description": "社会保険の年間収入（単位:円）" }, "monthly_income": { "type": "integer", "format": "int32", "description": "社会保険の月間収入（単位:円）" }, "soc_ins_qualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者になった日" }, "soc_ins_qualified_reason": { "type": "string", "description": "社会保険の被扶養者になった理由" }, "soc_ins_disqualified_at": { "type": "string", "format": "date", "description": "社会保険の被扶養者でなくなった日" }, "disqualified_reason_type": { "type": "string", "description": "社会保険の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "aging_out_75", "disability_certificate", "others" ] }, "disqualified_reason": { "type": "string", "description": "社会保険の扶養から削除された理由（その他の場合）" }, "tax_deduction_income": { "type": "integer", "format": "int32", "description": "税法上の年間所得見積額（単位:円）" }, "tax_deduction_qualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者になった日" }, "tax_deduction_qualified_reason": { "type": "string", "description": "税法上の被扶養者になった理由" }, "tax_deduction_disqualified_at": { "type": "string", "format": "date", "description": "税法上の被扶養者でなくなった日" }, "tax_deduction_disqualified_reason_type": { "type": "string", "description": "税法上の扶養から削除された理由", "enum": [ "death", "divorce", "employment", "income_increase", "others" ] }, "tax_deduction_disqualified_reason": { "type": "string", "description": "税法上の扶養から削除された理由（その他の場合）" }, "maternity_handbook_image": { "$ref": "#/definitions/AttachmentParams", "description": "母子手帳の画像" }, "kinship_image": { "$ref": "#/definitions/AttachmentParams", "description": "親族関係書類" }, "code": { "type": "string", "description": "家族コード" }, "spouse_dependent_qualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）になった理由", "enum": [ "joined_employee_ins", "changed_soc_ins_to_mutual_aid", "changed_mutual_aid_to_soc_ins", "changed_mutual_aid_to_mutual_aid", "marriage", "retired", "income_decrease", "others" ] }, "spouse_dependent_disqualification_reason_type": { "type": "string", "description": "被扶養者（第3号被保険者）でなくなった理由", "enum": [ "dead", "others" ] }, "spouse_dependent_disqualification_dead_at": { "type": "string", "format": "date", "description": "死亡日" }, "spouse_dependent_disqualification_reason": { "type": "string", "description": "その他理由" }, "custom_fields": { "type": "array", "description": "カスタム家族項目", "items": { "$ref": "#/definitions/DependentCustomFieldParam" } }, "relation_id": { "type": "string", "description": "続柄ID" } }, "required": [ "last_name", "first_name", "birth_at", "gender", "live_together_type", "relation_id" ], "description": "部分更新" }, "MaternityChildcareLeave": { "type": "object", "properties": { "id": { "type": "string", "description": "産休育休情報ID" }, "crew_id": { "type": "string", "description": "紐づく従業員のID" }, "is_multiple_birth": { "type": "boolean", "description": "双子以上の出産に該当するか" }, "expected_birth_at": { "type": "string", "format": "date", "description": "出産予定日" }, "birth_at": { "type": "string", "format": "date", "description": "出産日" }, "maternity_leave_start_at": { "type": "string", "format": "date", "description": "産前休業開始日" }, "maternity_leave_end_at": { "type": "string", "format": "date", "description": "産後休業終了日" }, "is_spouse_taking_childcare_leave": { "type": "boolean", "description": "「パパママ育休プラス」制度を利用するか" }, "childcare_leave_start_at": { "type": "string", "format": "date", "description": "育児休業開始日1" }, "childcare_leave_end_at": { "type": "string", "format": "date", "description": "育児休業終了日1" }, "scheduled_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日1" }, "childcare_leave_2_start_at": { "type": "string", "format": "date", "description": "育児休業開始日2" }, "childcare_leave_2_end_at": { "type": "string", "format": "date", "description": "育児休業終了日2" }, "scheduled_2_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日2" }, "childcare_leave_3_start_at": { "type": "string", "format": "date", "description": "育児休業開始日3" }, "childcare_leave_3_end_at": { "type": "string", "format": "date", "description": "育児休業終了日3" }, "scheduled_3_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日3" }, "childcare_leave_4_start_at": { "type": "string", "format": "date", "description": "育児休業開始日4" }, "childcare_leave_4_end_at": { "type": "string", "format": "date", "description": "育児休業終了日4" }, "scheduled_4_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日4" }, "childcare_leave_5_start_at": { "type": "string", "format": "date", "description": "育児休業開始日5" }, "childcare_leave_5_end_at": { "type": "string", "format": "date", "description": "育児休業終了日5" }, "scheduled_5_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日5" }, "childcare_leave_6_start_at": { "type": "string", "format": "date", "description": "育児休業開始日6" }, "childcare_leave_6_end_at": { "type": "string", "format": "date", "description": "育児休業終了日6" }, "scheduled_6_reinstatement_at": { "type": "string", "format": "date", "description": "職場復帰予定日6" }, "spouse_emp_ins_insured_person_number": { "type": "string", "description": "配偶者の雇用保険被保険者番号" }, "bank_code": { "type": "string", "description": "銀行コード" }, "bank_branch_code": { "type": "string", "description": "支店コード" }, "account_number": { "type": "string", "description": "口座番号" }, "bank_type": { "type": "string", "description": "公金受取口座、銀行、ゆうちょ銀行" }, "bank_office_type": { "type": "string", "description": "本店・支店区分" }, "jp_post_bank_branch_code": { "type": "string", "description": "記号番号(ゆうちょ銀行)" }, "jp_post_account_number": { "type": "string", "description": "口座番号(ゆうちょ銀行)" }, "memo": { "type": "string", "description": "備考" } }, "required": [ "id", "crew_id" ], "description": "MaternityChildcareLeave model" }, "CrewCustomFieldTemplateGroup": { "type": "object", "properties": { "id": { "type": "string", "description": "カスタム従業員項目グループID" }, "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ], "description": "アクセス種別" }, "templates": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomFieldTemplateNested" }, "description": "所属しているカスタム従業員項目のリスト" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "name", "updated_at", "created_at" ], "description": "CrewCustomFieldTemplateGroup model" }, "putV1CrewCustomFieldTemplateGroupsId": { "type": "object", "properties": { "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ] } }, "required": [ "name" ], "description": "更新" }, "patchV1CrewCustomFieldTemplateGroupsId": { "type": "object", "properties": { "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ] } }, "required": [ "name" ], "description": "部分更新" }, "postV1CrewCustomFieldTemplateGroups": { "type": "object", "properties": { "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ] } }, "required": [ "name" ], "description": "登録" }, "CrewCustomFieldTemplate": { "type": "object", "properties": { "id": { "type": "string", "description": "カスタム従業員項目ID" }, "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "enum": [ "date", "decimal", "enum", "file", "string", "text" ], "description": "入力タイプ" }, "elements": { "type": "array", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" }, "description": "ドロップダウンリスト項目" }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "group": { "allOf": [ { "$ref": "#/definitions/CrewCustomFieldTemplateGroupNested" } ], "description": "所属するカスタム従業員項目グループ。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "name", "type", "group_id", "position", "updated_at", "created_at" ], "description": "CrewCustomFieldTemplate model" }, "CrewCustomFieldTemplateGroupNested": { "type": "object", "properties": { "id": { "type": "string", "description": "カスタム従業員項目グループID" }, "name": { "type": "string", "description": "カスタム項目グループ名" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "access_type": { "type": "string", "enum": [ "read_and_update", "hidden", "read_and_update_values", "read_and_update_only_origin" ], "description": "アクセス種別" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "name", "updated_at", "created_at" ] }, "postV1CrewCustomFieldTemplates": { "type": "object", "properties": { "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "description": "入力タイプ", "enum": [ "date", "decimal", "enum", "file", "string", "text" ] }, "elements": { "type": "array", "description": "ドロップダウンリスト項目", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" } }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "name", "type", "group_id", "position" ], "description": "登録" }, "putV1CrewCustomFieldTemplatesId": { "type": "object", "properties": { "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "description": "入力タイプ", "enum": [ "date", "decimal", "enum", "file", "string", "text" ] }, "elements": { "type": "array", "description": "ドロップダウンリスト項目", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" } }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "name", "type", "group_id", "position" ], "description": "更新" }, "patchV1CrewCustomFieldTemplatesId": { "type": "object", "properties": { "name": { "type": "string", "description": "項目名" }, "type": { "type": "string", "description": "入力タイプ", "enum": [ "date", "decimal", "enum", "file", "string", "text" ] }, "elements": { "type": "array", "description": "ドロップダウンリスト項目", "items": { "$ref": "#/definitions/CrewCustomEnumFieldTemplateElement" } }, "group_id": { "type": "string", "description": "所属するカスタム従業員項目グループのID。group_id か group のいずれかが出力されます。" }, "hint": { "type": "string", "description": "入力ヒント" }, "scale": { "type": "integer", "format": "int32", "description": "数値の場合の有効桁数" }, "separated_by_commas": { "type": "boolean", "description": "入力された数値を3桁ごとにカンマで区切って表示" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" } }, "required": [ "name", "type", "group_id", "position" ], "description": "部分更新" }, "postV1Departments": { "type": "object", "properties": { "company_id": { "type": "string", "description": "会社ID" }, "name": { "type": "string", "description": "名称" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "code": { "type": "string", "description": "コード" }, "parent_id": { "type": "string", "description": "親の部署ID" } }, "required": [ "name" ], "description": "登録" }, "putV1DepartmentsId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "code": { "type": "string", "description": "コード" }, "company_id": { "type": "string", "description": "会社ID" }, "parent_id": { "type": "string", "description": "親の部署ID" } }, "required": [ "name" ], "description": "更新" }, "patchV1DepartmentsId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "code": { "type": "string", "description": "コード" }, "company_id": { "type": "string", "description": "会社ID" }, "parent_id": { "type": "string", "description": "親の部署ID" } }, "required": [ "name" ], "description": "部分更新" }, "postV1DepartmentsIdDiscontinue": { "type": "object", "properties": { "discontinued_date": { "type": "string", "format": "date", "description": "廃止日" } }, "required": [ "discontinued_date" ], "description": "廃止" }, "EmploymentType": { "type": "object", "properties": { "id": { "type": "string", "description": "雇用形態ID" }, "name": { "type": "string", "description": "名称" }, "preset_type": { "type": "string", "enum": [ "board_member", "full_timer", "contract_worker", "permatemp", "part_timer", "outsourcing_contractor", "etc" ], "description": "プリセット種別" }, "code": { "type": "string", "description": "雇用形態コード" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "name", "updated_at", "created_at" ], "description": "EmploymentType model" }, "postV1EmploymentTypes": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "code": { "type": "string", "description": "雇用形態コード" } }, "required": [ "name" ], "description": "登録" }, "putV1EmploymentTypesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "required": [ "name" ], "description": "更新" }, "patchV1EmploymentTypesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "code": { "type": "string", "description": "雇用形態コード" } }, "required": [ "name" ], "description": "部分更新" }, "CrewInputForm": { "type": "object", "properties": { "id": { "type": "string", "description": "収集フォームID" }, "preset_type": { "type": "string", "enum": [ "standard_invitation", "minimal_invitation" ], "description": "" }, "form_type": { "type": "string", "enum": [ "invitation" ], "description": "" }, "name": { "type": "string", "description": "名称" }, "with_my_number": { "type": "boolean", "description": "マイナンバーの提供を依頼するか" }, "crew_my_number_required": { "type": "boolean", "description": "従業員本人のマイナンバーの提供を依頼するか" }, "dependents_my_number_required": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの提供を依頼するか" }, "crew_my_number_card_required": { "type": "boolean", "description": "従業員本人の番号確認書類の提出を依頼するか" }, "crew_identification_required": { "type": "boolean", "description": "従業員本人の身元確認書類の提出を依頼するか" }, "crew_is_for_hel_ins": { "type": "boolean", "description": "従業員本人のマイナンバーの利用目的が「健康保険・厚生年金保険関係届出事務」に該当するか" }, "crew_is_for_emp_ins": { "type": "boolean", "description": "従業員本人のマイナンバーの利用目的が「雇用保険関係届出事務」が該当するか" }, "crew_is_for_acc_ins": { "type": "boolean", "description": "従業員本人のマイナンバーの利用目的が「労働者災害補償保険法関係届出事務」に該当するか" }, "crew_is_for_tax_deduction": { "type": "boolean", "description": "従業員本人のマイナンバーの利用目的が「利用目的：源泉徴収に関する事務」に該当するか" }, "crew_is_for_shareholding": { "type": "boolean", "description": "従業員本人のマイナンバーの利用目的が「持株会の金融商品取引に関する法定書類の作成・提供事務」に該当するか" }, "dependents_my_number_card_required": { "type": "boolean", "description": "被扶養者（配偶者含む）の番号確認書類の提出を依頼するか" }, "dependents_identification_required": { "type": "boolean", "description": "被扶養者（配偶者含む）の身元確認書類の提出を依頼するか" }, "dependents_is_for_hel_ins": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「健康保険・厚生年金保険関係届出事務」に該当するか" }, "dependents_is_for_emp_ins": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「雇用保険関係届出事務」に該当するか" }, "dependents_is_for_acc_ins": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「労働者災害補償保険法関係届出事務に該当するか" }, "dependents_is_for_tax_deduction": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「源泉徴収に関する事務」に該当するか" }, "dependents_is_for_shareholding": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「持株会の金融商品取引に関する法定書類の作成・提供事務」に該当するか" }, "dependents_is_for_cat3_ins": { "type": "boolean", "description": "被扶養者（配偶者含む）のマイナンバーの利用目的が「国民年金第3号被保険者関係届出事務（配偶者がいる場合）」に該当するか" }, "field_groups": { "allOf": [ { "$ref": "#/definitions/CrewInputFormFieldGroup" } ], "description": "従業員入力項目グループのリスト" }, "mail_format_id": { "type": "string", "description": "紐づくメールフォーマットのID。mail_format_id か mail_format のいずれかが出力されます。" }, "mail_format": { "allOf": [ { "$ref": "#/definitions/MailFormat" } ], "description": "紐づくメールフォーマット。mail_format_id か mail_format のいずれかが出力されます。" }, "family_enabled": { "type": "boolean", "description": "扶養しない家族も登録できるかどうか" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "form_type", "name", "mail_format_id", "mail_format" ], "description": "CrewInputForm model" }, "CrewInputFormFieldGroup": { "type": "object", "properties": { "basic_field_group_type": { "type": "string", "description": "基本項目のグループ種別" }, "hint": { "type": "string", "description": "ヒント" }, "position": { "type": "integer", "format": "int32", "description": "ポジション" }, "fields": { "allOf": [ { "$ref": "#/definitions/CrewInputFormField" } ], "description": "従業員入力項目のリスト" }, "custom_field_template_group_id": { "type": "integer", "format": "int32", "description": "紐づくカスタム従業員項目テンプレートグループID" }, "custom_field_template_group": { "allOf": [ { "$ref": "#/definitions/CrewCustomFieldTemplateGroup" } ], "description": "紐づくカスタム従業員項目テンプレートグループ" } } }, "CrewInputFormField": { "type": "object", "properties": { "attribute_name": { "type": "string", "description": "紐づく従業員情報項目の物理名" }, "display_type": { "type": "string", "enum": [ "hidden", "optional", "required" ], "description": "項目の表示設定" }, "custom_field_template_id": { "type": "string", "description": "紐づくカスタム従業員項目テンプレートID" }, "custom_field_template": { "allOf": [ { "$ref": "#/definitions/CrewCustomFieldTemplate" } ], "description": "紐づくカスタム従業員項目テンプレート" } } }, "MailFormat": { "type": "object", "properties": { "id": { "type": "string", "description": "メールフォーマットID" }, "mail_type": { "type": "string", "enum": [ "invitation" ], "description": "メール種別" }, "name": { "type": "string", "description": "名称" }, "crew_input_forms": { "type": "array", "items": { "$ref": "#/definitions/CrewInputForm" }, "description": "所属している従業員情報収集フォームのリスト" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "mail_type", "name" ], "description": "MailFormat model" }, "User": { "type": "object", "properties": { "id": { "type": "string", "description": "ユーザーID" }, "email": { "type": "string", "description": "ログイン用メールアドレス" }, "notification_email": { "type": "string", "description": "通知用メールアドレス" }, "admin": { "type": "boolean", "description": "管理者フラグ" }, "role": { "allOf": [ { "$ref": "#/definitions/Role" } ], "description": "権限" }, "agreement_for_electronic_delivery": { "type": "boolean", "description": "「給与所得等明細書の電子交付に関する同意」に同意済みか否か" }, "crew_id": { "type": "string", "description": "紐づく従業員のID。crew_id か crew のいずれかが出力されます。" }, "crew": { "allOf": [ { "$ref": "#/definitions/Crew" } ], "description": "紐づく従業員。crew_id か crew のいずれかが出力されます。" }, "addons": { "type": "array", "items": { "$ref": "#/definitions/AddonEnabled" }, "description": "ユーザーがアクセス可能なアドオンのリスト" }, "invitation_created_at": { "type": "string", "format": "date", "description": "招待日時" }, "invitation_opened_at": { "type": "string", "format": "date", "description": "招待開封日時" }, "invitation_accepted_at": { "type": "string", "format": "date", "description": "招待承認日時" }, "invitation_answered_at": { "type": "string", "format": "date", "description": "招待回答日時" }, "suppressed_email_logs": { "type": "array", "items": { "$ref": "#/definitions/SuppressedEmailLog" }, "description": "メール配信状況" }, "has_password": { "type": "boolean", "description": "パスワードが設定されているかどうか" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "email", "notification_email", "admin" ], "description": "User model" }, "Role": { "type": "object", "properties": { "id": { "type": "string", "description": "権限ID" }, "name": { "type": "string", "description": "名称" }, "description": { "type": "string", "description": "説明" }, "crews_scope": { "type": "string", "enum": [ "crews_scope_all", "crews_scope_own", "crews_scope_condition" ], "description": "従業員の操作できる範囲" }, "crews_scope_query": { "type": "object", "description": "従業員の操作できる範囲の条件" }, "session_timeout_in": { "type": "integer", "format": "int32", "description": "セッション有効期限(分)" }, "preset_type": { "type": "string", "description": "プリセット種別" } }, "required": [ "id", "name", "crews_scope" ] }, "AddonEnabled": { "type": "object", "properties": { "code": { "type": "string", "description": "code" }, "enabled": { "type": "boolean", "description": "利用可能かどうか" } } }, "SuppressedEmailLog": { "type": "object", "properties": { "id": { "type": "string", "description": "メール配信状況ID" }, "suppression_type": { "type": "integer", "format": "int32", "description": "種別" }, "reason": { "type": "string", "description": "理由" }, "suppressed_at": { "type": "string", "format": "date", "description": "配信日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id" ] }, "postV1UsersIdSamlUser": { "type": "object", "properties": { "user_id": { "type": "string", "description": "ユーザーID" }, "upn": { "type": "string", "description": "連携IdPアカウント" }, "enable": { "type": "boolean", "description": "有効フラグ" } }, "required": [ "user_id", "upn", "enable" ], "description": "SAML SSOアカウントの作成" }, "SamlUser": { "type": "object", "properties": { "id": { "type": "string", "description": "ID" }, "user_id": { "type": "string", "description": "ユーザーID" }, "upn": { "type": "string", "description": "連携IdPアカウント" }, "enable": { "type": "boolean", "description": "有効フラグ" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "user_id", "upn", "enable" ], "description": "SamlUser model" }, "patchV1UsersIdSamlUser": { "type": "object", "properties": { "upn": { "type": "string", "description": "連携IdPアカウント" }, "enable": { "type": "boolean", "description": "有効フラグ" } }, "required": [ "upn", "enable" ], "description": "SAML SSOアカウントを更新" }, "BizEstablishment": { "type": "object", "properties": { "id": { "type": "string", "description": "事業所ID" }, "hel_ins_type": { "type": "string", "enum": [ "kyokai_kenpo", "its_kenpo", "tj_kenpo", "general_kenpo" ], "description": "健康保険組合の種類" }, "hel_ins_name": { "type": "string", "description": "健康保険組合の名称" }, "company_id": { "type": "string", "description": "会社ID" }, "hel_ins_ref_code": { "type": "string", "description": "健康保険 事業所整理記号" }, "name": { "type": "string", "description": "管理名" }, "soc_ins_name": { "type": "string", "description": "社会保険登録名" }, "soc_ins_owner_id": { "type": "string", "description": "社会保険代表者ID" }, "soc_ins_owner": { "allOf": [ { "$ref": "#/definitions/Crew" } ], "description": "社会保険代表者" }, "soc_ins_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "社会保険登録住所" }, "soc_ins_tel_number": { "type": "string", "description": "電話番号" }, "soc_ins_ref_code": { "type": "string", "description": "社会保険 事業所整理記号" }, "soc_ins_number": { "type": "string", "description": "社会保険 事業所番号" }, "lab_ins_name": { "type": "string", "description": "労働保険登録名" }, "lab_ins_owner_id": { "type": "string", "description": "労働保険代表者ID" }, "lab_ins_owner": { "allOf": [ { "$ref": "#/definitions/Crew" } ], "description": "労働保険代表者" }, "lab_ins_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "労働保険登録住所" }, "lab_ins_tel_number": { "type": "string", "description": "電話番号" }, "lab_ins_number": { "type": "string", "description": "労働保険番号" }, "emp_ins_number": { "type": "string", "description": "雇用保険 事業所番号" }, "sr": { "allOf": [ { "$ref": "#/definitions/LaborAndSocialSecurityAttorney" } ], "description": "社会保険労務士" }, "jurisdiction_tax": { "type": "string", "description": "所轄税務署" }, "salary_payer_address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住所" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "hel_ins_type", "name", "soc_ins_name", "lab_ins_name" ], "description": "BizEstablishment model" }, "LaborAndSocialSecurityAttorney": { "type": "object", "properties": { "id": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "first_name_yomi": { "type": "string" }, "last_name_yomi": { "type": "string" }, "title": { "type": "string" }, "association_pref": { "type": "string" }, "agent_type": { "type": "string", "enum": [ "submit_agent", "affair_agent" ] }, "tel_number": { "type": "string" }, "address": { "allOf": [ { "$ref": "#/definitions/Address" } ], "description": "住所" } } }, "Webhook": { "type": "object", "properties": { "id": { "type": "string", "description": "Webhook ID" }, "url": { "type": "string", "description": "通知先URL" }, "description": { "type": "string", "description": "説明" }, "crew_created": { "type": "boolean", "description": "従業員情報が作成されたときに通知するかどうか" }, "crew_updated": { "type": "boolean", "description": "従業員情報が更新されたときに通知するかどうか" }, "crew_deleted": { "type": "boolean", "description": "従業員情報が削除されたときに通知するかどうか" }, "crew_imported": { "type": "boolean", "description": "従業員情報がインポートされたときに通知するかどうか" }, "dependent_created": { "type": "boolean", "description": "家族情報が作成されたときに通知するかどうか" }, "dependent_updated": { "type": "boolean", "description": "家族情報が更新されたときに通知するかどうか" }, "dependent_deleted": { "type": "boolean", "description": "家族情報が削除されたときに通知するかどうか" }, "dependent_imported": { "type": "boolean", "description": "家族情報がインポートされたときに通知するかどうか" }, "expose_only_id": { "type": "boolean", "description": "変更されたデータのIDのみ送信する" }, "disabled_at": { "type": "string", "format": "date", "description": "無効化された日時" }, "access_type": { "type": "string", "enum": [ "read_and_update", "hidden", "read_and_update_only_origin" ], "description": "アクセス種別" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "crew_created", "crew_updated", "crew_deleted", "crew_imported", "dependent_created", "dependent_updated", "dependent_deleted", "dependent_imported", "updated_at", "created_at" ], "description": "Webhook model" }, "putV1WebhooksId": { "type": "object", "properties": { "url": { "type": "string", "description": "通知先URL" }, "description": { "type": "string", "description": "説明" }, "crew_created": { "type": "boolean", "description": "従業員情報が作成されたときに通知するかどうか" }, "crew_updated": { "type": "boolean", "description": "従業員情報が更新されたときに通知するかどうか" }, "crew_deleted": { "type": "boolean", "description": "従業員情報が削除されたときに通知するかどうか" }, "crew_imported": { "type": "boolean", "description": "従業員情報がインポートされたときに通知するかどうか" }, "dependent_created": { "type": "boolean", "description": "家族情報が作成されたときに通知するかどうか" }, "dependent_updated": { "type": "boolean", "description": "家族情報が更新されたときに通知するかどうか" }, "dependent_deleted": { "type": "boolean", "description": "家族情報が削除されたときに通知するかどうか" }, "dependent_imported": { "type": "boolean", "description": "家族情報がインポートされたときに通知するかどうか" }, "expose_only_id": { "type": "boolean", "description": "変更されたデータのIDのみ送信する" }, "disabled_at": { "type": "string", "format": "date", "description": "無効化された日時" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_only_origin" ] }, "secret_token": { "type": "string", "description": "通知に付与される Secret Token" } }, "required": [ "crew_created", "crew_updated", "crew_deleted", "crew_imported", "dependent_created", "dependent_updated", "dependent_deleted", "dependent_imported" ], "description": "更新" }, "patchV1WebhooksId": { "type": "object", "properties": { "url": { "type": "string", "description": "通知先URL" }, "description": { "type": "string", "description": "説明" }, "crew_created": { "type": "boolean", "description": "従業員情報が作成されたときに通知するかどうか" }, "crew_updated": { "type": "boolean", "description": "従業員情報が更新されたときに通知するかどうか" }, "crew_deleted": { "type": "boolean", "description": "従業員情報が削除されたときに通知するかどうか" }, "crew_imported": { "type": "boolean", "description": "従業員情報がインポートされたときに通知するかどうか" }, "dependent_created": { "type": "boolean", "description": "家族情報が作成されたときに通知するかどうか" }, "dependent_updated": { "type": "boolean", "description": "家族情報が更新されたときに通知するかどうか" }, "dependent_deleted": { "type": "boolean", "description": "家族情報が削除されたときに通知するかどうか" }, "dependent_imported": { "type": "boolean", "description": "家族情報がインポートされたときに通知するかどうか" }, "expose_only_id": { "type": "boolean", "description": "変更されたデータのIDのみ送信する" }, "disabled_at": { "type": "string", "format": "date", "description": "無効化された日時" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_only_origin" ] }, "secret_token": { "type": "string", "description": "通知に付与される Secret Token" } }, "required": [ "crew_created", "crew_updated", "crew_deleted", "crew_imported", "dependent_created", "dependent_updated", "dependent_deleted", "dependent_imported" ], "description": "部分更新" }, "postV1Webhooks": { "type": "object", "properties": { "url": { "type": "string", "description": "通知先URL" }, "description": { "type": "string", "description": "説明" }, "crew_created": { "type": "boolean", "description": "従業員情報が作成されたときに通知するかどうか" }, "crew_updated": { "type": "boolean", "description": "従業員情報が更新されたときに通知するかどうか" }, "crew_deleted": { "type": "boolean", "description": "従業員情報が削除されたときに通知するかどうか" }, "crew_imported": { "type": "boolean", "description": "従業員情報がインポートされたときに通知するかどうか" }, "dependent_created": { "type": "boolean", "description": "家族情報が作成されたときに通知するかどうか" }, "dependent_updated": { "type": "boolean", "description": "家族情報が更新されたときに通知するかどうか" }, "dependent_deleted": { "type": "boolean", "description": "家族情報が削除されたときに通知するかどうか" }, "dependent_imported": { "type": "boolean", "description": "家族情報がインポートされたときに通知するかどうか" }, "expose_only_id": { "type": "boolean", "description": "変更されたデータのIDのみ送信する" }, "disabled_at": { "type": "string", "format": "date", "description": "無効化された日時" }, "access_type": { "type": "string", "description": "アクセス種別", "enum": [ "read_and_update", "hidden", "read_and_update_only_origin" ] }, "secret_token": { "type": "string", "description": "通知に付与される Secret Token" } }, "required": [ "crew_created", "crew_updated", "crew_deleted", "crew_imported", "dependent_created", "dependent_updated", "dependent_deleted", "dependent_imported" ], "description": "登録" }, "PaymentPeriod": { "type": "object", "properties": { "id": { "type": "string", "description": "給与支給形態ID" }, "name": { "type": "string", "description": "名称" }, "period_type": { "type": "string", "enum": [ "monthly", "weekly", "daily", "hourly", "etc" ], "description": "支払い期間種別" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" } }, "required": [ "id", "updated_at", "created_at" ], "description": "PaymentPeriod model" }, "JobTitle": { "type": "object", "properties": { "id": { "type": "string", "description": "役職ID" }, "name": { "type": "string", "description": "役職の名前" }, "rank": { "type": "integer", "format": "int32", "description": "役職のランク (1 ~ 99999)" }, "code": { "type": "string", "description": "役職コード)" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "created_at", "updated_at" ], "description": "JobTitle model" }, "putV1JobTitlesId": { "type": "object", "properties": { "name": { "type": "string", "description": "役職の名前" }, "rank": { "type": "integer", "format": "int32", "description": "役職のランク (1 ~ 99999)" } }, "description": "更新" }, "patchV1JobTitlesId": { "type": "object", "properties": { "name": { "type": "string", "description": "役職の名前" }, "rank": { "type": "integer", "format": "int32", "description": "役職のランク (1 ~ 99999)" }, "code": { "type": "string", "description": "役職コード)" } }, "description": "部分更新" }, "postV1JobTitles": { "type": "object", "properties": { "name": { "type": "string", "description": "役職の名前" }, "rank": { "type": "integer", "format": "int32", "description": "役職のランク (1 ~ 99999)" }, "code": { "type": "string", "description": "役職コード)" } }, "description": "作成" }, "putV1GradesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "rank": { "type": "integer", "format": "int32", "description": "ランク (1 ~ 99999)" } }, "description": "更新" }, "patchV1GradesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "rank": { "type": "integer", "format": "int32", "description": "ランク (1 ~ 99999)" } }, "description": "部分更新" }, "postV1Grades": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" }, "rank": { "type": "integer", "format": "int32", "description": "ランク (1 ~ 99999)" } }, "description": "作成" }, "putV1JobCategoriesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "description": "更新" }, "patchV1JobCategoriesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "description": "部分更新" }, "postV1JobCategories": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "description": "作成" }, "putV1RecruitmentTypesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "required": [ "name" ], "description": "更新" }, "patchV1RecruitmentTypesId": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "required": [ "name" ], "description": "部分更新" }, "postV1RecruitmentTypes": { "type": "object", "properties": { "name": { "type": "string", "description": "名称" } }, "required": [ "name" ], "description": "作成" }, "BankAccountSetting": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "口座情報の名称" }, "enabled": { "type": "boolean", "description": "口座情報が有効かどうか" }, "number": { "type": "integer", "format": "int32", "description": "口座情報の順序" }, "preset_type": { "type": "string", "description": "口座情報のプリセットタイプ" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "name", "enabled", "number", "created_at", "updated_at" ], "description": "BankAccountSetting model" }, "TaxWithholding": { "type": "object", "properties": { "id": { "type": "string", "description": "源泉徴収票グループID" }, "name": { "type": "string", "description": "名前" }, "status": { "type": "string", "enum": [ "wip", "fixed", "importing" ], "description": "ステータス" }, "year": { "type": "string", "enum": [ "H28", "H29", "H30", "H31", "R01", "R02", "R03", "R04", "R05", "R06", "R07", "R08", "R09" ], "description": "源泉徴収票に印字される年" } }, "required": [ "id", "name", "status", "year" ], "description": "TaxWithholding model" }, "postV1TaxWithholdings": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "year": { "type": "string", "description": "源泉徴収票に印字される年", "enum": [ "H28", "H29", "H30", "H31", "R01", "R02", "R03", "R04", "R05", "R06", "R07", "R08", "R09" ] } }, "required": [ "name", "year" ], "description": "登録" }, "putV1TaxWithholdingsId": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "status": { "type": "string", "description": "ステータス", "enum": [ "wip", "fixed", "importing" ] }, "year": { "type": "string", "description": "源泉徴収票に印字される年", "enum": [ "H28", "H29", "H30", "H31", "R01", "R02", "R03", "R04", "R05", "R06", "R07", "R08", "R09" ] } }, "required": [ "name", "status", "year" ], "description": "更新" }, "patchV1TaxWithholdingsId": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "status": { "type": "string", "description": "ステータス", "enum": [ "wip", "fixed", "importing" ] }, "year": { "type": "string", "description": "源泉徴収票に印字される年", "enum": [ "H28", "H29", "H30", "H31", "R01", "R02", "R03", "R04", "R05", "R06", "R07", "R08", "R09" ] } }, "required": [ "name", "status", "year" ], "description": "部分更新" }, "TaxWithholdingSlip": { "type": "object", "properties": { "id": { "type": "string", "description": "源泉徴収票ID" }, "crew_id": { "type": "string", "description": "従業員ID" }, "tax_withholding_id": { "type": "string", "description": "源泉徴収グループID" }, "file": { "type": "string" }, "file_content_type": { "type": "string" }, "file_file_size": { "type": "string" }, "file_updated_at": { "type": "string", "format": "date-time", "description": "ファイル更新日時" }, "last_notified_at": { "type": "string", "format": "date-time", "description": "通知日時" }, "company_id": { "type": "string", "description": "会社ID" }, "company": { "allOf": [ { "$ref": "#/definitions/Company" } ], "description": "会社情報" }, "ref_date": { "type": "string", "description": "対象年度" }, "crew_address_literal": { "type": "string", "description": "住所" }, "crew_emp_code": { "type": "string", "description": "受給者番号（社員番号）" }, "crew_position": { "type": "string", "description": "役職名" }, "crew_full_name_yomi": { "type": "string", "description": "氏名のフリガナ" }, "crew_full_name": { "type": "string", "description": "氏名" }, "slip_type": { "type": "string", "description": "種別" }, "payment_amount": { "type": "integer", "format": "int32", "description": "支払金額" }, "payment_amount_unpaid": { "type": "integer", "format": "int32", "description": "支払金額（内）" }, "payment_after_emp_income_deduction_amount": { "type": "integer", "format": "int32", "description": "給与所得控除後の金額（調整控除後）" }, "payment_after_income_deduction_amount": { "type": "integer", "format": "int32", "description": "所得控除の額の合計額" }, "withholding_tax_amount": { "type": "integer", "format": "int32", "description": "源泉徴収税額" }, "withholding_tax_amount_unpaid": { "type": "integer", "format": "int32", "description": "源泉徴収税額（内）" }, "spouse_deduction": { "type": "string", "description": "控除対象配偶者（有）" }, "spouse_deduction_sub": { "type": "string", "description": "控除対象配偶者（従有）" }, "spouse_deduction_elderly": { "type": "string", "description": "控除対象配偶者（老人）" }, "spouse_special_deduction_amount": { "type": "integer", "format": "int32", "description": "配偶者特別控除の額" }, "specific_dependent_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（特定：人）" }, "specific_dependent_sub_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（特定：従人）" }, "elderly_dependent_live_together_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（老人：内）" }, "elderly_dependent_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（老人：人）" }, "elderly_dependent_sub_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（老人：従人）" }, "other_dependent_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（その他：人）" }, "other_dependent_sub_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（その他：従人）" }, "specific_relative_dependent_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（特親：人）" }, "specific_relative_dependent_sub_count": { "type": "integer", "format": "int32", "description": "控除対象扶養（特親：従人）" }, "under_16_years_dependent_count": { "type": "integer", "format": "int32", "description": "16歳未満扶養親族の数" }, "special_handicapped_dependent_live_together_count": { "type": "integer", "format": "int32", "description": "障害者の数（特別：内）" }, "special_handicapped_dependent_count": { "type": "integer", "format": "int32", "description": "障害者の数（特別：人）" }, "other_handicapped_dependent_count": { "type": "integer", "format": "int32", "description": "障害者の数（その他）" }, "non_resident_relative_count": { "type": "integer", "format": "int32", "description": "非居住者である親族の数" }, "specific_relative_special_deduction_amount": { "type": "integer", "format": "int32", "description": "特定親族特別控除の額" }, "soc_ins_payment_amount": { "type": "integer", "format": "int32", "description": "社会保険料などの金額" }, "soc_ins_payment_amount_unpaid": { "type": "integer", "format": "int32", "description": "社会保険料などの金額（内）" }, "life_ins_deduction_amount": { "type": "integer", "format": "int32", "description": "生命保険料の控除額" }, "earthquake_ins_deduction_amount": { "type": "integer", "format": "int32", "description": "地震保険料の控除額" }, "housing_loan_deduction_amount": { "type": "integer", "format": "int32", "description": "住宅借入金等特別控除の額" }, "memo": { "type": "string", "description": "摘要" }, "new_life_ins_payment_amount": { "type": "integer", "format": "int32", "description": "新生保保険料の金額" }, "old_life_ins_payment_amount": { "type": "integer", "format": "int32", "description": "旧生保保険料の金額" }, "care_health_payment_amount": { "type": "integer", "format": "int32", "description": "介護医療保険の金額" }, "new_personal_pension_ins_payment_amount": { "type": "integer", "format": "int32", "description": "新個人年金の金額" }, "old_personal_pension_ins_payment_amount": { "type": "integer", "format": "int32", "description": "旧個人年金の金額" }, "housing_loan_deduction_count": { "type": "integer", "format": "int32", "description": "住宅借入等適用数" }, "housing_loan_special_deduction_amount": { "type": "integer", "format": "int32", "description": "住宅借入金等特別控除可能額" }, "housing_loan_1_started_at": { "type": "string", "format": "date", "description": "居住開始年月日(1回目)" }, "housing_loan_1_deduction_type": { "type": "string", "description": "住宅借入金特別控除区分(1回目)" }, "housing_loan_1_deduction_balance_amount": { "type": "integer", "format": "int32", "description": "住宅借入金等年末残高(1回目)" }, "housing_loan_2_started_at": { "type": "string", "format": "date", "description": "居住開始年月日(2回目)" }, "housing_loan_2_deduction_type": { "type": "string", "description": "住宅借入金特別控除区分(2回目)" }, "housing_loan_2_deduction_balance_amount": { "type": "integer", "format": "int32", "description": "住宅借入金等年末残高(2回目)" }, "national_pension_payment_amount": { "type": "integer", "format": "int32", "description": "国民年金保険料などの金額" }, "old_long_term_property_ins_payment_amount": { "type": "integer", "format": "int32", "description": "旧長期損害保険料の金額" }, "spouse_full_name_yomi": { "type": "string", "description": "控除対象配偶者（フリガナ）" }, "spouse_full_name": { "type": "string", "description": "控除対象配偶者（氏名）" }, "spouse_non_resident": { "type": "string", "description": "控除対象配偶者（区分）" }, "spouse_total_income": { "type": "integer", "format": "int32", "description": "配偶者の合計所得" }, "dependent_1_full_name_yomi": { "type": "string", "description": "控除対象扶養親族等（フリガナ）1" }, "dependent_1_full_name": { "type": "string", "description": "控除対象扶養親族等（氏名）1" }, "dependent_1_non_resident": { "type": "string", "description": "控除対象扶養親族等（区分）1" }, "dependent_under_16_years_1_full_name_yomi": { "type": "string", "description": "16歳未満の扶養親族（フリガナ）1" }, "dependent_under_16_years_1_full_name": { "type": "string", "description": "16歳未満の扶養親族（氏名）1" }, "dependent_under_16_years_1_non_resident": { "type": "string", "description": "16歳未満の扶養親族（区分）1" }, "dependent_2_full_name_yomi": { "type": "string", "description": "控除対象扶養親族等（フリガナ）2" }, "dependent_2_full_name": { "type": "string", "description": "控除対象扶養親族等（氏名）2" }, "dependent_2_non_resident": { "type": "string", "description": "控除対象扶養親族等（区分）2" }, "dependent_under_16_years_2_full_name_yomi": { "type": "string", "description": "16歳未満の扶養親族（フリガナ）2" }, "dependent_under_16_years_2_full_name": { "type": "string", "description": "16歳未満の扶養親族（氏名）2" }, "dependent_under_16_years_2_non_resident": { "type": "string", "description": "16歳未満の扶養親族（区分）2" }, "dependent_3_full_name_yomi": { "type": "string", "description": "控除対象扶養親族等（フリガナ）3" }, "dependent_3_full_name": { "type": "string", "description": "控除対象扶養親族等（氏名）3" }, "dependent_3_non_resident": { "type": "string", "description": "控除対象扶養親族等（区分）3" }, "dependent_under_16_years_3_full_name_yomi": { "type": "string", "description": "16歳未満の扶養親族（フリガナ）3" }, "dependent_under_16_years_3_full_name": { "type": "string", "description": "16歳未満の扶養親族（氏名）3" }, "dependent_under_16_years_3_non_resident": { "type": "string", "description": "16歳未満の扶養親族（区分）3" }, "dependent_4_full_name_yomi": { "type": "string", "description": "控除対象扶養親族等（フリガナ）4" }, "dependent_4_full_name": { "type": "string", "description": "控除対象扶養親族等（氏名）4" }, "dependent_4_non_resident": { "type": "string", "description": "控除対象扶養親族等（区分）4" }, "dependent_under_16_years_4_full_name_yomi": { "type": "string", "description": "16歳未満の扶養親族（フリガナ）4" }, "dependent_under_16_years_4_full_name": { "type": "string", "description": "16歳未満の扶養親族（氏名）4" }, "dependent_under_16_years_4_non_resident": { "type": "string", "description": "16歳未満の扶養親族（区分）4" }, "underage": { "type": "string", "description": "未成年者" }, "foreigner": { "type": "string", "description": "外国人" }, "resigned_by_death": { "type": "string", "description": "死亡退職" }, "disaster_victim": { "type": "string", "description": "災害者" }, "column_b": { "type": "string", "description": "乙欄" }, "special_handicapped": { "type": "string", "description": "本人が障害者（特別）" }, "other_handicapped": { "type": "string", "description": "本人が障害者（その他）" }, "single_parent": { "type": "string", "description": "ひとり親" }, "widow": { "type": "string", "description": "寡婦" }, "special_widow": { "type": "string", "description": "寡婦（特別）" }, "widower": { "type": "string", "description": "寡夫" }, "working_student": { "type": "string", "description": "勤労学生" }, "mid_term_entered": { "type": "string", "description": "中途就職・退職（就職）" }, "mid_term_resigned": { "type": "string", "description": "中途就職・退職（退職）" }, "mid_term_entered_or_resigned_at": { "type": "string", "format": "date", "description": "中途就職・退職日" }, "resigned_at": { "type": "string", "format": "date", "description": "退職日" }, "crew_birth_at": { "type": "string", "format": "date", "description": "受給者生年月日" }, "biz_establishment_address_literal": { "type": "string", "description": "支払者（住所）" }, "owner_full_name": { "type": "string", "description": "支払者（氏名）" }, "biz_establishment_tel_number": { "type": "string", "description": "支払者（電話番号）" }, "basic_deduction_amount": { "type": "integer", "format": "int32", "description": "基礎控除の額" }, "income_adjustment_deduction_amount": { "type": "integer", "format": "int32", "description": "所得金額調整控除額" } }, "required": [ "id", "crew_id", "tax_withholding_id", "ref_date", "crew_address_literal", "crew_full_name_yomi", "crew_full_name", "slip_type", "crew_birth_at", "biz_establishment_address_literal", "owner_full_name" ], "description": "TaxWithholdingSlip model" }, "postV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlips": { "type": "object", "properties": { "crew_id": { "type": "string", "description": "従業員ID" }, "company_id": { "type": "string", "description": "会社ID" }, "values": { "type": "array", "description": "源泉徴収票情報", "items": { "type": "string" } } }, "required": [ "crew_id", "values" ], "description": "登録" }, "putV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId": { "type": "object", "properties": { "crew_id": { "type": "string", "description": "従業員ID" }, "values": { "type": "array", "description": "源泉徴収票情報", "items": { "type": "string" } } }, "required": [ "crew_id", "values" ], "description": "更新" }, "patchV1TaxWithholdingsTaxWithholdingIdTaxWithholdingSlipsId": { "type": "object", "properties": { "crew_id": { "type": "string", "description": "従業員ID" }, "values": { "type": "array", "description": "源泉徴収票情報", "items": { "type": "string" } } }, "required": [ "crew_id", "values" ], "description": "部分更新" }, "Payroll": { "type": "object", "properties": { "id": { "type": "string", "description": "給与ID" }, "payment_type": { "type": "string", "enum": [ "salary", "bonus" ], "description": "支給タイプ" }, "paid_at": { "type": "string", "format": "date", "description": "支給日" }, "period_start_at": { "type": "string", "format": "date", "description": "対象期間（From）" }, "period_end_at": { "type": "string", "format": "date", "description": "対象期間（To）" }, "source_type": { "type": "string", "enum": [ "file", "mf_cloud", "freee", "api" ], "description": "データの取り込み方法" }, "status": { "type": "string", "enum": [ "wip", "fixed", "failed", "importing" ], "description": "ステータス" }, "published_at": { "type": "string", "format": "date-time", "description": "公開時刻" }, "notify_with_publish": { "type": "boolean", "description": "公開と同時に通知を行なう" }, "numeral_system_handle_type": { "type": "string", "enum": [ "as_is", "force_sexagesimal", "force_decimal" ], "description": "記数法" }, "name_for_admin": { "type": "string", "description": "給与明細グループの名前（管理者向け）" }, "name_for_crew": { "type": "string", "description": "給与明細グループの名前（従業員向け）" } }, "required": [ "id", "payment_type", "paid_at", "period_start_at", "period_end_at", "source_type", "status", "notify_with_publish", "numeral_system_handle_type", "name_for_admin", "name_for_crew" ], "description": "Payroll model" }, "postV1Payrolls": { "type": "object", "properties": { "payment_type": { "type": "string", "description": "支給タイプ", "enum": [ "salary", "bonus" ] }, "paid_at": { "type": "string", "format": "date", "description": "支給日" }, "period_start_at": { "type": "string", "format": "date", "description": "対象期間（From）" }, "period_end_at": { "type": "string", "format": "date", "description": "対象期間（To）" }, "numeral_system_handle_type": { "type": "string", "description": "記数法", "enum": [ "as_is", "force_sexagesimal", "force_decimal" ] }, "name_for_admin": { "type": "string", "description": "給与明細グループの名前（管理者向け）" }, "name_for_crew": { "type": "string", "description": "給与明細グループの名前（従業員向け）" } }, "required": [ "payment_type", "paid_at", "period_start_at", "period_end_at", "numeral_system_handle_type", "name_for_admin", "name_for_crew" ], "description": "登録" }, "patchV1PayrollsId": { "type": "object", "properties": { "name_for_admin": { "type": "string", "description": "給与明細グループの名前（管理者向け）" }, "name_for_crew": { "type": "string", "description": "給与明細グループの名前（従業員向け）" } }, "required": [ "name_for_admin", "name_for_crew" ], "description": "部分更新" }, "patchV1PayrollsIdPublish": { "type": "object", "properties": { "published_at": { "type": "string", "format": "date-time", "description": "公開時刻" }, "notify_with_publish": { "type": "boolean", "description": "公開と同時に通知を行なう" } }, "description": "公開処理" }, "Payslip": { "type": "object", "properties": { "id": { "type": "string", "description": "給与明細ID" }, "crew_id": { "type": "string", "description": "従業員ID" }, "payroll_id": { "type": "string", "description": "給与明細グループID" }, "memo": { "type": "string", "description": "備考" }, "mismatch": { "type": "boolean", "description": "項目合計金額の不整合フラグ" }, "last_notified_at": { "type": "string", "format": "date-time", "description": "通知日時" }, "company_id": { "type": "string", "description": "会社ID" }, "company": { "allOf": [ { "$ref": "#/definitions/Company" } ], "description": "会社情報" }, "allowances": { "type": "array", "items": { "$ref": "#/definitions/Allowance" }, "description": "支給" }, "deductions": { "type": "array", "items": { "$ref": "#/definitions/Deduction" }, "description": "控除" }, "attendances": { "type": "array", "items": { "$ref": "#/definitions/Attendance" }, "description": "勤怠" }, "payroll_aggregates": { "type": "array", "items": { "$ref": "#/definitions/PayrollAggregate" }, "description": "合計" } }, "required": [ "id", "crew_id", "payroll_id" ], "description": "Payslip model" }, "Allowance": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "amount": { "type": "integer", "format": "int32", "description": "支給金額" } }, "required": [ "name", "amount" ] }, "Deduction": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "amount": { "type": "integer", "format": "int32", "description": "控除金額" } }, "required": [ "name", "amount" ] }, "Attendance": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "amount": { "type": "number", "format": "float", "description": "勤怠の日数・時間" }, "unit_type": { "type": "string", "enum": [ "hours", "days" ], "description": "単位" }, "numeral_system_type": { "type": "string", "enum": [ "decimal", "sexagesimal" ], "description": "記数法種別" }, "delimiter_type": { "type": "string", "enum": [ "period", "colon" ], "description": "区切り種別" } }, "required": [ "name", "amount", "unit_type" ] }, "PayrollAggregate": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "aggregate_type": { "type": "string", "enum": [ "net_payment", "total_payment", "deduction", "others" ], "description": "集計種別" }, "amount": { "type": "integer", "format": "int32", "description": "その他の金額" }, "value": { "type": "string", "description": "その他の値" } }, "required": [ "name", "aggregate_type" ] }, "API_V1_Entity_PayslipParams_Value": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } }, "required": [ "key", "value" ] }, "postV1PayrollsPayrollIdPayslips": { "type": "object", "properties": { "crew_id": { "type": "string", "description": "従業員ID" }, "memo": { "type": "string", "description": "備考" }, "company_id": { "type": "string", "description": "会社ID" }, "values": { "type": "array", "description": "給与明細情報", "items": { "$ref": "#/definitions/API_V1_Entity_PayslipParams_Value" } } }, "required": [ "crew_id", "values" ], "description": "登録" }, "postV1PayrollsPayrollIdPayslipsBulk": { "type": "object", "properties": { "payslips": { "type": "array", "description": "従業員ごとの給与明細情報", "items": { "$ref": "#/definitions/API_V1_Entity_PayslipParams_Value" } } }, "required": [ "payslips" ], "description": "一括登録" }, "BatchJob": { "type": "object", "properties": { "id": { "type": "string", "description": "バックグラウンド処理ID" }, "job_name": { "type": "string", "description": "処理名" }, "user_id": { "type": "string", "description": "実行したユーザーのID" }, "result_summary": { "type": "string", "description": "結果概要" }, "detail_url": { "type": "string", "description": "結果詳細URL" }, "finished_at": { "type": "string", "description": "完了時刻" }, "errored_at": { "type": "string", "description": "エラー時刻" }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" }, "attachments": { "type": "array", "items": { "$ref": "#/definitions/BatchJobAttachment" }, "description": "添付ファイル" } }, "required": [ "id", "job_name", "user_id", "result_summary", "detail_url", "finished_at", "errored_at", "created_at", "updated_at" ], "description": "BatchJob model" }, "BatchJobAttachment": { "type": "object", "properties": { "id": { "type": "string", "description": "バックグラウンド処理添付ファイルID" }, "file": { "type": "object", "properties": { "name": { "type": "string", "description": "名前" }, "content_type": { "type": "string", "description": "コンテントタイプ" }, "size": { "type": "string", "description": "サイズ" }, "deleted": { "type": "boolean", "description": "削除済みフラグ" } } }, "created_at": { "type": "string", "format": "date-time", "description": "作成日" }, "updated_at": { "type": "string", "format": "date-time", "description": "最終更新日" } }, "required": [ "id", "created_at", "updated_at" ] }, "postV1BatchJobsJobTypesCrewExport": { "type": "object", "properties": { "crew_export_format_id": { "type": "string", "description": "カスタムダウンロードフォーマットのID" } }, "required": [ "crew_export_format_id" ], "description": "従業員情報ダウンロードの登録" }, "postV1BatchJobsJobTypesCrewImport": { "type": "object", "properties": { "mode": { "type": "string", "description": "動作方式", "enum": [ "insert", "update" ] }, "file": { "type": "object", "properties": { "name": { "type": "string", "description": "ファイル名。CSV 形式か Excel 形式かを判定できる拡張子が必要" }, "content": { "type": "string", "description": "ファイルをBase64エンコーディングしたもの" } }, "required": [ "name", "content" ] } }, "required": [ "mode", "file" ], "description": "従業員一括登録・更新の登録" }, "postV1BatchJobsJobTypesDependentImport": { "type": "object", "properties": { "file": { "type": "object", "properties": { "name": { "type": "string", "description": "ファイル名。CSV 形式か Excel 形式かを判定できる拡張子が必要" }, "content": { "type": "string", "description": "ファイルをBase64エンコーディングしたもの" } }, "required": [ "name", "content" ] } }, "required": [ "file" ], "description": "家族情報一括更新の登録" } } }