public interface PartnersApi
| Modifier and Type | Method and Description |
|---|---|
io.reactivex.Observable<PartnerResponse> |
createPartner(PartnerCreateParams partnerCreateParams)
取引先の作成
<h2 id=\"\">概要</h2> <p>指定した事業所の取引先を作成する</p> <ul> <li>codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</li> <li>取引先コードの利用を有効にしている場合は、codeの指定は必須です。</li> <li>振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes, 請求の入金期日設定（invoice_payment_term_attributes）は法人向けのプロフェッショナルプラン以上で利用可能です。</li></ul>
|
io.reactivex.Completable |
destroyPartner(Integer id,
Integer companyId)
取引先の削除
<h2 id=\"\">概要</h2> <p>指定した事業所の取引先を削除する</p>
|
io.reactivex.Observable<PartnerResponse> |
getPartner(Integer id,
Integer companyId)
取引先の取得
<h2 id=\"\">概要</h2> <p>指定した事業所の取引先を取得する</p> <ul> <li>振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes, 請求の入金期日設定（invoice_payment_term_attributes）は法人向けのプロフェッショナルプラン以上で利用可能です。</li></ul>
|
io.reactivex.Observable<PartnersResponse> |
getPartners(Integer companyId,
Integer offset,
Integer limit,
String keyword)
取引先一覧の取得
<h2 id=\"\">概要</h2> <p>指定した事業所の取引先一覧を取得する</p> <ul> <li>振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）は法人向けのプロフェッショナルプラン以上で利用可能です。</li></ul>
|
io.reactivex.Observable<PartnerResponse> |
updatePartner(Integer id,
PartnerUpdateParams partnerUpdateParams)
取引先の更新
<h2 id=\"\">概要</h2> <p>指定した取引先の情報を更新する</p> <ul> <li>codeを指定、更新することはできません。</li> <li>振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes, 請求の入金期日設定（invoice_payment_term_attributes）は法人向けのプロフェッショナルプラン以上で利用可能です。</li></ul>
|
io.reactivex.Observable<PartnerResponse> |
updatePartnerByCode(String code,
PartnerUpdateParams partnerUpdateParams)
取引先の更新
<h2 id=\"\">概要</h2> <p>取引先コードをキーに、指定した取引先の情報を更新する</p> <ul> <li>このAPIを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</li> <li>コードを日本語に設定している場合は、URLエンコードしてURLに含めるようにしてください。</li> <li>振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes, 請求の入金期日設定（invoice_payment_term_attributes）は法人向けのプロフェッショナルプラン以上で利用可能です。</li></ul>
|
@Headers(value="Content-Type:application/json") @POST(value="api/1/partners") io.reactivex.Observable<PartnerResponse> createPartner(@Body PartnerCreateParams partnerCreateParams)
partnerCreateParams - 取引先の作成 (required)@DELETE(value="api/1/partners/{id}")
io.reactivex.Completable destroyPartner(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 取引先ID (required)companyId - 事業所ID (required)@GET(value="api/1/partners/{id}")
io.reactivex.Observable<PartnerResponse> getPartner(@Path(value="id")
Integer id,
@Query(value="company_id")
Integer companyId)
id - 取引先ID (required)companyId - 事業所ID (required)@GET(value="api/1/partners") io.reactivex.Observable<PartnersResponse> getPartners(@Query(value="company_id") Integer companyId, @Query(value="offset") Integer offset, @Query(value="limit") Integer limit, @Query(value="keyword") String keyword)
companyId - 事業所ID (required)offset - 取得レコードのオフセット (デフォルト: 0) (optional)limit - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) (optional)keyword - 検索キーワード：取引先名・正式名称・カナ名称に対するあいまい検索で一致、またはショートカットキー1・2のいずれかに完全一致 (optional)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/partners/{id}")
io.reactivex.Observable<PartnerResponse> updatePartner(@Path(value="id")
Integer id,
@Body
PartnerUpdateParams partnerUpdateParams)
id - 取引先ID (required)partnerUpdateParams - 取引先の更新 (required)@Headers(value="Content-Type:application/json")
@PUT(value="api/1/partners/code/{code}")
io.reactivex.Observable<PartnerResponse> updatePartnerByCode(@Path(value="code")
String code,
@Body
PartnerUpdateParams partnerUpdateParams)
code - 取引先コード (required)partnerUpdateParams - 取引先の更新 (required)Copyright © 2020. All rights reserved.