Rust API client for openapi

freee人事労務のAPI仕様です。

認証について

OAuth2.0を利用します。詳細はドキュメントの認証パートを参照してください。

エンドポイント

https://api.freee.co.jp/hr

後方互換性ありの変更

freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。

• 新しいAPIリソース・エンドポイントの追加
• 既存のAPIに対して必須ではない新しいリクエストパラメータの追加
• 既存のAPIレスポンスに対する新しいプロパティの追加
• 既存のAPIレスポンスに対するプロパティの順番の入れ変え
• keyとなっているidやcodeの長さの変更（長くする）

エラーレスポンス

APIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。

|ステータスコード|原因| |---|---| |400|リクエストパラメータが不正| |401|アクセストークンが無効| |403|アクセス権限がない| |404|リソースが存在しない| |429|リクエスト回数制限を越えた| |503|システム内で予期しないエラーが発生|

メッセージボディ内の messages にはエラー内容を説明する文字列が入ります。

{ \"status_code\": 400, \"errors\": [ { \"type\": \"bad_request\", \"messages\": [ \"リクエストの形式が不正です。\" ] } ] }

API使用制限

APIリクエストは1時間で5000回を上限としています。API使用ステータスはレスポンスヘッダに付与されます。

X-Ratelimit-Limit:5000 X-Ratelimit-Remaining:4998 X-Ratelimit-Reset:2018-01-01T12:00:00.000000Z

各ヘッダの意味は次のとおりです。

|ヘッダ名|説明| |---|---| |X-Ratelimit-Limit|使用回数の上限| |X-Ratelimit-Remaining|残り使用回数| |X-Ratelimit-Reset|使用回数がリセットされる時刻|

上記に加え、freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。 その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

For more information, please visit https://support.freee.co.jp/hc/ja/requests/new

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

• API version: v2022-02-01
• Package version: v2022-02-01
• Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:

openapi = { path = "./openapi" }

Documentation for API Endpoints

All URIs are relative to https://api.freee.co.jp/hr

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DefaultApi | actionapprovalrequestsmonthlyattendance | POST /api/v1/approvalrequests/monthlyattendances/{id}/actions | 月次勤怠締め申請の承認操作 DefaultApi | actionapprovalrequestsovertimework | POST /api/v1/approvalrequests/overtimeworks/{id}/actions | 残業申請の承認操作 DefaultApi | actionapprovalrequestspaidholiday | POST /api/v1/approvalrequests/paidholidays/{id}/actions | 有給申請の承認操作 DefaultApi | bulkupdateemployeedependentrules | PUT /api/v1/employees/{employeeid}/dependentrules/bulkupdate | 更新 *DefaultApi* | createapprovalrequestsmonthlyattendance | POST /api/v1/approvalrequests/monthlyattendances | 月次勤怠締め申請の作成 *DefaultApi* | createapprovalrequestsovertimework | POST /api/v1/approvalrequests/overtimeworks | 残業申請の作成 *DefaultApi* | createapprovalrequestspaidholiday | POST /api/v1/approvalrequests/paidholidays | 有給申請の作成 *DefaultApi* | createemployee | POST /api/v1/employees | 作成 DefaultApi | createemployeetimeclock | POST /api/v1/employees/{employeeid}/timeclocks | 打刻情報の登録 *DefaultApi* | creategroup | POST /api/v1/groups | 部門情報の作成 DefaultApi | createposition | POST /api/v1/positions | 役職情報の作成 *DefaultApi* | destroyapprovalrequestsmonthlyattendance | DELETE /api/v1/approvalrequests/monthlyattendances/{id} | 月次勤怠締め申請の削除 *DefaultApi* | destroyapprovalrequestsovertimework | DELETE /api/v1/approvalrequests/overtimeworks/{id} | 残業申請の削除 *DefaultApi* | destroyapprovalrequestspaidholiday | DELETE /api/v1/approvalrequests/paidholidays/{id} | 有給申請の削除 *DefaultApi* | destroyemployee | DELETE /api/v1/employees/{id} | 削除 DefaultApi | destroyemployeeworkrecord | DELETE /api/v1/employees/{employeeid}/workrecords/{date} | 削除 *DefaultApi* | destroygroup | DELETE /api/v1/groups/{id} | 部門情報の削除 DefaultApi | destroyposition | DELETE /api/v1/positions/{id} | 役職情報の削除 *DefaultApi* | getapprovalflowroute | GET /api/v1/approvalflowroutes/{id} | 申請経路の取得 DefaultApi | getapprovalflowroutes | GET /api/v1/approvalflowroutes | 申請経路一覧の取得 *DefaultApi* | getapprovalrequestsmonthlyattendance | GET /api/v1/approvalrequests/monthlyattendances/{id} | 月次勤怠締め申請の詳細取得 *DefaultApi* | getapprovalrequestsmonthlyattendances | GET /api/v1/approvalrequests/monthlyattendances | 月次勤怠締め申請の一覧取得 *DefaultApi* | getapprovalrequestsovertimework | GET /api/v1/approvalrequests/overtimeworks/{id} | 残業申請の詳細取得 *DefaultApi* | getapprovalrequestsovertimeworks | GET /api/v1/approvalrequests/overtimeworks | 残業申請の一覧取得 *DefaultApi* | getapprovalrequestspaidholiday | GET /api/v1/approvalrequests/paidholidays/{id} | 有給申請の詳細取得 *DefaultApi* | getapprovalrequestspaidholidays | GET /api/v1/approvalrequests/paidholidays | 有給申請の一覧取得 *DefaultApi* | getbonusesemployeepayrollstatement | GET /api/v1/bonuses/employeepayrollstatements/{employeeid} | 取得 DefaultApi | getbonusesemployeepayrollstatements | GET /api/v1/bonuses/employeepayrollstatements | 一覧の取得 DefaultApi | getcompanyemployees | GET /api/v1/companies/{companyid}/employees | 一覧の取得 *DefaultApi* | getemployee | GET /api/v1/employees/{id} | 取得 DefaultApi | getemployeebankaccountrule | GET /api/v1/employees/{employeeid}/bankaccountrule | 取得 *DefaultApi* | getemployeebasicpayrule | GET /api/v1/employees/{employeeid}/basicpayrule | 取得 DefaultApi | getemployeedependentrules | GET /api/v1/employees/{employeeid}/dependentrules | 取得 *DefaultApi* | getemployeegroupmemberships | GET /api/v1/employeegroupmemberships | 一覧の取得 DefaultApi | getemployeehealthinsurancerule | GET /api/v1/employees/{employeeid}/healthinsurancerule | 取得 *DefaultApi* | getemployeeprofilerule | GET /api/v1/employees/{employeeid}/profilerule | 取得 DefaultApi | getemployeetimeclock | GET /api/v1/employees/{employeeid}/timeclocks/{id} | 打刻情報の詳細取得 *DefaultApi* | getemployeetimeclocks | GET /api/v1/employees/{employeeid}/timeclocks | 打刻情報の一覧取得 DefaultApi | getemployeetimeclocksavailabletypes | GET /api/v1/employees/{employeeid}/timeclocks/availabletypes | 打刻可能種別の取得 DefaultApi | getemployeewelfarepensioninsurancerule | GET /api/v1/employees/{employeeid}/welfarepensioninsurancerule | 取得 *DefaultApi* | getemployeeworkrecord | GET /api/v1/employees/{employeeid}/workrecords/{date} | 取得 DefaultApi | getemployeeworkrecordsummary | GET /api/v1/employees/{employeeid}/workrecordsummaries/{year}/{month} | 勤怠情報月次サマリの取得 *DefaultApi* | getemployees | GET /api/v1/employees | 一覧の取得 DefaultApi | getgroups | GET /api/v1/groups | 部門情報の一覧取得 *DefaultApi* | getpositions | GET /api/v1/positions | 役職情報の一覧取得 DefaultApi | getsalariesemployeepayrollstatement | GET /api/v1/salaries/employeepayrollstatements/{employeeid} | 取得 *DefaultApi* | getsalariesemployeepayrollstatements | GET /api/v1/salaries/employeepayrollstatements | 一覧の取得 *DefaultApi* | getusersme | GET /api/v1/users/me | 取得 *DefaultApi* | updateapprovalrequestsmonthlyattendance | PUT /api/v1/approvalrequests/monthlyattendances/{id} | 月次勤怠締め申請の更新 *DefaultApi* | updateapprovalrequestsovertimework | PUT /api/v1/approvalrequests/overtimeworks/{id} | 残業申請の更新 *DefaultApi* | updateapprovalrequestspaidholiday | PUT /api/v1/approvalrequests/paidholidays/{id} | 有給申請の更新 *DefaultApi* | updateemployee | PUT /api/v1/employees/{id} | 更新 DefaultApi | updateemployeebankaccountrule | PUT /api/v1/employees/{employeeid}/bankaccountrule | 更新 *DefaultApi* | updateemployeebasicpayrule | PUT /api/v1/employees/{employeeid}/basicpayrule | 更新 DefaultApi | updateemployeehealthinsurancerule | PUT /api/v1/employees/{employeeid}/healthinsurancerule | 更新 *DefaultApi* | updateemployeeprofilerule | PUT /api/v1/employees/{employeeid}/profilerule | 更新 DefaultApi | updateemployeewelfarepensioninsurancerule | PUT /api/v1/employees/{employeeid}/welfarepensioninsurancerule | 更新 *DefaultApi* | updateemployeeworkrecord | PUT /api/v1/employees/{employeeid}/workrecords/{date} | 更新 DefaultApi | updateemployeeworkrecordsummary | PUT /api/v1/employees/{employeeid}/workrecordsummaries/{year}/{month} | 勤怠情報月次サマリの更新 *DefaultApi* | updategroup | PUT /api/v1/groups/{id} | 部門情報の更新 DefaultApi | update_position | PUT /api/v1/positions/{id} | 役職情報の更新

Documentation For Models

• AccessDeniedError
• ApiV1ApprovalActionRequest
• ApiV1ApprovalFlowLogsParams
• ApiV1ApprovalFlowRouteIndexResponseParams
• ApiV1ApprovalFlowRouteResponse
• ApiV1ApprovalFlowRouteResponseParams
• ApiV1ApprovalFlowRoutesIndexResponse
• ApiV1BonusesEmployeePayrollStatementSerializer
• ApiV1BonusesEmployeePayrollStatementsControllerPeriodShowResponse
• ApiV1BonusesEmployeePayrollStatementsIndexSerializer
• ApiV1CompaniesEmployeeSerializer
• ApiV1EmployeeCreateRequestSerializer
• ApiV1EmployeeGroupMembershipSerializer
• ApiV1EmployeeGroupMembershipsIndexSerializer
• ApiV1EmployeePayrollStatementsEmployeeAttendanceItemSerializer
• ApiV1EmployeePayrollStatementsEmployeeOvertimePayItemSerializer
• ApiV1EmployeePayrollStatementsEmployeePayrollStatementItemSerializer
• ApiV1EmployeeSerializer
• ApiV1EmployeeUpdateRequestSerializer
• ApiV1EmployeesBankAccountRuleSerializer
• ApiV1EmployeesBankAccountRuleUpdateRequestSerializer
• ApiV1EmployeesBankAccountRulesControllerPeriodShowResponse
• ApiV1EmployeesBankAccountRulesControllerPeriodUpdateBody
• ApiV1EmployeesBankAccountRulesControllerPeriodUpdateResponse
• ApiV1EmployeesBasicPayRuleSerializer
• ApiV1EmployeesBasicPayRuleUpdateRequestSerializer
• ApiV1EmployeesBasicPayRulesControllerPeriodShowResponse
• ApiV1EmployeesBasicPayRulesControllerPeriodUpdateBody
• ApiV1EmployeesBasicPayRulesControllerPeriodUpdateResponse
• ApiV1EmployeesControllerPeriodCreateBody
• ApiV1EmployeesControllerPeriodCreateResponse
• ApiV1EmployeesControllerPeriodShowResponse
• ApiV1EmployeesControllerPeriodUpdateBody
• ApiV1EmployeesControllerPeriodUpdateResponse
• ApiV1EmployeesDependentRuleSerializer
• ApiV1EmployeesDependentRuleUpdateRequestSerializer
• ApiV1EmployeesDependentRulesControllerPeriodBulkUpdateBody
• ApiV1EmployeesDependentRulesControllerPeriodBulkUpdateResponse
• ApiV1EmployeesDependentRulesControllerPeriodIndexResponse
• ApiV1EmployeesEmployeeMultiHourlyWageWorkRecordSummarySerializer
• ApiV1EmployeesHealthInsuranceRuleSerializer
• ApiV1EmployeesHealthInsuranceRuleUpdateRequestSerializer
• ApiV1EmployeesHealthInsuranceRulesControllerPeriodShowResponse
• ApiV1EmployeesHealthInsuranceRulesControllerPeriodUpdateBody
• ApiV1EmployeesHealthInsuranceRulesControllerPeriodUpdateResponse
• ApiV1EmployeesIndexSerializer
• ApiV1EmployeesProfileRuleSerializer
• ApiV1EmployeesProfileRuleUpdateRequestSerializer
• ApiV1EmployeesProfileRulesControllerPeriodShowResponse
• ApiV1EmployeesProfileRulesControllerPeriodUpdateBody
• ApiV1EmployeesProfileRulesControllerPeriodUpdateResponse
• ApiV1EmployeesTimeClockSerializer
• ApiV1EmployeesTimeClocksControllerPeriodAvailableTypesResponse
• ApiV1EmployeesTimeClocksControllerPeriodCreateBody
• ApiV1EmployeesTimeClocksControllerPeriodCreateResponse
• ApiV1EmployeesTimeClocksControllerPeriodShowResponse
• ApiV1EmployeesWelfarePensionInsuranceRuleSerializer
• ApiV1EmployeesWelfarePensionInsuranceRuleUpdateRequestSerializer
• ApiV1EmployeesWelfarePensionInsuranceRulesControllerPeriodShowResponse
• ApiV1EmployeesWelfarePensionInsuranceRulesControllerPeriodUpdateBody
• ApiV1EmployeesWelfarePensionInsuranceRulesControllerPeriodUpdateResponse
• ApiV1EmployeesWorkRecordSerializer
• ApiV1EmployeesWorkRecordSummaryControllerPeriodUpdateBody
• ApiV1EmployeesWorkRecordSummarySerializer
• ApiV1EmployeesWorkRecordTimeRangeResponseSerializer
• ApiV1EmployeesWorkRecordTimeRangeSerializer
• ApiV1EmployeesWorkRecordsControllerPeriodUpdateBody
• ApiV1FlowRouteStepSrializerInner
• ApiV1GroupCreateRequest
• ApiV1GroupCreateRequestParams
• ApiV1GroupMembershipSerializer
• ApiV1GroupResponse
• ApiV1GroupResponseParams
• ApiV1GroupUpdateRequest
• ApiV1GroupUpdateRequestParams
• ApiV1GroupsIndexResponse
• ApiV1HolidaysAndHoursSerializer
• ApiV1MonthlyAttendanceCreateRequest
• ApiV1MonthlyAttendanceIndexResponse
• ApiV1MonthlyAttendanceIndexResponseParams
• ApiV1MonthlyAttendanceResponse
• ApiV1MonthlyAttendanceResponseParams
• ApiV1MonthlyAttendanceUpdateRequest
• ApiV1OvertimeWorkIndexResponse
• ApiV1OvertimeWorkIndexResponseParams
• ApiV1OvertimeWorkRequest
• ApiV1OvertimeWorkResponse
• ApiV1OvertimeWorkResponseParams
• ApiV1PaidHolidayIndexResponse
• ApiV1PaidHolidayIndexResponseParams
• ApiV1PaidHolidayRequest
• ApiV1PaidHolidayResponse
• ApiV1PaidHolidayResponseParams
• ApiV1PositionIndexResponse
• ApiV1PositionRequest
• ApiV1PositionRequestParams
• ApiV1PositionResponse
• ApiV1PositionResponseParams
• ApiV1SalariesEmployeePayrollStatementSerializer
• ApiV1SalariesEmployeePayrollStatementsControllerPeriodIndexResponse
• ApiV1SalariesEmployeePayrollStatementsControllerPeriodShowResponse
• ApiV1UsersCompanySerializer
• ApiV1UsersMeSerializer
• Error
• ErrorErrorsInner
• ForbiddenError
• ForbiddenErrorErrorsInner
• InternalServerError
• InternalServerErrorErrorsInner
• NotfoundError
• NotfoundErrorErrorsInner
• UnauthorizedError

To get access to the crate's generated documentation, use:

cargo doc --open

Author