All URIs are relative to https://api.freee.co.jp
| Method | HTTP request | Description |
|---|---|---|
| create_invoice | POST /api/1/invoices | 請求書の作成 |
| destroy_invoice | DELETE /api/1/invoices/{id} | 請求書の削除 |
| get_invoice | GET /api/1/invoices/{id} | 請求書の取得 |
| get_invoices | GET /api/1/invoices | 請求書一覧の取得 |
| update_invoice | PUT /api/1/invoices/{id} | 請求書の更新 |
crate::models::InvoiceResponse create_invoice(invoice_create_params) 請求書の作成
指定した事業所の請求書を作成する
-
partner_code, partner_idはどちらかの指定が必須です。ただし両方同時に指定することはできません。
-
請求書ステータス(invoice_status)を発行(issue)で利用した場合、請求内容の合計金額が0円以上になる必要があります。
-
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
-
本APIでは請求内容(invoice_contents)は、最大100行までになります。
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| invoice_create_params | Option<InvoiceCreateParams> | 請求書の作成 |
crate::models::InvoiceResponse
- 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_invoice(id, company_id) 請求書の削除
指定した事業所の請求書を削除する
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | i32 | [required] | ||
| company_id | i32 | 事業所ID | [required] |
(empty response body)
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::InvoiceResponse get_invoice(company_id, id) 請求書の取得
指定した事業所の請求書を取得する
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| company_id | i32 | 事業所ID | [required] | |
| id | i32 | 請求書ID | [required] |
crate::models::InvoiceResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::InvoiceIndexResponse get_invoices(company_id, partner_id, partner_code, start_issue_date, end_issue_date, start_due_date, end_due_date, invoice_number, description, invoice_status, payment_status, offset, limit) 請求書一覧の取得
指定した事業所の請求書一覧を取得する
| 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) | ||
| start_due_date | Option<String> | 期日の開始日(yyyy-mm-dd) | ||
| end_due_date | Option<String> | 期日の終了日(yyyy-mm-dd) | ||
| invoice_number | Option<String> | 請求書番号 | ||
| description | Option<String> | 概要 | ||
| invoice_status | Option<String> | 請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, unsubmitted: 送付待ち, submitted: 送付済み) | ||
| payment_status | Option<String> | 入金ステータス (unsettled: 入金待ち, settled: 入金済み) | ||
| offset | Option<i64> | 取得レコードのオフセット (デフォルト: 0) | ||
| limit | Option<i32> | 取得レコードの件数 (デフォルト: 20, 最大: 100) |
crate::models::InvoiceIndexResponse
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
crate::models::InvoiceResponse update_invoice(id, invoice_update_params) 請求書の更新
指定した事業所の請求書を更新する
-
入金済みの請求書に対する金額関連の変更はできません。
-
請求書ステータスは確定(issue)のみ指定可能です。請求書ステータスを確定する時のみ指定してください。
-
請求書WFを利用している場合、承認済み請求書は承認権限を持たないユーザーでは更新できません。
-
更新後の請求書ステータス(invoice_status)が下書き以外の場合、請求内容の合計金額が0円以上になる必要があります。
-
partner_code, partner_idを両方同時に指定することはできません。
-
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
-
本APIでは請求内容(invoice_contents)は、最大100行までになります。
| Name | Type | Description | Required | Notes |
|---|---|---|---|---|
| id | i32 | 請求書ID | [required] | |
| invoice_update_params | Option<InvoiceUpdateParams> | 請求書の更新 |
crate::models::InvoiceResponse
- 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]