Skip to content

Latest commit

 

History

History
133 lines (103 loc) · 6.84 KB

2021-01-05.md

File metadata and controls

133 lines (103 loc) · 6.84 KB

概要

2021年1月19日に、新サービス「マネーフォワード クラウド債務支払」がリリースされます。これに伴い、マネーフォワード クラウド経費の API についても仕様変更を含むアップデートを行います。この文書は、支払明細、支払申請、支払集計に関する変更点についてまとめたものです。

支払明細に関して

支払明細（ex_invoice_transaction） のエンドポイントには下記のものがあります。

  • GET /api/external/v1/offices/{office_id}/ex_invoice_transactions 事業者全体の支払明細リストを返す
  • GET /api/external/v1/offices/{office_id}/ex_journals_by_ex_invoice_transactions 事業者全体の支払明細に紐づく仕訳リストを返す

これらの API に変更はありません。

支払申請に関して

申請(ex_report) のエンドポイントには下記のものがあります。

  • GET /api/external/v1/offices/{office_id}/me/ex_reports 自分の申請リストを返す
  • GET /api/external/v1/offices/{office_id}/me/ex_reports/{id} 自分の申請を返す
  • GET /api/external/v1/offices/{office_id}/ex_reports 事業者全体の申請リストを返す
  • GET /api/external/v1/offices/{office_id}/ex_reports/{id} 事業者全体の申請を返す
  • GET /api/external/v1/offices/{office_id}/approving_ex_reports 事業者全体の承認待ちリストを返す
  • GET /api/external/v1/offices/{office_id}/me/approving_ex_reports 自分の承認待ちリストを返す
  • GET /api/external/v1/offices/{office_id}/ex_reports/{ex_report_id}/ex_journal 申請に対応する仕訳を返す
  • GET /api/external/v1/offices/{office_id}/ex_journals_by_ex_reports 事業者全体の申請に紐づく仕訳リストを返す

2020年の時点では、これらは下記のすべての申請を対象としていました。

  • 経費申請
  • 支払依頼申請
  • 事前各種申請

しかし、2021年のマネーフォワード クラウド債務支払 のリリースに伴い取得できる申請を変更します。

変更予定日 変更内容
2021年1月19日 クラウド債務支払をリリースします。この日以後は、支払依頼はクラウド経費で作ることができなくなります。過去にクラウド経費で作成した支払依頼は、既存のエンドポイントで引き続き取得できますが、新たに作られた支払依頼は取得できません。支払依頼を取得したい場合は、後述するエンドポイントをご利用ください。
2022年1月予定 既存のエンドポイントから、支払依頼が取得できなくなります。支払依頼を取得したい場合は、後述するエンドポイントをご利用ください。

エンドポイントの追加

支払依頼だけを操作対象とした下記のエンドポイントを追加します。

  • GET /api/external/v1/offices/{office_id}/me/invoice_reports 自分の支払依頼リストを返す
  • GET /api/external/v1/offices/{office_id}/me/invoice_reports/{id} 自分の支払依頼を返す
  • GET /api/external/v1/offices/{office_id}/invoice_reports 事業者全体の支払依頼リストを返す
  • GET /api/external/v1/offices/{office_id}/invoice_reports/{id} 事業者全体の支払依頼を返す

経費申請と違って、JSON キー名が変更となっており、一部の内容を省略しています。

  • ex_reports → invoice_reports
  • ex_report_approvals → report_approvals
  • approve_office_member → approve_office_member_id のみ

申請番号は AP から始まる文字列になりました。従来の数値で表現された申請番号が必要な場合は number_without_prefix 属性を使用してください。レスポンスのサンプルは下記のとおりです。

申請リストを返すエンドポイントのサンプル

{
  "invoice_reports": [
    {
      "id": "string",
      "office_member_id": "string",
      "number": "AP1",
      "number_without_prefix": 1,
      "title": "string",
      "submitted_at": "2020-12-29T16:43:14.651+09:00",
      "approved_at": "2020-12-29T16:43:14.651+09:00",
      "created_at": "2020-12-29T16:43:14.651+09:00",
      "updated_at": "2020-12-29T16:43:14.651+09:00",
      "status": "approved",
      "report_approvals": [
        {
          "step": 1,
          "is_active": true,
          "approved_at": "2020-12-29T16:43:14.651+09:00",
          "approve_office_member_id": "string"
        }
      ]
    }
  ],
  "next": "/api/external/v1/offices/XrB9-TG0I1o6KLTynyc36w/me/invoice_reports?page=3",
  "prev": "/api/external/v1/offices/XrB9-TG0I1o6KLTynyc36w/me/invoice_reports?page=1"
}

1個の申請を返すエンドポイントのサンプル

{
  "id": "string",
  "office_member_id": "string",
  "number": "AP1",
  "number_without_prefix": 1,
  "title": "string",
  "submitted_at": "2020-12-29T16:43:14.651+09:00",
  "approved_at": "2020-12-29T16:43:14.651+09:00",
  "created_at": "2020-12-29T16:43:14.651+09:00",
  "updated_at": "2020-12-29T16:43:14.651+09:00",
  "status": "approved",
  "report_approvals": [
    {
      "step": 1,
      "is_active": true,
      "approved_at": "2020-12-29T16:43:14.651+09:00",
      "approve_office_member_id": "string"
    }
  ]
}

支払集計に関して

支払集計(invoice_report_unit) のエンドポイントには下記のものがあります。

  • GET /api/external/v1/offices/{office_id}/invoice_report_units/ex_journals 支払集計の仕訳を返す
  • GET /api/external/v1/offices/{office_id}/invoice_report_unit_payments/ex_journals 支払集計の支払仕訳を返す
  • GET /api/external/v1/offices/{office_id}/invoice_report_units 支払集計のリストを返す
  • GET /api/external/v1/offices/{office_id}/invoice_report_units/{id} 支払集計を返す
  • GET /api/external/v1/offices/{office_id}/invoice_report_units/{invoice_report_unit_id}/ex_invoice_transactions 支払集計に含まれる支払明細リストを返す

2021年のマネーフォワード クラウド債務支払 のリリースに伴い取得できる支払集計を変更します。

変更予定日 変更内容
2021年1月19日 クラウド債務支払をリリースします。この日以後は、支払集計はクラウド経費で作ることができなくなります。過去にクラウド経費で作成した支払集計は、既存のエンドポイントで引き続き取得できますが、新たに作られた支払集計は取得できません。
2021年春予定 支払集計を取得するためのエンドポイントを新設します。現在仕様を検討中です。
2022年1月予定 支払集計に関する旧エンドポイントを廃止します。

以上です。不明点は https://github.com/moneyforward/expense-api-doc/issues よりお問い合わせ下さい。