public interface ApprovalRequestsApi
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Observable<ApprovalRequestResponse> |
createApprovalRequest(ApprovalRequestCreateParams approvalRequestCreateParams)
各種申請の作成
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請を作成する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、各種申請を作成することができます。</li> <li> 申請項目(request_items)については、申請フォームで設定された項目のIDとそれに対応する値を入力してください。 <ul> <li>タイトル(title)：文字列(改行なし) 例)予算申請</li> <li>1行コメント(single_line)：文字列(改行なし) 例)予算に関する申請</li> <li>複数行コメント(multi_line)：文字列(改行あり) <br> 例)<br> 予算に関する申請<br> 申請日 2020-01-01<br> </li> <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li> <li>日付(date)： 日付形式 例)2020-01-01</li> <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li> <li>添付ファイル(receipt)： ファイルボックスAPIのID 例)1</li> </ul> </li> <li> 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 <ul> <li> 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 <ul> <li> 初回申請の場合 <ul><li>申請の作成（POST）</li></ul> </li> <li> 作成済みの申請の申請ステータス変更・更新する場合 <ul><li>申請の更新（PUT）</li></ul> </li> <li> 申請中、承認済み、却下の申請の承認操作を行う場合 <ul><li>承認操作の実行（POST）</li></ul> </li> </ul> </li> <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li> </ul> </li> <li> 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で作成ができません。 <ul> <li>役職指定（申請者の所属部門）</li> <li>役職指定（申請時に部門指定）</li> <li>部門および役職指定</li> </ul> </li> <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本API利用前に各種申請の取得APIを利用し、最新の申請フォームを取得することを推奨します。</li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Completable |
destroyApprovalRequest(Integer id,
Integer companyId)
各種申請の削除
<h2 id=\"\">概要</h2> <p>指定した事業所の各種申請を削除する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li> 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 <ul> <li> 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 <ul> <li> 初回申請の場合 <ul><li>申請の作成（POST）</li></ul> </li> <li> 作成済みの申請の申請ステータス変更・更新する場合 <ul><li>申請の更新（PUT）</li></ul> </li> <li> 申請中、承認済み、却下の申請の承認操作を行う場合 <ul><li>承認操作の実行（POST）</li></ul> </li> </ul> </li> <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li> </ul> </li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<ApprovalRequestResponse> |
getApprovalRequest(Integer id,
Integer companyId)
各種申請の取得
<h2 id=\"\">概要</h2> <p>指定した事業所の各種申請を取得する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li> 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 <ul> <li>役職指定（申請者の所属部門）</li> <li>役職指定（申請時に部門指定）</li> <li>部門および役職指定</li> </ul> </li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<ApprovalRequestFormResponse> |
getApprovalRequestForm(Integer id,
Integer companyId)
各種申請の申請フォームの取得
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請の申請フォームを取得する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<InlineResponse200> |
getApprovalRequestForms(Integer companyId)
各種申請の申請フォーム一覧の取得
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請の申請フォーム一覧を取得する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<ApprovalRequestsIndexResponse> |
getApprovalRequests(Integer companyId,
String status,
Integer applicationNumber,
String title,
Integer formId,
String startApplicationDate,
String endApplicationDate,
Integer applicantId,
Integer approverId,
Integer offset,
Integer limit)
各種申請の一覧
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請一覧を取得する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、各種申請の一覧を取得することができます。</li> <li> 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。 <ul> <li>役職指定（申請者の所属部門）</li> <li>役職指定（申請時に部門指定）</li> <li>部門および役職指定</li> </ul> </li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<ApprovalRequestResponse> |
updateApprovalRequest(Integer id,
ApprovalRequestUpdateParams approvalRequestUpdateParams)
各種申請の更新
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請を更新する</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、各種申請を更新することができます。</li> <li> 申請項目(request_items)については、各種申請の取得APIで取得したrequest_items.idとそれに対応する値を入力してください。 <ul> <li>タイトル(title)：文字列(改行なし) 例)予算申請</li> <li>1行コメント(single_line)：文字列(改行なし) 例)予算に関する申請</li> <li>複数行コメント(multi_line)：文字列(改行あり) <br> 例)<br> 予算に関する申請<br> 申請日 2020-01-01<br> </li> <li>プルダウン(select)： プルダウンの選択肢の名前(改行なし) 例)開発部</li> <li>日付(date)： 日付形式 例)2020-01-01</li> <li>金額(amount)： 数値(申請フォームで設定した上限・下限金額内の値, 改行なし) 例)10000</li> <li>添付ファイル(receipt)： ファイルボックスAPIのID 例)1</li> </ul> </li> <li>本APIでは、status(申請ステータス): draft:下書き, feedback:差戻しのみ更新可能です。</li> <li> 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 <ul> <li> 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 <ul> <li> 初回申請の場合 <ul><li>申請の作成（POST）</li></ul> </li> <li> 作成済みの申請の申請ステータス変更・更新する場合 <ul><li>申請の更新（PUT）</li></ul> </li> <li> 申請中、承認済み、却下の申請の承認操作を行う場合 <ul><li>承認操作の実行（POST）</li></ul> </li> </ul> </li> <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li> </ul> </li> <li> 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請は本API経由で更新ができません。 <ul> <li>役職指定（申請者の所属部門）</li> <li>役職指定（申請時に部門指定）</li> <li>部門および役職指定</li> </ul> </li> <li>Web画面やAPIを通じて申請フォームが変更されると、本APIで使用する項目ID（request_itemsで指定するid）も変更されます。本APIで使用する項目IDは申請作成時点の項目IDです。本API利用前に各種申請の取得APIを利用し、申請作成時点の項目IDを取得することを推奨します。</li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
io.reactivex.Observable<ApprovalRequestResponse> |
updateApprovalRequestAction(Integer id,
ApprovalRequestActionCreateParams approvalRequestActionCreateParams)
各種申請の承認操作
<h2 id=\"_1\">概要</h2> <p>指定した事業所の各種申請の承認操作を行う</p> <p>各種申請APIの使い方については、<a href=\"https://developer.freee.co.jp/tips/accounting-approval-requests\" target=\"_blank\">会計freeeの各種申請APIの使い方</a>をご参照ください</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、各種申請の承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）を行うことができます。</li> <li> 申請ステータス(下書き、申請中)の指定と変更、及び承認操作（承認する、却下する、申請者へ差し戻す、代理承認する、承認済み・却下済みを取り消す）は以下を参考にして行ってください。 <ul> <li> 承認操作は申請ステータスが申請中、承認済み、却下のものだけが対象です。 <ul> <li> 初回申請の場合 <ul><li>申請の作成（POST）</li></ul> </li> <li> 作成済みの申請の申請ステータス変更・更新する場合 <ul><li>申請の更新（PUT）</li></ul> </li> <li> 申請中、承認済み、却下の申請の承認操作を行う場合 <ul><li>承認操作の実行（POST）</li></ul> </li> </ul> </li> <li>申請の削除（DELETE）が可能なのは申請ステータスが下書き、差戻しの場合のみです</li> </ul> </li> <li> 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している各種申請はAPI経由で承認ステータスの変更ができません。 <ul> <li>役職指定（申請者の所属部門）</li> <li>役職指定（申請時に部門指定）</li> <li>部門および役職指定</li> </ul> </li> <li>本APIはエンタープライズプランをご利用の事業所のみ利用可能です。</li> </ul>
|
@Headers(value="Content-Type:application/json") @POST(value="api/1/approval_requests") io.reactivex.Observable<ApprovalRequestResponse> createApprovalRequest(@Body ApprovalRequestCreateParams approvalRequestCreateParams)
approvalRequestCreateParams - 各種申請の作成 (optional)@DELETE(value="api/1/approval_requests/{id}")
io.reactivex.Completable destroyApprovalRequest(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 各種申請ID (required)companyId - 事業所ID (required)@GET(value="api/1/approval_requests/{id}")
io.reactivex.Observable<ApprovalRequestResponse> getApprovalRequest(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 各種申請ID (required)companyId - 事業所ID (required)@GET(value="api/1/approval_requests/forms/{id}")
io.reactivex.Observable<ApprovalRequestFormResponse> getApprovalRequestForm(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 申請フォームID (required)companyId - 事業所ID (required)@GET(value="api/1/approval_requests/forms") io.reactivex.Observable<InlineResponse200> getApprovalRequestForms(@Query(value="company_id") Integer companyId)
companyId - 事業所ID (required)@GET(value="api/1/approval_requests") io.reactivex.Observable<ApprovalRequestsIndexResponse> getApprovalRequests(@Query(value="company_id") Integer companyId, @Query(value="status") String status, @Query(value="application_number") Integer applicationNumber, @Query(value="title") String title, @Query(value="form_id") Integer formId, @Query(value="start_application_date") String startApplicationDate, @Query(value="end_application_date") String endApplicationDate, @Query(value="applicant_id") Integer applicantId, @Query(value="approver_id") Integer approverId, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit)
companyId - 事業所ID (required)status - 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) (optional)applicationNumber - 申請No. (optional)title - 申請タイトル (optional)formId - 申請フォームID (optional)startApplicationDate - 申請日で絞込：開始日(yyyy-mm-dd) (optional)endApplicationDate - 申請日で絞込：終了日(yyyy-mm-dd) (optional)applicantId - 申請者のユーザーID (optional)approverId - 承認者のユーザーID (optional)offset - 取得レコードのオフセット (デフォルト: 0) (optional)limit - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500) (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/approval_requests/{id}")
io.reactivex.Observable<ApprovalRequestResponse> updateApprovalRequest(@Path(value="id")
Integer id,
@Body
ApprovalRequestUpdateParams approvalRequestUpdateParams)
id - 各種申請ID (required)approvalRequestUpdateParams - 各種申請の更新 (required)@Headers(value="Content-Type:application/json")
@POST(value="api/1/approval_requests/{id}/actions")
io.reactivex.Observable<ApprovalRequestResponse> updateApprovalRequestAction(@Path(value="id")
Integer id,
@Body
ApprovalRequestActionCreateParams approvalRequestActionCreateParams)
id - 各種申請ID (required)approvalRequestActionCreateParams - 各種申請の承認操作 (required)Copyright © 2020. All rights reserved.