Skip to content

Commit

Permalink
Merge pull request #426 from freee/feature/update_schema_files_2024-0…
Browse files Browse the repository at this point in the history 
…4-26-05-18

Update schema files
  • Loading branch information
@ArumetaM
ArumetaM authored Apr 26, 2024
2 parents 889e014 + 48f78e7 commit c55b12d
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions v2020_06_15/open-api-3/api-schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15489,7 +15489,7 @@
"Approval requests"
],
"summary": "各種申請の作成",
"description": "\n<h2 id=\"_1\">概要</h2>\n\n<p>指定した事業所の各種申請を作成する</p>\n\n<p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">freee会計の各種申請APIの使い方</a>をご参照ください</p>\n\n<h2 id=\"_2\">注意点</h2>\n<ul>\n <li>本APIでは、各種申請を作成することができます。</li>\n <li>\n 申請項目(request_items)については、申請フォームで設定された項目のIDとそれに対応する値を入力してください。\n <ul>\n <li>タイトル(title)：文字列(改行なし) 例)予算申請</li>\n <li>1行コメント(single_line)：文字列(改行なし) 例)予算に関する申請</li>\n <li>複数行コメント(multi_line)：文字列(改行あり)\n <br>\n &nbsp;&nbsp;例)<br>\n &nbsp;&nbsp;予算に関する申請<br>\n &nbsp;&nbsp;申請日 2019-12-17<br>\n </li>\n <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li>\n <li>日付(date)： 日付形式 例)2019-12-17</li>\n <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li>\n <li>添付ファイル(receipt)： ファイルボックス（証憑ファイル）APIのID 例)1</li>\n <li>部門ID(section)： 部門APIのID 例)1</li>\n <li>取引先ID(partner)： 取引先APIのID 例)1</li>\n </ul>\n </li>\n <li>\n 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。\n <ul>\n <li>\n 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。\n <ul>\n <li>\n 初回申請の場合\n <ul><li>申請の作成（POST）</li></ul>\n </li>\n <li>\n 作成済みの申請の申請ステータス変更・更新する場合\n <ul><li>申請の更新（PUT）</li></ul>\n </li>\n <li>\n 申請中、承認済み、却下の申請の承認操作を行う場合\n <ul><li>承認操作の実行（POST）</li></ul>\n </li>\n </ul>\n </li>\n <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li>\n </ul>\n </li>\n <li>\n 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で作成ができません。\n <ul>\n <li>役職指定（申請者の所属部門）</li>\n <li>役職指定（申請時に部門指定）</li>\n <li>部門および役職指定</li>\n </ul>\n </li>\n <li>\n 申請フォームの項目に契約書（freeeサイン連携）が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。\n </li>\n <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本API利用前に各種申請の取得APIを利用し、最新の申請フォームを取得することを推奨します。</li>\n <li>本APIはプロフェッショナルプラン、エンタープライズプランをご利用の事業所のみ利用可能です。</li>\n</ul>",
"description": "\n<h2 id=\"_1\">概要</h2>\n\n<p>指定した事業所の各種申請を作成する</p>\n\n<p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">freee会計の各種申請APIの使い方</a>をご参照ください</p>\n\n<h2 id=\"_2\">注意点</h2>\n<ul>\n <li>本APIでは、各種申請を作成することができます。</li>\n <li>\n 申請項目(request_items)については、申請フォームで設定された項目のIDとそれに対応する値を入力してください。\n <ul>\n <li>タイトル(title)：文字列(必須項目, 255文字まで, 改行なし) 例)予算申請</li>\n <li>1行コメント(single_line)：文字列(255文字まで, 改行なし) 例)予算に関する申請</li>\n <li>複数行コメント(multi_line)：文字列(1000文字まで, 改行あり)\n <br>\n &nbsp;&nbsp;例)<br>\n &nbsp;&nbsp;予算に関する申請<br>\n &nbsp;&nbsp;申請日 2019-12-17<br>\n </li>\n <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li>\n <li>日付(date)： 日付形式 例)2019-12-17</li>\n <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li>\n <li>添付ファイル(receipt)： ファイルボックス（証憑ファイル）APIのID 例)1\n <ul>\n <li>ファイルボックスを参照できる権限が必要</li>\n <li>自分のアップロードしたファイルのみ参照可能な権限のユーザーの場合、他ユーザーがアップロードしたファイルを指定できません</li>\n </ul>\n </li>\n <li>部門ID(section)： 部門APIのID 例)1</li>\n <ul>\n <li>親部門は入力できません</li>\n <li>ユーザーの所属するグループで利用不可な部門は入力できません</li>\n </ul>\n <li>取引先ID(partner)： 取引先APIのID 例)1</li>\n </ul>\n </li>\n <li>申請項目に項目ID, 項目タイプの組み合わせが重複したものを入力できません</li>\n <li>\n 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。\n <ul>\n <li>\n 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。\n <ul>\n <li>\n 初回申請の場合\n <ul><li>申請の作成（POST）</li></ul>\n </li>\n <li>\n 作成済みの申請の申請ステータス変更・更新する場合\n <ul><li>申請の更新（PUT）</li></ul>\n </li>\n <li>\n 申請中、承認済み、却下の申請の承認操作を行う場合\n <ul><li>承認操作の実行（POST）</li></ul>\n </li>\n </ul>\n </li>\n <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li>\n </ul>\n </li>\n <li>\n 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で作成ができません。\n <ul>\n <li>役職指定（申請者の所属部門）</li>\n <li>役職指定（申請時に部門指定）</li>\n <li>部門および役職指定</li>\n </ul>\n </li>\n <li>\n 申請フォームの項目に契約書（freeeサイン連携）が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。\n </li>\n <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本API利用前に各種申請の取得APIを利用し、最新の申請フォームを取得することを推奨します。</li>\n <li>申請中の申請を作成に成功した場合、申請者へメール、モバイルプッシュ、slack による通知をします\n <ul>\n <li>Webhook を有効にした事業所の場合は Webhook にも通知をします</li>\n </ul>\n </li>\n <li>本APIはプロフェッショナルプラン、エンタープライズプランをご利用の事業所のみ利用可能です。</li>\n</ul>",
"operationId": "create_approval_request",
"requestBody": {
"description": "各種申請の作成",
Expand Down Expand Up @@ -15667,7 +15667,7 @@
"Approval requests"
],
"summary": "各種申請の更新",
"description": "\n<h2 id=\"_1\">概要</h2>\n\n<p>指定した事業所の各種申請を更新する</p>\n\n<p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">freee会計の各種申請APIの使い方</a>をご参照ください</p>\n\n<h2 id=\"_2\">注意点</h2>\n<ul>\n <li>本APIでは、各種申請を更新することができます。</li>\n <li>\n 申請項目(request_items)については、各種申請の取得APIで取得したrequest_items.idとそれに対応する値を入力してください。\n <ul>\n <li>タイトル(title)：文字列(改行なし) 例)予算申請</li>\n <li>1行コメント(single_line)：文字列(改行なし) 例)予算に関する申請</li>\n <li>複数行コメント(multi_line)：文字列(改行あり)\n <br>\n &nbsp;&nbsp;例)<br>\n &nbsp;&nbsp;予算に関する申請<br>\n &nbsp;&nbsp;申請日 2019-12-17<br>\n </li>\n <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li>\n <li>日付(date)： 日付形式 例)2019-12-17</li>\n <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li>\n <li>添付ファイル(receipt)： ファイルボックス（証憑ファイル）APIのID 例)1</li>\n <li>部門ID(section)： 部門APIのID 例)1</li>\n <li>取引先ID(partner)： 取引先APIのID 例)1</li>\n </ul>\n </li>\n <li>本APIでは、status(申請ステータス): draft:下書き, feedback:差戻しのみ更新可能です。</li>\n <li>\n 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。\n <ul>\n <li>\n 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。\n <ul>\n <li>\n 初回申請の場合\n <ul><li>申請の作成（POST）</li></ul>\n </li>\n <li>\n 作成済みの申請の申請ステータス変更・更新する場合\n <ul><li>申請の更新（PUT）</li></ul>\n </li>\n <li>\n 申請中、承認済み、却下の申請の承認操作を行う場合\n <ul><li>承認操作の実行（POST）</li></ul>\n </li>\n </ul>\n </li>\n <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li>\n </ul>\n </li>\n <li>\n 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で更新ができません。\n <ul>\n <li>役職指定（申請者の所属部門）</li>\n <li>役職指定（申請時に部門指定）</li>\n <li>部門および役職指定</li>\n </ul>\n </li>\n <li>\n 申請フォームの項目に契約書（freeeサイン連携）が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。\n </li>\n <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本APIで使用する項目IDは申請作成時点の項目IDです。本API利用前に各種申請の取得APIを利用し、申請作成時点の項目IDを取得することを推奨します。</li>\n <li>本APIはプロフェッショナルプラン、エンタープライズプランをご利用の事業所のみ利用可能です。</li>\n</ul>",
"description": "\n<h2 id=\"_1\">概要</h2>\n\n<p>指定した事業所の各種申請を更新する</p>\n\n<p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">freee会計の各種申請APIの使い方</a>をご参照ください</p>\n\n<h2 id=\"_2\">注意点</h2>\n<ul>\n <li>本APIでは、各種申請を更新することができます。</li>\n <li>\n 申請項目(request_items)については、各種申請の取得APIで取得したrequest_items.idとそれに対応する値を入力してください。\n <ul>\n <li>タイトル(title)：文字列(必須項目, 255文字まで, 改行なし) 例)予算申請</li>\n <li>1行コメント(single_line)：文字列(255文字まで, 改行なし) 例)予算に関する申請</li>\n <li>複数行コメント(multi_line)：文字列(1000文字まで, 改行あり)\n <br>\n &nbsp;&nbsp;例)<br>\n &nbsp;&nbsp;予算に関する申請<br>\n &nbsp;&nbsp;申請日 2019-12-17<br>\n </li>\n <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li>\n <li>日付(date)： 日付形式 例)2019-12-17</li>\n <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li>\n <li>添付ファイル(receipt)： ファイルボックス（証憑ファイル）APIのID 例)1\n <ul>\n <li>ファイルボックスを参照できる権限が必要</li>\n <li>自分のアップロードしたファイルのみ参照可能な権限のユーザーの場合、他ユーザーがアップロードしたファイルを指定できません</li>\n </ul>\n </li>\n <li>部門ID(section)： 部門APIのID 例)1</li>\n <ul>\n <li>親部門は入力できません</li>\n <li>ユーザーの所属するグループで利用不可な部門は入力できません</li>\n </ul>\n <li>取引先ID(partner)： 取引先APIのID 例)1</li>\n </ul>\n </li>\n <li>申請項目に項目ID, 項目タイプの組み合わせが重複したものを入力できません</li>\n <li>本APIでは、status(申請ステータス): draft:下書き, feedback:差戻しのみ更新可能です。</li>\n <li>\n 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。\n <ul>\n <li>\n 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。\n <ul>\n <li>\n 初回申請の場合\n <ul><li>申請の作成（POST）</li></ul>\n </li>\n <li>\n 作成済みの申請の申請ステータス変更・更新する場合\n <ul><li>申請の更新（PUT）</li></ul>\n </li>\n <li>\n 申請中、承認済み、却下の申請の承認操作を行う場合\n <ul><li>承認操作の実行（POST）</li></ul>\n </li>\n </ul>\n </li>\n <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li>\n </ul>\n </li>\n <li>\n 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で更新ができません。\n <ul>\n <li>役職指定（申請者の所属部門）</li>\n <li>役職指定（申請時に部門指定）</li>\n <li>部門および役職指定</li>\n </ul>\n </li>\n <li>\n 申請フォームの項目に契約書（freeeサイン連携）が利用されている各種申請については、API経由で参照は可能ですが、作成と更新ができません。\n </li>\n <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本APIで使用する項目IDは申請作成時点の項目IDです。本API利用前に各種申請の取得APIを利用し、申請作成時点の項目IDを取得することを推奨します。</li>\n <li>申請中の申請を作成に成功した場合、申請者へメール、モバイルプッシュ、slack による通知をします\n <ul>\n <li>申請を共有している場合、共有者へメール、slack による通知をします</li>\n <li>Webhook を有効にした事業所の場合は Webhook にも通知をします</li>\n </ul>\n </li>\n <li>本APIはプロフェッショナルプラン、エンタープライズプランをご利用の事業所のみ利用可能です。</li>\n</ul>",
"operationId": "update_approval_request",
"parameters": [
{
Expand Down

0 comments on commit c55b12d

Please sign in to comment.