jp.co.freee.accounting.api

Interface ReceiptsApi

public interface ReceiptsApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<ReceiptResponse>	createReceipt(Integer companyId, okhttp3.MultipartBody.Part receipt, String description, String issueDate) ファイルボックス 証憑ファイルアップロード <h2 id=\"\">概要</h2> <p>ファイルボックスに証憑ファイルをアップロードする</p> <h2 id=\"_2\">注意点</h2> <ul> <li>リクエストヘッダーの Content-Type は、multipart/form-dataにのみ対応しています。</li> </ul>
io.reactivex.Completable	destroyReceipt(Integer id, Integer companyId) ファイルボックス 証憑ファイルを削除する <h2 id=\"\">概要</h2> <p>ファイルボックスの証憑ファイルを削除する</p>
io.reactivex.Observable<ReceiptResponse>	getReceipt(Integer id, Integer companyId) ファイルボックス 証憑ファイルの取得 <h2 id=\"\">概要</h2> <p>指定した事業所のファイルボックス 証憑ファイルを取得する</p>
io.reactivex.Observable<InlineResponse2008>	getReceipts(Integer companyId, String startDate, String endDate, String userName, Integer number, String commentType, Boolean commentImportant, String category, Integer offset, Integer limit) ファイルボックス 証憑ファイル一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所のファイルボックス 証憑ファイル一覧を取得する</p>
io.reactivex.Observable<ReceiptResponse>	updateReceipt(Integer id, ReceiptUpdateParams receiptUpdateParams) ファイルボックス 証憑ファイル情報更新 <h2 id=\"\">概要</h2> <p>ファイルボックスの証憑ファイル情報を更新する</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、証憑ファイルの再アップロードはできません。</li> </ul>

Method Detail

createReceipt

@Multipart
 @POST(value="api/1/receipts")
io.reactivex.Observable<ReceiptResponse> createReceipt(@Part(value="company_id")
                                                                                                 Integer companyId,
                                                                                                 @Part
                                                                                                 okhttp3.MultipartBody.Part receipt,
                                                                                                 @Part(value="description")
                                                                                                 String description,
                                                                                                 @Part(value="issue_date")
                                                                                                 String issueDate)

ファイルボックス 証憑ファイルアップロード <h2 id=\"\">概要</h2> <p>ファイルボックスに証憑ファイルをアップロードする</p> <h2 id=\"_2\">注意点</h2> <ul> <li>リクエストヘッダーの Content-Type は、multipart/form-dataにのみ対応しています。</li> </ul>

Parameters:

companyId - 事業所ID (required)

receipt - 証憑ファイル (required)

description - メモ (255文字以内) (optional)

issueDate - 取引日 (yyyy-mm-dd) (optional)

Returns:

Observable<ReceiptResponse>

destroyReceipt

@DELETE(value="api/1/receipts/{id}")
io.reactivex.Completable destroyReceipt(@Path(value="id")
                                                                             Integer id,
                                                                             @Query(value="company_id")
                                                                             Integer companyId)

ファイルボックス 証憑ファイルを削除する <h2 id=\"\">概要</h2> <p>ファイルボックスの証憑ファイルを削除する</p>

Parameters:

id - 証憑ID (required)

companyId - 事業所ID (required)

Returns:

Completable

getReceipt

@GET(value="api/1/receipts/{id}")
io.reactivex.Observable<ReceiptResponse> getReceipt(@Path(value="id")
                                                                                      Integer id,
                                                                                      @Query(value="company_id")
                                                                                      Integer companyId)

ファイルボックス 証憑ファイルの取得 <h2 id=\"\">概要</h2> <p>指定した事業所のファイルボックス 証憑ファイルを取得する</p>

Parameters:

id - 証憑ID (required)

companyId - 事業所ID (required)

Returns:

Observable<ReceiptResponse>

getReceipts

@GET(value="api/1/receipts")
io.reactivex.Observable<InlineResponse2008> getReceipts(@Query(value="company_id")
                                                                                     Integer companyId,
                                                                                     @Query(value="start_date")
                                                                                     String startDate,
                                                                                     @Query(value="end_date")
                                                                                     String endDate,
                                                                                     @Query(value="user_name")
                                                                                     String userName,
                                                                                     @Query(value="number")
                                                                                     Integer number,
                                                                                     @Query(value="comment_type")
                                                                                     String commentType,
                                                                                     @Query(value="comment_important")
                                                                                     Boolean commentImportant,
                                                                                     @Query(value="category")
                                                                                     String category,
                                                                                     @Query(value="offset")
                                                                                     Integer offset,
                                                                                     @Query(value="limit")
                                                                                     Integer limit)

ファイルボックス 証憑ファイル一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所のファイルボックス 証憑ファイル一覧を取得する</p>

Parameters:

companyId - 事業所ID (required)

startDate - アップロード日 (yyyy-mm-dd) (required)

endDate - アップロード日 (yyyy-mm-dd) (required)

userName - アップロードしたユーザー名、メールアドレス (optional)

number - アップロードファイルNo (optional)

commentType - posted:コメントあり, raised:未解決, resolved:解決済 (optional)

commentImportant - trueの時、重要コメント付きが対象 (optional)

category - all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視 (optional)

offset - 取得レコードのオフセット (デフォルト: 0) (optional)

limit - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) (optional)

Returns:

Observable<InlineResponse2008>

updateReceipt

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/receipts/{id}")
io.reactivex.Observable<ReceiptResponse> updateReceipt(@Path(value="id")
                                                                                                                                          Integer id,
                                                                                                                                          @Body
                                                                                                                                          ReceiptUpdateParams receiptUpdateParams)

ファイルボックス 証憑ファイル情報更新 <h2 id=\"\">概要</h2> <p>ファイルボックスの証憑ファイル情報を更新する</p> <h2 id=\"_2\">注意点</h2> <ul> <li>本APIでは、証憑ファイルの再アップロードはできません。</li> </ul>

Parameters:

id - 証憑ID (required)

receiptUpdateParams - 経費申請の更新 (required)

Returns:

Observable<ReceiptResponse>