jp.co.freee.accounting.api

Interface TagsApi

public interface TagsApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<TagResponse>	createTag(TagParams tagParams) メモタグの作成 <h2 id=\"\">概要</h2> <p>指定した事業所のメモタグを作成する</p>
io.reactivex.Completable	destroyTag(Integer id, Integer companyId) メモタグの削除 <h2 id=\"\">概要</h2> <p>指定した事業所のメモタグを削除する</p>
io.reactivex.Observable<TagResponse>	getTag(Integer id, Integer companyId) メモタグの詳細情報の取得 <h2 id=\"\">概要</h2> <p>指定した事業所のメモタグを取得する</p>
io.reactivex.Observable<InlineResponse20011>	getTags(Integer companyId, Integer offset, Integer limit) メモタグ一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所のメモタグ一覧を取得する</p>
io.reactivex.Observable<TagResponse>	updateTag(Integer id, TagParams tagParams) メモタグの更新 <h2 id=\"\">概要</h2> <p>指定した事業所のメモタグを更新する</p>

Method Detail

createTag

@Headers(value="Content-Type:application/json")
 @POST(value="api/1/tags")
io.reactivex.Observable<TagResponse> createTag(@Body
                                                                                                                          TagParams tagParams)

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

Parameters:

tagParams - メモタグの作成 (required)

Returns:

Observable<TagResponse>

destroyTag

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

getTag

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

getTags

@GET(value="api/1/tags")
io.reactivex.Observable<InlineResponse20011> getTags(@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<InlineResponse20011>

updateTag

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/tags/{id}")
io.reactivex.Observable<TagResponse> updateTag(@Path(value="id")
                                                                                                                              Integer id,
                                                                                                                              @Body
                                                                                                                              TagParams tagParams)

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

Parameters:

id - メモタグID (required)

tagParams - メモタグの更新 (optional)

Returns:

Observable<TagResponse>