jp.co.freee.accounting.api

Interface AccountItemsApi

public interface AccountItemsApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<AccountItemResponse>	createAccountItem(AccountItemParams accountItemParams) 勘定科目の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の勘定科目を作成する</p> <h2 id=\"_2\">注意点</h2> <p>tax_nameは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのnameを指定して勘定科目の作成をしてください</p>
io.reactivex.Completable	destroyAccountItem(Integer id, Integer companyId) 勘定科目の削除 <h2 id=\"\">概要</h2> <p>指定した勘定科目を削除する</p> <h2 id=\"\">注意点</h2> <ul> <li>削除できる勘定科目は、追加で作成したカスタム勘定項目のみです。</li> <li>デフォルトで存在する勘定科目や口座の勘定科目は削除できません。</li></ul>
io.reactivex.Observable<AccountItemResponse>	getAccountItem(Integer id, Integer companyId) 勘定科目の詳細情報の取得 <h2 id=\"\">概要</h2> <p>指定した勘定科目の詳細を取得する</p>
io.reactivex.Observable<AccountItemsResponse>	getAccountItems(Integer companyId, String baseDate) 勘定科目一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の勘定科目一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>default_tax_id : デフォルト設定がされている税区分ID</li> <li>default_tax_code : リクエストした日時を基準とした税区分コード</li> </ul> <h2 id=\"_3\">注意点</h2> <p>default_tax_code は勘定科目作成・更新時に利用するものではありません</p>
io.reactivex.Observable<AccountItemResponse>	updateAccountItem(Integer id, AccountItemParams accountItemParams) 勘定科目の更新 <h2 id=\"\">概要</h2> <p>勘定科目を更新する</p> <h2 id=\"_2\">注意点</h2> <p>tax_codeは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのcodeを指定して勘定科目の更新をしてください</p>

Method Detail

createAccountItem

@Headers(value="Content-Type:application/json")
 @POST(value="api/1/account_items")
io.reactivex.Observable<AccountItemResponse> createAccountItem(@Body
                                                                                                                                                   AccountItemParams accountItemParams)

勘定科目の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の勘定科目を作成する</p> <h2 id=\"_2\">注意点</h2> <p>tax_nameは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのnameを指定して勘定科目の作成をしてください</p>

Parameters:

accountItemParams - 勘定科目の作成 (required)

Returns:

Observable<AccountItemResponse>

destroyAccountItem

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

勘定科目の削除 <h2 id=\"\">概要</h2> <p>指定した勘定科目を削除する</p> <h2 id=\"\">注意点</h2> <ul> <li>削除できる勘定科目は、追加で作成したカスタム勘定項目のみです。</li> <li>デフォルトで存在する勘定科目や口座の勘定科目は削除できません。</li></ul>

Parameters:

id - (required)

companyId - 事業所ID (required)

Returns:

Completable

getAccountItem

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

getAccountItems

@GET(value="api/1/account_items")
io.reactivex.Observable<AccountItemsResponse> getAccountItems(@Query(value="company_id")
                                                                                                Integer companyId,
                                                                                                @Query(value="base_date")
                                                                                                String baseDate)

勘定科目一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の勘定科目一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>default_tax_id : デフォルト設定がされている税区分ID</li> <li>default_tax_code : リクエストした日時を基準とした税区分コード</li> </ul> <h2 id=\"_3\">注意点</h2> <p>default_tax_code は勘定科目作成・更新時に利用するものではありません</p>

Parameters:

companyId - 事業所ID (required)

baseDate - 基準日:指定した場合、勘定科目に紐づく税区分(default_tax_code)が、基準日の税率に基づいて返ります。 (optional)

Returns:

Observable<AccountItemsResponse>

updateAccountItem

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/account_items/{id}")
io.reactivex.Observable<AccountItemResponse> updateAccountItem(@Path(value="id")
                                                                                                                                                       Integer id,
                                                                                                                                                       @Body
                                                                                                                                                       AccountItemParams accountItemParams)

勘定科目の更新 <h2 id=\"\">概要</h2> <p>勘定科目を更新する</p> <h2 id=\"_2\">注意点</h2> <p>tax_codeは、api/1/taxes/companies/{company_id} で該当事業所の税区分の一覧を取得して、availableの値がtrue、かつ”name_ja”に”税率%”を含んでいない税区分を確認して、そのcodeを指定して勘定科目の更新をしてください</p>

Parameters:

id - (required)

accountItemParams - 勘定科目の更新 (required)

Returns:

Observable<AccountItemResponse>