jp.co.freee.accounting.api

Interface QuotationsApi

public interface QuotationsApi

Method Summary

Modifier and Type	Method and Description
io.reactivex.Observable<QuotationResponse>	createQuotation(QuotationCreateParams quotationCreateParams) 見積書の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を作成する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>partner_code, partner_idはどちらかの指定が必須です。ただし両方同時に指定することはできません。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは見積内容(quotation_contents)は、最大100行までになります。</p> </li> </ul>
io.reactivex.Completable	destroyQuotation(Integer id, Integer companyId) 見積書の削除 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を削除する</p>
io.reactivex.Observable<QuotationResponse>	getQuotation(Integer id, Integer companyId) 見積書の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書詳細を取得する</p>
io.reactivex.Observable<InlineResponse2007>	getQuotations(Integer companyId, Integer partnerId, String partnerCode, String startIssueDate, String endIssueDate, String quotationNumber, String description, String quotationStatus, Integer offset, Integer limit) 見積書一覧の取得 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書一覧を取得する</p>
io.reactivex.Observable<QuotationResponse>	updateQuotation(Integer id, QuotationUpdateParams quotationUpdateParams) 見積書の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を更新する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>partner_code, partner_idを両方同時に指定することはできません。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは見積内容(quotation_contents)は、最大100行までになります。</p> </li> </ul>

Method Detail

createQuotation

@Headers(value="Content-Type:application/json")
 @POST(value="api/1/quotations")
io.reactivex.Observable<QuotationResponse> createQuotation(@Body
                                                                                                                                            QuotationCreateParams quotationCreateParams)

見積書の作成 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を作成する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>partner_code, partner_idはどちらかの指定が必須です。ただし両方同時に指定することはできません。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは見積内容(quotation_contents)は、最大100行までになります。</p> </li> </ul>

Parameters:

quotationCreateParams - 見積書の作成 (optional)

Returns:

Observable<QuotationResponse>

destroyQuotation

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

見積書の削除 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を削除する</p>

Parameters:

id - (required)

companyId - 事業所ID (required)

Returns:

Completable

getQuotation

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

getQuotations

@GET(value="api/1/quotations")
io.reactivex.Observable<InlineResponse2007> getQuotations(@Query(value="company_id")
                                                                                         Integer companyId,
                                                                                         @Query(value="partner_id")
                                                                                         Integer partnerId,
                                                                                         @Query(value="partner_code")
                                                                                         String partnerCode,
                                                                                         @Query(value="start_issue_date")
                                                                                         String startIssueDate,
                                                                                         @Query(value="end_issue_date")
                                                                                         String endIssueDate,
                                                                                         @Query(value="quotation_number")
                                                                                         String quotationNumber,
                                                                                         @Query(value="description")
                                                                                         String description,
                                                                                         @Query(value="quotation_status")
                                                                                         String quotationStatus,
                                                                                         @Query(value="offset")
                                                                                         Integer offset,
                                                                                         @Query(value="limit")
                                                                                         Integer limit)

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

Parameters:

companyId - 事業所ID (required)

partnerId - 取引先IDで絞込 (optional)

partnerCode - 取引先コードで絞込 (optional)

startIssueDate - 見積日の開始日(yyyy-mm-dd) (optional)

endIssueDate - 見積日の終了日(yyyy-mm-dd) (optional)

quotationNumber - 見積書番号 (optional)

description - 概要 (optional)

quotationStatus - 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て) (optional)

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

limit - 取得レコードの件数 (デフォルト: 20, 最大: 100) (optional)

Returns:

Observable<InlineResponse2007>

updateQuotation

@Headers(value="Content-Type:application/json")
 @PUT(value="api/1/quotations/{id}")
io.reactivex.Observable<QuotationResponse> updateQuotation(@Path(value="id")
                                                                                                                                                Integer id,
                                                                                                                                                @Body
                                                                                                                                                QuotationUpdateParams quotationUpdateParams)

見積書の更新 <h2 id=\"\">概要</h2> <p>指定した事業所の見積書を更新する</p> <h2 id=\"_1\">注意点</h2> <ul> <li> <p>partner_code, partner_idを両方同時に指定することはできません。</p> </li> <li> <p>partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。</p> </li> <li> <p>本APIでは見積内容(quotation_contents)は、最大100行までになります。</p> </li> </ul>

Parameters:

id - 見積書ID (required)

quotationUpdateParams - 見積書の更新 (optional)

Returns:

Observable<QuotationResponse>