工数管理API概要

freee 工数管理 APIでできること

APIを利用するための認証(OAuth2.0)については APIドキュメント および アクセストークンを取得する を参照してください。

ログインユーザーの情報を取得する

ログインユーザーの情報を取得することができます。ユーザーが複数の事業所に所属している場合は各事業所毎に情報が出力されます。ほとんどのfreee工数管理のAPIで必要なcompany_idはこのAPIを利用して取得してください。

GET /users/me

チームの一覧を取得する

指定した事業所のチーム一覧を取得することができます。チームの基本情報に加えて、チームメンバーの一覧、チームリーダーなどの情報を取得できます。

GET /teams

単価マスタの一覧を取得する

指定した事業所の単価マスタの一覧を取得することができます。単価に設定されている各適用期間と金額を全て取得することができます。

工数実績の一覧、詳細を取得する

指定した事業所の工数実績の一覧、詳細を取得することができます。対象従業員や対象年月などの各パラメータを指定した絞り込みができます。

GET /workloads
GET /workload_summaries

工数を登録する

指定した日付に対する工数を登録することができます。従業員の場合は自分自身、管理者の場合は従業員を指定した登録が可能です。

POST /workloads

プロジェクトの一覧を取得する

指定した事業所のチーム一覧を取得することができます。運用ステータス、マネージャー、発注先などで絞り込みできます。

GET /projects

プロジェクトの収支情報を取得する

指定したプロジェクトの収支情報を取得することができます。収支管理シートと同じ内容を取得できるため、その値を使って独自のレポートを作成することが可能です。

GET /projects/{id}

プロジェクトを登録する

プロジェクトを新規登録することができます。コードや名称と言った基本的な情報のほか、登録と同時にメンバーのアサインを行うこともできます。

POST /projects

以下も併せて参照してください

  • freee APIスタートガイド
    • 最初のAPIコールに必要な環境準備とセットアップ、ブラウザでのAPIコールの方法などについて触れています。
  • freee工数管理 APIリファレンス
    • freee工数管理 APIの仕様を確認できます。アクセストークンを取得するとブラウザからのAPIコールもできるようになっています。