/freee-api-skill

Expense applications

経費精算

GET /api/1/expense_applications — 経費申請一覧の取得

概要 指定した事業所の経費申請一覧を取得する 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 本APIでは、経費申請の一覧を取得することができます。

パラメータ

• company_id*: integer(int64) - 事業所ID
• status: string - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)、 取引ステータス(unsettled:清算待ち, settled:精算済み) (選択肢: draft, in_progress, approved, rejected, feedback, unsettled, settled)
• payroll_attached: boolean - true:給与連携あり、false:給与連携なし、未指定時:絞り込みなし
• start_transaction_date: string - 発生日(経費申請項目の日付)で絞込：開始日(yyyy-mm-dd)
• end_transaction_date: string - 発生日(経費申請項目の日付)で絞込：終了日(yyyy-mm-dd)
• application_number: integer(int64) - 申請No.
• title: string - 申請タイトル
• start_issue_date: string - 申請日で絞込：開始日(yyyy-mm-dd)
• end_issue_date: string - 申請日で絞込：終了日(yyyy-mm-dd)
• applicant_id: integer(int64) - 申請者のユーザーID
• approver_id: integer(int64) - 承認者のユーザーID
• min_amount: integer(int64) - 経費申請の合計金額で絞込：下限金額 (単位:円、以上)
• max_amount: integer(int64) - 経費申請の合計金額で絞込：上限金額 (単位:円、以下)
• offset: integer(int64) - 取得レコードのオフセット (デフォルト: 0)
• limit: integer(int64) - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)

レスポンス

• expense_applications*: array[object]

POST /api/1/expense_applications — 経費申請の作成

概要 指定した事業所の経費申請を作成する 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成（POST） 作成済みの申請の申請ステータス変更・更新する場合 申請の更新（PUT） 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行（POST） 申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです 承認者の指定に部門役職データ連携を活用した、以下のいずれかの承認ステップを含む申請経路にも対応しています。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 申請者がどの所属部門として申請するかは applicant_group_id で指定します。申請者が複数の部門に所属している場合は必須です。1段階...

リクエストボディ

• company_id*: integer(int64) - 事業所ID 例: 1 (最小: 1)

• title*: string - 申請タイトル (250文字以内) 例: 大阪出張

• issue_date: string - 申請日 (yyyy-mm-dd)

  指定しない場合は当日の日付が登録されます。 例: 2019-12-17

• description: string - 備考 (10000文字以内) 例: ◯◯連携先ID: cx12345

• section_id: integer(int64) - 部門ID 例: 101 (最小: 1)

• tag_ids: array[integer] - メモタグID

• purchase_lines: array[object] - 経費申請の申請行一覧（配列） 配列の要素:

  • receipt_id: integer(int64) - ファイルボックス（証憑ファイル）ID 例: 606 (最小: 1)
  • transaction_date*: string - 発生日(yyyy-mm-dd) 例: 2019-12-17
  • sub_receipt_ids: array[integer] - 補足資料（配列） receipt_id（証憑ファイル）を指定してください。 receipt_id（証憑ファイル）は5個まで指定できます
  • expense_application_lines: array[object] - 明細行一覧（配列）

• approval_flow_route_id: integer(int64) - 申請経路ID

  経費申請のステータスを申請中として作成する場合は、必ず指定してください。

  指定する申請経路IDは、申請経路APIを利用して取得してください。

  未指定の場合は、基本経路を設定している事業所では基本経路が、基本経路を設定していない事業所では利用可能な申請経路の中から最初の申請経路が自動的に使用されます。

  意図しない申請経路を持った経費申請の作成を防ぐために、使用する申請経路IDを指定することを推奨します。

  法人スタータープラン、法人スタンダードプラン（および旧法人ベーシックプラン）の事業所では以下のデフォルトで用意された申請経路のみ指定できます

  指定なし

  承認者を指定 例: 1 (最小: 1)

• approver_id: integer(int64) - 承認者のユーザーID

  「承認者を指定」の経路を申請経路として使用する場合に指定してください。

  指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。 例: 1 (最小: 1)

• applicant_group_id: integer(int64) - 申請者の所属部門ID

  「部門役職」の承認ステップを含む申請経路で、申請者がどの所属部門として申請するかを指定します。

  申請者が複数の部門に所属している場合は必須です。省略すると400エラーになります。

  申請者の所属部門が1つだけの場合は、省略するとその部門が採用されます。 例: 1 (最小: 1)

• approval_flow_group_id: integer(int64) - 申請経路の承認部門ID

  1段階目の承認ステップが部門選択型の場合に、承認させる部門を指定してください。 例: 1 (最小: 1)

• draft: boolean - 経費申請のステータス

  falseを指定した時は申請中（in_progress）で経費申請を作成します。

  trueを指定した時は下書き（draft）で経費申請を作成します。

  未指定の時は下書きとみなして経費申請を作成します。 例: true

• parent_id: integer(int64) - 親申請ID(法人アドバンスプラン（および旧法人プロフェッショナルプラン）, 法人エンタープライズプラン)

  承認済みの既存各種申請IDのみ指定可能です。

  各種申請一覧APIを利用して取得してください。

  親申請の種別を購買申請にする場合は parent_type に PurchaseRequest を指定してください。 例: 2 (最小: 1)

• parent_type: string - 親申請の種別 (parent_id を指定した場合のみ有効)

  ApprovalRequest: 各種申請 (parent_type 未指定時のデフォルト)

  PurchaseRequest: 購買申請

  上記以外の値を指定するとバリデーションエラーになります。 例: ApprovalRequest

• segment_1_tag_id: integer(int64) - セグメント１タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 1 (最小: 1)

• segment_2_tag_id: integer(int64) - セグメント２タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 2 (最小: 1)

• segment_3_tag_id: integer(int64) - セグメント３タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 3 (最小: 1)

レスポンス

• expense_application*: object

GET /api/1/expense_applications/{id} — 経費申請詳細の取得

概要 指定した事業所の経費申請を取得する 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 本APIは外貨には非対応です。外貨を利用する経費申請は取得できません。 本APIはカスタム申請項目には非対応です。カスタム申請項目を使用した経費申請は取得できません。 本APIは金額計算方法には非対応です。金額計算方法を設定した経費申請は取得できません。

パラメータ

• id* (path): integer(int64) - 経費申請ID
• company_id*: integer(int64) - 事業所ID

レスポンス

POST /api/1/expense_applications と同じ

PUT /api/1/expense_applications/{id} — 経費申請の更新

概要 指定した事業所の経費申請を更新する 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 本APIでは、経費申請を更新することができます。 本APIでは、status(申請ステータス): draft:下書き, feedback:差戻しのみ更新可能です。 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成（POST） 作成済みの申請の申請ステータス変更・更新する場合 申請の更新（PUT） 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行（POST） 申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです 承認者の指定に部門役職データ連携を活用した、以下のいずれかの承認ステップを含む申請経路にも対応しています。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部...

パラメータ

• id* (path): integer(int64) - 経費申請ID

リクエストボディ

• company_id*: integer(int64) - 事業所ID 例: 1 (最小: 1)

• title*: string - 申請タイトル (250文字以内) 例: 大阪出張

• issue_date: string - 申請日 (yyyy-mm-dd)

  指定しない場合は当日の日付が登録されます。 例: 2019-12-17

• description: string - 備考 (10000文字以内) 例: ◯◯連携先ID: cx12345

• section_id: integer(int64) - 部門ID 例: 101 (最小: 1)

• tag_ids: array[integer] - メモタグID

• purchase_lines: array[object] - 経費申請の申請行一覧（配列） 配列の要素:

  • id: integer(int64) - 経費申請の申請行ID: 既存申請行を更新する場合に指定します。IDを指定しない申請行は、新規行として扱われ追加されます。また、purchase_linesに含まれない既存の申請行は削除されます。更新後も残したい行は、必ず経費申請の申請行IDを指定してpurchase_linesに含めてください。 例: 1 (最小: 1)
  • transaction_date*: string - 発生日(yyyy-mm-dd) 例: 2019-12-17
  • receipt_id: integer(int64) - ファイルボックス（証憑ファイル）ID 例: 606 (最小: 1)
  • sub_receipt_ids: array[integer] - 補足資料（配列） receipt_id（証憑ファイル）を指定してください。 receipt_id（証憑ファイル）は5個まで指定できます
  • expense_application_lines: array[object] - 明細行一覧（配列）

• approval_flow_route_id: integer(int64) - 申請経路ID

  経費申請のステータスを申請中として作成する場合は、必ず指定してください。

  指定する申請経路IDは、申請経路APIを利用して取得してください。

  未指定の場合は、基本経路を設定している事業所では基本経路が、基本経路を設定していない事業所では利用可能な申請経路の中から最初の申請経路が自動的に使用されます。

  意図しない申請経路を持った経費申請の作成を防ぐために、使用する申請経路IDを指定することを推奨します。

  法人スタータープラン、法人スタンダードプラン（および旧法人ベーシックプラン）の事業所では以下のデフォルトで用意された申請経路のみ指定できます

  指定なし

  承認者を指定 例: 1 (最小: 1)

• approver_id: integer(int64) - 承認者のユーザーID

  指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。 例: 1 (最小: 1)

• applicant_group_id: integer(int64) - 申請者の所属部門ID

  「部門役職」の承認ステップを含む申請経路で、申請者がどの所属部門として申請するかを指定します。

  申請者が複数の部門に所属している場合は必須です。省略すると400エラーになります。

  申請者の所属部門が1つだけの場合は、省略するとその部門が採用されます。 例: 1 (最小: 1)

• approval_flow_group_id: integer(int64) - 申請経路の承認部門ID

  1段階目の承認ステップが部門選択型の場合に、承認させる部門を指定してください。 例: 1 (最小: 1)

• draft: boolean - 経費申請のステータス

  falseを指定した時は申請中（in_progress）で経費申請を更新します。

  trueを指定した時は下書き（draft）で経費申請を更新します。

  未指定の時は下書きとみなして経費申請を更新します。 例: true

• parent_id: integer(int64) - 親申請ID(法人アドバンスプラン（および旧法人プロフェッショナルプラン）, 法人エンタープライズプラン)

  承認済みの既存各種申請IDのみ指定可能です。

  各種申請一覧APIを利用して取得してください。

  親申請の種別を購買申請にする場合は parent_type に PurchaseRequest を指定してください。

  null を指定すると、現在設定されている親申請との関連付けを解除します。

  キーを指定しない場合、親申請は更新されません（他のフィールドと同じキー未指定=更新なしの挙動）。 例: 2 (最小: 1)

• parent_type: string - 親申請の種別 (parent_id を指定した場合のみ有効)

  ApprovalRequest: 各種申請 (parent_type 未指定時のデフォルト)

  PurchaseRequest: 購買申請

  上記以外の値を指定するとバリデーションエラーになります。 例: ApprovalRequest

• segment_1_tag_id: integer(int64) - セグメント１タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 1 (最小: 1)

• segment_2_tag_id: integer(int64) - セグメント２タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 2 (最小: 1)

• segment_3_tag_id: integer(int64) - セグメント３タグID

  セグメントタグ一覧の取得APIを利用して取得してください。

  セグメント（分析用タグ）の設定 例: 3 (最小: 1)

レスポンス

POST /api/1/expense_applications と同じ

DELETE /api/1/expense_applications/{id} — 経費申請の削除

概要 指定した事業所の経費申請を削除する 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成（POST） 作成済みの申請の申請ステータス変更・更新する場合 申請の更新（PUT） 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行（POST） 申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです 自分が申請者でない申請の削除が可能なのはユーザーの権限が管理者権限、且つ申請ステータスが差し戻しの場合のみです 本APIは駅すぱあと連携 (出発駅と到着駅から金額を自動入力する機能)には非対応です。駅すぱあと連携を使用した経費申請は削除できません。 本APIはカスタム申請項目には非対応です。カスタム申請項目を使用した経費申請は削除で...

パラメータ

GET /api/1/expense_applications/{id} と同じ

POST /api/1/expense_applications/{id}/actions — 経費申請の承認操作

概要 指定した事業所の経費申請の承認操作を行う 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 本APIでは、経費申請の承認操作（承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す）を行うことができます。 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、特権承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 初回申請の場合 申請の作成（POST） 作成済みの申請の申請ステータス変更・更新する場合 申請の更新（PUT） 申請中、承認済み、却下の申請の承認操作を行う場合 承認操作の実行（POST） 申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです 承認者の指定に部門役職データ連携を活用した、以下のいずれかの承認ステップを含む申請経路にも対応しています。 役職指定（申請者の所属部門） 役職指定（申請時に部門指定） 部門および役職指定 ...

パラメータ

PUT /api/1/expense_applications/{id} と同じ

リクエストボディ*

• company_id*: integer(int64) - 事業所ID 例: 1 (最小: 1)

• approval_action*: string - 操作(approve: 承認する、force_approve: 特権承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す) (選択肢: approve, force_approve, cancel, reject, feedback, force_feedback) 例: approve

• target_step_id*: integer(int64) - 対象承認ステップID 経費申請の取得APIレスポンス.current_step_idを送信してください。 例: 1 (最小: 1)

• target_round*: integer(int64) - 対象round。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。経費申請の取得APIレスポンス.current_roundを送信してください。 例: 1 (最小: 0, 最大: 2147483647)

• next_approver_id: integer(int64) - 次ステップの承認者のユーザーID 例: 1 (最小: 1)

• next_group_id: integer(int64) - 次ステップの承認部門ID

  次の承認ステップが部門選択型の場合に、承認させる部門を指定してください。 例: 1 (最小: 1)

レスポンス

POST /api/1/expense_applications と同じ

PUT /api/1/expense_applications/{id}/parent_approvable_requests — 経費申請に関連付ける各種申請の更新

概要 指定した事業所の経費申請に関連付ける各種申請の更新を行う 経費精算APIの使い方については、 freee会計経費精算APIの使い方 をご参照ください

注意点 本APIでは、経費申請に関連付ける各種申請を更新することができます。 本APIでは、status(申請ステータス): in_progress:申請中, approved:承認済みのみ更新可能です。 parent_idにnullを指定すると、現在設定されている各種申請との関連付けを解除できます。 申請ステータスが申請中の経費申請に対して関連付ける各種申請を更新するためには、以下の全てに当てはまる必要があります。 現在の承認ステップで承認者として指定されている、または特権承認ができる 申請フォームの設定で、承認者による経費申請に関連付ける各種申請の更新が許可されている 申請ステータスが承認済みの経費申請に対して関連付ける各種申請を更新するためには、以下の全てに当てはまる必要があります。 経費精算に対する閲覧および編集の権限を持ち、自分の経費申請のみに限定する制限がかかっていない 申請フォームの設定で、管理者による経費申請に関連付...

パラメータ

PUT /api/1/expense_applications/{id} と同じ

リクエストボディ*

• company_id*: integer(int64) - 事業所ID 例: 1 (最小: 1)
• parent_id*: integer(int64) - 各種申請ID
  • 経費申請に関連付ける各種申請IDを指定します
  • 閲覧権限のある承認済みの既存各種申請IDのみ指定ができます
  • 既に経費申請に紐付いている各種申請との関連は解除されます
  • 経費申請に紐付く各種申請を解除する場合はnullを指定してください 例: 1 (最小: 1)

レスポンス

POST /api/1/expense_applications と同じ