jp.co.freee.accounting.api

Interface TransfersApi

public interface TransfersApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<TransferResponse>	createTransfer(TransferParams transferParams) 取引（振替）の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を作成する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>
io.reactivex.Completable	destroyTransfer(Integer id, Integer companyId) 取引（振替）の削除する <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を削除する</p>
io.reactivex.Observable<TransferResponse>	getTransfer(Integer id, Integer companyId) 取引（振替）の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>
io.reactivex.Observable<InlineResponse20014>	getTransfers(Integer companyId, String startDate, String endDate, Integer offset, Integer limit) 取引（振替）一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>
io.reactivex.Observable<TransferResponse>	updateTransfer(Integer id, TransferParams transferParams) 取引（振替）の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を更新する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>

Method Detail

createTransfer

@Headers(value="Content-Type:application/json")
 @POST(value="api/1/transfers")
io.reactivex.Observable<TransferResponse> createTransfer(@Body
                                                                                                                                         TransferParams transferParams)

取引（振替）の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を作成する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>

Parameters:

transferParams - 取引（振替）の作成 (optional)

Returns:

Observable<TransferResponse>

destroyTransfer

@DELETE(value="api/1/transfers/{id}")
io.reactivex.Completable destroyTransfer(@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

getTransfer

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

取引（振替）の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>

Parameters:

id - 取引(振替)ID (required)

companyId - 事業所ID (required)

Returns:

Observable<TransferResponse>

getTransfers

@GET(value="api/1/transfers")
io.reactivex.Observable<InlineResponse20014> getTransfers(@Query(value="company_id")
                                                                                        Integer companyId,
                                                                                        @Query(value="start_date")
                                                                                        String startDate,
                                                                                        @Query(value="end_date")
                                                                                        String endDate,
                                                                                        @Query(value="offset")
                                                                                        Integer offset,
                                                                                        @Query(value="limit")
                                                                                        Integer limit)

取引（振替）一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>

Parameters:

companyId - 事業所ID (required)

startDate - 振替日で絞込：開始日 (yyyy-mm-dd) (optional)

endDate - 振替日で絞込：終了日 (yyyy-mm-dd) (optional)

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

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

Returns:

Observable<InlineResponse20014>

updateTransfer

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/transfers/{id}")
io.reactivex.Observable<TransferResponse> updateTransfer(@Path(value="id")
                                                                                                                                             Integer id,
                                                                                                                                             @Body
                                                                                                                                             TransferParams transferParams)

取引（振替）の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の取引（振替）を更新する</p> <h2 id=\"_2\">定義</h2> <ul> <li> <p>amount : 振替金額</p> </li> <li> <p>from_walletable_type, to_walletable_type</p> <ul> <li>bank_account : 銀行口座</li> <li>credit_card : クレジットカード</li> <li>wallet : その他の決済口座</li> </ul> </li> </ul>

Parameters:

id - 取引(振替)ID (required)

transferParams - 取引（振替）の更新 (required)

Returns:

Observable<TransferResponse>