jp.co.freee.accounting.api

Interface CompaniesApi

public interface CompaniesApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<CompanyIndexResponse>	getCompanies() 事業所一覧の取得 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>role <ul> <li>admin : 管理者</li> <li>simple_accounting : 一般</li> <li>self_only : 取引登録のみ</li> <li>read_only : 閲覧のみ</li> </ul> </li> </ul>
io.reactivex.Observable<CompanyResponse>	getCompany(Integer id, Boolean details, Boolean accountItems, Boolean taxes, Boolean items, Boolean partners, Boolean sections, Boolean tags, Boolean walletables) 事業所の詳細情報の取得 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の詳細を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>role <ul> <li>admin : 管理者</li> <li>simple_accounting : 一般</li> <li>self_only : 取引登録のみ</li> <li>read_only : 閲覧のみ</li> </ul> </li> </ul> <h2 id=\"_3\">
io.reactivex.Observable<CompanyUpdateResponse>	updateCompany(Integer id, CompanyParams companyParams) 事業所情報の更新 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の情報を更新する</p> <p>※同時に複数のリクエストを受け付けない</p>

Method Detail

getCompanies

@GET(value="api/1/companies")
io.reactivex.Observable<CompanyIndexResponse> getCompanies()

事業所一覧の取得 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の一覧を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>role <ul> <li>admin : 管理者</li> <li>simple_accounting : 一般</li> <li>self_only : 取引登録のみ</li> <li>read_only : 閲覧のみ</li> </ul> </li> </ul>

Returns:

Observable<CompanyIndexResponse>

getCompany

@GET(value="api/1/companies/{id}")
io.reactivex.Observable<CompanyResponse> getCompany(@Path(value="id")
                                                                                       Integer id,
                                                                                       @Query(value="details")
                                                                                       Boolean details,
                                                                                       @Query(value="account_items")
                                                                                       Boolean accountItems,
                                                                                       @Query(value="taxes")
                                                                                       Boolean taxes,
                                                                                       @Query(value="items")
                                                                                       Boolean items,
                                                                                       @Query(value="partners")
                                                                                       Boolean partners,
                                                                                       @Query(value="sections")
                                                                                       Boolean sections,
                                                                                       @Query(value="tags")
                                                                                       Boolean tags,
                                                                                       @Query(value="walletables")
                                                                                       Boolean walletables)

事業所の詳細情報の取得 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の詳細を取得する</p> <h2 id=\"_2\">定義</h2> <ul> <li>role <ul> <li>admin : 管理者</li> <li>simple_accounting : 一般</li> <li>self_only : 取引登録のみ</li> <li>read_only : 閲覧のみ</li> </ul> </li> </ul> <h2 id=\"_3\">

Parameters:

id - 事業所ID (required)

details - 取得情報に勘定科目・税区分コード・税区分・品目・取引先・部門・メモタグ・口座の一覧を含める (optional)

accountItems - 取得情報に勘定科目一覧を含める (optional)

taxes - 取得情報に税区分コード・税区分一覧を含める (optional)

items - 取得情報に品目一覧を含める (optional)

partners - 取得情報に取引先一覧を含める (optional)

sections - 取得情報に部門一覧を含める (optional)

tags - 取得情報にメモタグ一覧を含める (optional)

walletables - 取得情報に口座一覧を含める (optional)

Returns:

Observable<CompanyResponse>

updateCompany

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/companies/{id}")
io.reactivex.Observable<CompanyUpdateResponse> updateCompany(@Path(value="id")
                                                                                                                                                 Integer id,
                                                                                                                                                 @Body
                                                                                                                                                 CompanyParams companyParams)

事業所情報の更新 <h2 id=\"\">概要</h2> <p>ユーザーが所属する事業所の情報を更新する</p> <p>※同時に複数のリクエストを受け付けない</p>

Parameters:

id - 事業所ID (required)

companyParams - (optional)

Returns:

Observable<CompanyUpdateResponse>