jp.co.freee.accounting.api

Interface ItemsApi

public interface ItemsApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<ItemResponse>	createItem(ItemParams itemParams) 品目の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を作成する</p>
io.reactivex.Completable	destroyItem(Integer id, Integer companyId) 品目の削除 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を削除する</p>
io.reactivex.Observable<ItemResponse>	getItem(Integer id, Integer companyId) 品目の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を取得する</p>
io.reactivex.Observable<InlineResponse2005>	getItems(Integer companyId, Integer offset, Integer limit) 品目一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の品目一覧を取得する</p>
io.reactivex.Observable<ItemResponse>	updateItem(Integer id, ItemParams itemParams) 品目の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を更新する</p>

Method Detail

createItem

@Headers(value="Content-Type:application/json")
 @POST(value="api/1/items")
io.reactivex.Observable<ItemResponse> createItem(@Body
                                                                                                                             ItemParams itemParams)

品目の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を作成する</p>

Parameters:

itemParams - 品目の作成 (optional)

Returns:

Observable<ItemResponse>

destroyItem

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

getItem

@GET(value="api/1/items/{id}")
io.reactivex.Observable<ItemResponse> getItem(@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<ItemResponse>

getItems

@GET(value="api/1/items")
io.reactivex.Observable<InlineResponse2005> getItems(@Query(value="company_id")
                                                                               Integer companyId,
                                                                               @Query(value="offset")
                                                                               Integer offset,
                                                                               @Query(value="limit")
                                                                               Integer limit)

品目一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の品目一覧を取得する</p>

Parameters:

companyId - 事業所ID (required)

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

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

Returns:

Observable<InlineResponse2005>

updateItem

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/items/{id}")
io.reactivex.Observable<ItemResponse> updateItem(@Path(value="id")
                                                                                                                                 Integer id,
                                                                                                                                 @Body
                                                                                                                                 ItemParams itemParams)

品目の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の品目を更新する</p>

Parameters:

id - 品目ID (required)

itemParams - 品目の更新 (optional)

Returns:

Observable<ItemResponse>