Rust API client for openapi

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

スタートガイド

freee API開発がはじめての方はfreee API スタートガイドを参照してください。

仕様

APIエンドポイント

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

認証について

OAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。

データフォーマット

リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄（application/jsonなど）を確認してください。

後方互換性ありの変更

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

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

共通レスポンスヘッダー

すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。

X-Request-Id
- 各リクエスト毎に発行されるID

共通エラーレスポンス

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://accounts.secure.freee.co.jp/contacts?from=payroll

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: 2022-02-01
Package version: 2022-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

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

cargo doc --open