Skip to content

Latest commit

 

History

History
175 lines (101 loc) · 6.52 KB

QuotationsApi.md

File metadata and controls

175 lines (101 loc) · 6.52 KB

\QuotationsApi

All URIs are relative to https://api.freee.co.jp

Method HTTP request Description
create_quotation POST /api/1/quotations 見積書の作成
destroy_quotation DELETE /api/1/quotations/{id} 見積書の削除
get_quotation GET /api/1/quotations/{id} 見積書の取得
get_quotations GET /api/1/quotations 見積書一覧の取得
update_quotation PUT /api/1/quotations/{id} 見積書の更新

create_quotation

crate::models::QuotationResponse create_quotation(quotation_create_params) 見積書の作成

概要

指定した事業所の見積書を作成する

注意点

  • partner_code, partner_idはどちらかの指定が必須です。ただし両方同時に指定することはできません。

  • partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。

  • 本APIでは見積内容(quotation_contents)は、最大100行までになります。

Parameters

Name Type Description Required Notes
quotation_create_params Option<QuotationCreateParams> 見積書の作成

Return type

crate::models::QuotationResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

destroy_quotation

destroy_quotation(id, company_id) 見積書の削除

概要

指定した事業所の見積書を削除する

Parameters

Name Type Description Required Notes
id i32 [required]
company_id i32 事業所ID [required]

Return type

(empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_quotation

crate::models::QuotationResponse get_quotation(company_id, id) 見積書の取得

概要

指定した事業所の見積書詳細を取得する

Parameters

Name Type Description Required Notes
company_id i32 事業所ID [required]
id i32 見積書ID [required]

Return type

crate::models::QuotationResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_quotations

crate::models::QuotationIndexResponse get_quotations(company_id, partner_id, partner_code, start_issue_date, end_issue_date, quotation_number, description, quotation_status, offset, limit) 見積書一覧の取得

概要

指定した事業所の見積書一覧を取得する

Parameters

Name Type Description Required Notes
company_id i32 事業所ID [required]
partner_id Option<i32> 取引先IDで絞込
partner_code Option<String> 取引先コードで絞込
start_issue_date Option<String> 見積日の開始日(yyyy-mm-dd)
end_issue_date Option<String> 見積日の終了日(yyyy-mm-dd)
quotation_number Option<String> 見積書番号
description Option<String> 概要
quotation_status Option<String> 見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て)
offset Option<i64> 取得レコードのオフセット (デフォルト: 0)
limit Option<i32> 取得レコードの件数 (デフォルト: 20, 最大: 100)

Return type

crate::models::QuotationIndexResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

update_quotation

crate::models::QuotationResponse update_quotation(id, quotation_update_params) 見積書の更新

概要

指定した事業所の見積書を更新する

注意点

  • partner_code, partner_idを両方同時に指定することはできません。

  • partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。

  • 本APIでは見積内容(quotation_contents)は、最大100行までになります。

Parameters

Name Type Description Required Notes
id i32 見積書ID [required]
quotation_update_params Option<QuotationUpdateParams> 見積書の更新

Return type

crate::models::QuotationResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]