freee請求書のAPI仕様です。

freee請求書APIを利用するには、freee請求書への登録が必要です。登録はfreee請求書より行ってください。

認証について

OAuth2.0を利用します。詳細はリファレンスの認証に関する記載を参照してください。

エンドポイント

https://api.freee.co.jp/iv

後方互換性ありの変更

freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。

新しいAPIリソース・エンドポイントの追加
既存のAPIに対して必須ではない新しいリクエストパラメータの追加
既存のAPIレスポンスに対する新しいプロパティの追加
既存のAPIレスポンスに対するプロパティの順番の入れ変え
keyとなっているidやcodeの長さの変更（長くする）

エラーレスポンス

APIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。

ステータスコード	原因
400	リクエストパラメータが不正
401	アクセストークンが無効
403	アクセス権限がない
404	リソースが存在しない
429	リクエスト回数制限を超えた
503	システム内で予期しないエラーが発生

メッセージボディ内の messages にはエラー内容を説明する文字列が入ります。

  {
    "status_code" : 400,
    "errors" : [
    {
    "type" : "bad_request",
    "messages" : [
    "リクエストの形式が不正です。"
    ]
    }
    ]
    }

API使用制限

APIリクエストは、全プラン共通で1時間あたり1500回、1分あたり30回を上限としています。また、契約プランに応じて1日あたりの上限が設定されています。

freee会計プラン名	事業所とアプリケーション毎に、1日のAPIコール数の上限
法人エンタープライズプラン	10,000
法人アドバンスプラン（および旧法人プロフェッショナルプラン）	5,000
上記以外	3,000

API使用ステータスはレスポンスヘッダに付与されます。

X-RateLimit-Limit:1500
    X-RateLimit-Remaining:1498
    X-RateLimit-Reset:2018-01-01T12:00:00.000000Z
    X-Ratelimit-Limit-Minute:30
    X-Ratelimit-Remaining-Minute:29
    X-Ratelimit-Reset-Minute:2018-01-01T12:00:00.000000Z
    X-RateLimit-Limit-Day:3000
    X-RateLimit-Remaining-Day:2991
    X-RateLimit-Reset-Day:2018-01-02T00:00:00.000000Z

各ヘッダの意味は次のとおりです。

ヘッダ名	説明
X-RateLimit-Limit	1時間の使用回数の上限
X-RateLimit-Remaining	1時間の残り使用回数
X-RateLimit-Reset	1時間の使用回数がリセットされる時刻
X-Ratelimit-Limit-Minute	1分間の使用回数の上限
X-Ratelimit-Remaining-Minute	1分間の残り使用回数
X-Ratelimit-Reset-Minute	1分間の使用回数がリセットされる時刻
X-RateLimit-Limit-Day	1日間の使用回数の上限
X-RateLimit-Remaining-Day	1日間の残り使用回数
X-Ratelimit-Reset-Day	1日間の使用回数がリセットされる時刻

上記に加え、freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。
その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

会計マスタ項目

freee請求書APIのリクエストパラメータに、会計マスタ項目（例：POST/invoices請求書の作成取引先ID）があります。会計マスタ項目の詳細は会計マスタガイドラインを参照ください。

会計のマスタ項目はfreee会計APIのエンドポイントにて取得可能です（例：Partners 取引先）。freee会計APIのエンドポイントの詳細は会計APIリファレンスを参照ください。

tags: - name: PaymentNotices description: 支払通知書 - name: PurchaseOrders description: 発注書 - name: Receipts description: 領収書 - name: DeliverySlips description: 納品書 - name: Quotations description: 見積書 - name: Invoices description: 請求書 paths: "/delivery_slips": get: operationId: delivery_slips/index summary: '納品書一覧の取得 ' description: 納品書の一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: delivery_slip_number in: query required: false description: 納品書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: payment_status in: query required: false description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' schema: type: string enum: - settled - unsettled - name: deal_status in: query required: false description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' schema: type: string enum: - registered - unregistered - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: start_delivery_slip_date in: query required: false description: 納品日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_delivery_slip_date in: query required: false description: 納品日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)' schema: type: integer minimum: 0 maximum: 2147483647 - name: sales_management_origin in: query required: false description: freee販売から作成された帳票データを含める。trueを指定する場合はfreee販売から作成された帳票へのアクセス権限が必要です。 schema: type: boolean default: false responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips post: operationId: delivery_slips/create summary: '納品書の作成 ' description: |- 納品書の作成をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipRequest" "/delivery_slips/templates": get: operationId: delivery_slips/templates/index summary: '使用可能な納品書の帳票テンプレート一覧の取得 ' description: 使用可能な納品書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips "/delivery_slips/{id}": get: operationId: delivery_slips/show summary: '納品書の取得 ' description: 指定されたIDの納品書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 納品書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips put: operationId: delivery_slips/update summary: '納品書の更新 ' description: |- 納品書の更新をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: - name: id in: path required: true description: 納品書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipRequest" "/delivery_slips/{id}/cancel": put: operationId: delivery_slips/cancel summary: '納品書の取消 ' description: |- 指定された納品書を取消状態にします。取引が紐づいている場合は取引も削除されます。 parameters: - name: id in: path required: true description: 納品書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/delivery_slips/{id}/uncancel": put: operationId: delivery_slips/uncancel summary: '取消された納品書の復元 ' description: 指定された取消済み納品書を復元します。 parameters: - name: id in: path required: true description: 納品書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/DeliverySlipCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - DeliverySlips requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/invoices": get: operationId: invoices/index summary: '請求書一覧の取得 ' parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: invoice_number in: query required: false description: 請求書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: payment_status in: query required: false description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み, canceled: 決済キャンセル）' schema: type: string enum: - settled - unsettled - canceled - name: deal_status in: query required: false description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' schema: type: string enum: - registered - unregistered - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: start_billing_date in: query required: false description: 請求日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_billing_date in: query required: false description: 請求日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: start_payment_date in: query required: false description: 入金期日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_payment_date in: query required: false description: 入金期日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)' schema: type: integer minimum: 0 maximum: 2147483647 - name: sales_management_origin in: query required: false description: freee販売から作成された帳票データを含める。trueを指定する場合はfreee販売から作成された帳票へのアクセス権限が必要です。 schema: type: boolean default: false responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/InvoiceIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices post: operationId: invoices/create summary: '請求書の作成 ' description: |- 請求書の作成をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/InvoiceResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/InvoiceRequest" "/invoices/templates": get: operationId: invoices/templates/index summary: '使用可能な請求書の帳票テンプレート一覧の取得 ' description: 使用可能な請求書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices "/invoices/{id}": get: operationId: invoices/show summary: '請求書の取得 ' description: 指定されたIDの請求書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 請求書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/InvoiceShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices put: operationId: invoices/update summary: '請求書の更新 ' description: |- 請求書の更新をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: - name: id in: path required: true description: 請求書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/InvoiceResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/InvoiceRequest" "/invoices/{id}/cancel": put: operationId: invoices/cancel summary: '請求書の取消 ' description: |- 指定された請求書を取消状態にします。取引が紐づいている場合は取引も削除されます。 parameters: - name: id in: path required: true description: 請求書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/InvoiceCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/invoices/{id}/uncancel": put: operationId: invoices/uncancel summary: '取消された請求書の復元 ' description: 指定された取消済み請求書を復元します。 parameters: - name: id in: path required: true description: 請求書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/InvoiceCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Invoices requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/payment_notices": get: operationId: payment_notices/index summary: '支払通知書一覧の取得 ' parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: payment_notice_number in: query required: false description: 支払通知書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: start_payment_notice_date in: query required: false description: 支払通知書日付の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_payment_notice_date in: query required: false description: 支払通知書日付の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: start_collects_on in: query required: false description: 支払予定日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_collects_on in: query required: false description: 支払予定日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)' schema: type: integer minimum: 0 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices post: operationId: payment_notices/create summary: '支払通知書の作成 ' description: 支払通知書の作成をします。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeRequest" "/payment_notices/templates": get: operationId: payment_notices/templates/index summary: '使用可能な支払通知書の帳票テンプレート一覧の取得 ' description: 使用可能な支払通知書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices "/payment_notices/{id}": get: operationId: payment_notices/show summary: '支払通知書の取得 ' description: 指定されたIDの支払通知書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 支払通知書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices put: operationId: payment_notices/update summary: '支払通知書の更新 ' description: 支払通知書の更新をします。 parameters: - name: id in: path required: true description: 支払通知書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeRequest" "/payment_notices/{id}/cancel": put: operationId: payment_notices/cancel summary: '支払通知書の取消 ' description: |- 指定された支払通知書を取消状態にします。取引が紐づいている場合は取引も削除されます。 parameters: - name: id in: path required: true description: 支払通知書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/payment_notices/{id}/uncancel": put: operationId: payment_notices/uncancel summary: '取消された支払通知書の復元 ' description: 指定された取消済み支払通知書を復元します。 parameters: - name: id in: path required: true description: 支払通知書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PaymentNoticeCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PaymentNotices requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/purchase_orders": get: operationId: purchase_orders/index summary: '発注書一覧の取得 ' description: 発注書の一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: purchase_order_number in: query required: false description: 発注書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: deal_status in: query required: false description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' schema: type: string enum: - registered - unregistered - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: payment_status in: query required: false description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' schema: type: string enum: - settled - unsettled - name: start_purchase_order_date in: query required: false description: 発注日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_purchase_order_date in: query required: false description: 発注日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: start_collects_on in: query required: false description: 支払予定日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_collects_on in: query required: false description: 支払予定日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)。limit と offset の合計は 10,000 を超えることはできません。' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)。limit と offset の合計は 10,000 を超えることはできません。' schema: type: integer minimum: 0 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders post: operationId: purchase_orders/create summary: '発注書の作成 ' description: |- 発注書の作成をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderRequest" "/purchase_orders/templates": get: operationId: purchase_orders/templates/index summary: '使用可能な発注書の帳票テンプレート一覧の取得 ' description: 使用可能な発注書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders "/purchase_orders/{id}": get: operationId: purchase_orders/show summary: '発注書の取得 ' description: 指定されたIDの発注書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 発注書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders put: operationId: purchase_orders/update summary: '発注書の更新 ' description: |- 発注書の更新をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: - name: id in: path required: true description: 発注書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderRequest" "/purchase_orders/{id}/cancel": put: operationId: purchase_orders/cancel summary: '発注書の取消 ' description: |- 指定された発注書を取消状態にします。取引が紐づいている場合は取引も削除されます。 parameters: - name: id in: path required: true description: 発注書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/purchase_orders/{id}/uncancel": put: operationId: purchase_orders/uncancel summary: '取消された発注書の復元 ' description: 指定された取消済み発注書を復元します。 parameters: - name: id in: path required: true description: 発注書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/PurchaseOrderCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - PurchaseOrders requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/quotations": get: operationId: quotations/index summary: '見積書一覧の取得 ' parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: quotation_number in: query required: false description: 見積書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: start_quotation_date in: query required: false description: 見積日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_quotation_date in: query required: false description: 見積日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: start_expiration_date in: query required: false description: 有効期限の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_expiration_date in: query required: false description: 有効期限の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)' schema: type: integer minimum: 0 maximum: 2147483647 - name: sales_management_origin in: query required: false description: freee販売から作成された帳票データを含める。trueを指定する場合はfreee販売から作成された帳票へのアクセス権限が必要です。 schema: type: boolean default: false responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/QuotationIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations post: operationId: quotations/create summary: '見積書の作成 ' description: 見積書の作成をします。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/QuotationResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/QuotationRequest" "/quotations/templates": get: operationId: quotations/templates/index summary: '使用可能な見積書の帳票テンプレート一覧の取得 ' description: 使用可能な見積書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations "/quotations/{id}": get: operationId: quotations/show summary: '見積書の取得 ' description: 指定されたIDの見積書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 見積書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/QuotationShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations put: operationId: quotations/update summary: '見積書の更新 ' description: 見積書の更新をします。 parameters: - name: id in: path required: true description: 見積書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/QuotationResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/QuotationRequest" "/quotations/{id}/cancel": put: operationId: quotations/cancel summary: '見積書の取消 ' description: 指定された見積書を取消状態にします。 parameters: - name: id in: path required: true description: 見積書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/QuotationCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/quotations/{id}/uncancel": put: operationId: quotations/uncancel summary: '取消された見積書の復元 ' description: 指定された取消済み見積書を復元します。 parameters: - name: id in: path required: true description: 見積書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/QuotationCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Quotations requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/receipts": get: operationId: receipts/index summary: '領収書一覧の取得 ' description: 領収書の一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: receipt_number in: query required: false description: 領収書番号 schema: type: string minLength: 1 maxLength: 255 - name: subject in: query required: false description: 件名 schema: type: string minLength: 1 maxLength: 255 - name: partner_ids in: query required: false description: 取引先ID（半角数字のidを半角カンマ区切りスペースなしで指定してください。最大3件まで指定できます。） schema: type: string maxLength: 255 - name: deal_status in: query required: false description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' schema: type: string enum: - registered - unregistered - name: sending_status in: query required: false description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' schema: type: string enum: - sent - unsent - name: payment_status in: query required: false description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' schema: type: string enum: - settled - unsettled - name: cancel_status in: query required: false description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' schema: type: string enum: - canceled - uncanceled - name: start_receipt_date in: query required: false description: 領収日の開始日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: end_receipt_date in: query required: false description: 領収日の終了日 schema: type: string format: date pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" - name: limit in: query required: false description: '取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)' schema: type: integer minimum: 1 maximum: 100 - name: offset in: query required: false description: '取得レコードのオフセット (デフォルト: 0)' schema: type: integer minimum: 0 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/ReceiptIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts post: operationId: receipts/create summary: '領収書の作成 ' description: |- 領収書の作成をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: [] responses: '201': description: The request has succeeded and a new resource has been created as a result. content: application/json: schema: "$ref": "#/components/schemas/ReceiptResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ReceiptRequest" "/receipts/templates": get: operationId: receipts/templates/index summary: '使用可能な領収書の帳票テンプレート一覧の取得 ' description: 使用可能な領収書の帳票テンプレート一覧を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/TemplateIndexResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts "/receipts/{id}": get: operationId: receipts/show summary: '領収書の取得 ' description: 指定されたIDの領収書を返します。 parameters: - name: company_id in: query required: true description: 事業所ID schema: type: integer format: int64 minimum: 1 - name: id in: path required: true description: 領収書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/ReceiptShowResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts put: operationId: receipts/update summary: '領収書の更新 ' description: |- 領収書の更新をします。 issue_date, account_item_id, tax_code, item_id, section_id, tag_ids, segment_1_tag_id, segment_2_tag_id, segment_3_tag_id は、取引登録の下書き保存で利用されます。 tag_idsは10個まで設定可能です。 parameters: - name: id in: path required: true description: 領収書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/ReceiptResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts requestBody: required: true content: application/json: schema: "$ref": "#/components/schemas/ReceiptRequest" "/receipts/{id}/cancel": put: operationId: receipts/cancel summary: '領収書の取消 ' description: |- 指定された領収書を取消状態にします。取引が紐づいている場合は取引も削除されます。 parameters: - name: id in: path required: true description: 領収書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/ReceiptCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id "/receipts/{id}/uncancel": put: operationId: receipts/uncancel summary: '取消された領収書の復元 ' description: 指定された取消済み領収書を復元します。 parameters: - name: id in: path required: true description: 領収書ID schema: type: integer minimum: 1 maximum: 2147483647 responses: '200': description: The request has succeeded. content: application/json: schema: "$ref": "#/components/schemas/ReceiptCancelStatusResponse" '400': description: The server could not understand the request due to invalid syntax. content: application/problem+json: schema: "$ref": "#/components/schemas/badRequest" '401': description: Access is unauthorized. content: application/json: schema: "$ref": "#/components/schemas/unauthorizedError" '403': description: Access is forbidden. content: application/problem+json: schema: "$ref": "#/components/schemas/forbiddenError" application/json: schema: "$ref": "#/components/schemas/accessDeniedError" '404': description: The server cannot find the requested resource. content: application/problem+json: schema: "$ref": "#/components/schemas/notfoundError" '500': description: Server error content: application/problem+json: schema: "$ref": "#/components/schemas/internalServerError" tags: - Receipts requestBody: required: true content: application/json: schema: type: object properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID required: - company_id security: - OAuth2Auth: - write - read components: schemas: DeliverySlipCancelStatusResponse: type: object required: - delivery_slip properties: delivery_slip: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 納品書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status DeliverySlipIndexResponse: type: object required: - delivery_slips properties: delivery_slips: type: array items: "$ref": "#/components/schemas/DeliverySlipIndexResponse_delivery_slips" DeliverySlipIndexResponse_delivery_slips: type: object required: - id - company_id - delivery_slip_number - subject - delivery_slip_date - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 納品書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID delivery_slip_number: type: string maxLength: 255 description: 納品書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID delivery_slip_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 納品日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか DeliverySlipRequest: type: object required: - company_id - delivery_slip_date - tax_entry_method - tax_fraction - withholding_tax_entry_method - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） delivery_slip_number: type: string maxLength: 255 description: |- 納品書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 delivery_slip_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 納品日 issue_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 発生日（取引登録の下書き保存で利用されます。） - 入力がない場合、納品日が補完されます。 subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' delivery_slip_note: type: string minLength: 0 maxLength: 4000 description: 備考 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_email_cc: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（CC） - 入力がない場合、メールテンプレートに指定されたCCが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_email_to: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（TO） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者メールアドレスが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: 取引先への送付方法 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。 lines: type: array items: "$ref": "#/components/schemas/DeliverySlipRequest_lines" description: 納品書の明細行 DeliverySlipRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税額計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' withholding: type: boolean description: 源泉徴収対象 account_item_id: type: integer minimum: 1 maximum: 2147483647 description: 勘定科目ID（取引登録の下書き保存で利用されます。） tax_code: type: integer minimum: 0 maximum: 2147483647 description: 税区分コード（取引登録の下書き保存で利用されます。） item_id: type: integer minimum: 1 maximum: 2147483647 description: 品目ID（取引登録の下書き保存で利用されます。） section_id: type: integer minimum: 1 maximum: 2147483647 description: |- 部門ID
- 取引登録の下書き保存で利用されます。 - 親部門は利用できません。 - グループ管理で制限された部門は利用できません。
グループ管理の設定はヘルプページを御覧ください。 tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント１ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けプロフェッショナルプラン以上で利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_2_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント２ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_3_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント３ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 DeliverySlipResponse: type: object required: - delivery_slip properties: delivery_slip: "$ref": "#/components/schemas/DeliverySlipResponse_delivery_slip" DeliverySlipResponse_delivery_slip: type: object required: - id - company_id - delivery_slip_number - subject - delivery_slip_date - delivery_slip_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 納品書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID delivery_slip_number: type: string maxLength: 255 description: 納品書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 delivery_slip_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 納品日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 payment_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 期日 - payment_typeがtransferの場合、入金期日に該当します。 - payment_typeがdirect_debitの場合、振替日に該当します。 payment_type: type: string enum: - transfer - direct_debit description: '入金方法 (振込: transfer, 振替: direct_debit)' delivery_slip_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_email_cc: type: string maxLength: 255 description: 取引先担当者メールアドレス（CC） partner_contact_email_to: type: string maxLength: 255 description: 取引先担当者メールアドレス（TO） partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 partner_bank_account: type: string maxLength: 255 description: 取引先口座 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: 取引先への送付方法 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 company_description: type: string description: 自社情報 template: "$ref": "#/components/schemas/DeliverySlipResponse_delivery_slip_template" lines: type: array items: "$ref": "#/components/schemas/DeliverySlipResponse_delivery_slip_lines" description: 納品書の明細行 report_url: type: string format: uri description: 帳票詳細ページのURL DeliverySlipResponse_delivery_slip_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_tax、account_item_id、tax_code、item_id、section_id、segment_1_tag_id、segment_2_tag_id、segment_3_tag_idはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 account_item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 勘定科目ID tax_code: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 税区分コード item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 品目ID section_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 部門ID tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント１ID segment_2_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント２ID segment_3_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント３ID DeliverySlipResponse_delivery_slip_template: type: object properties: title: type: string description: 納品書タイトル invoice_registration_number: type: string description: |- インボイス制度適格請求書発行事業者登録番号 - 先頭T数字13桁の固定14桁の文字列国税庁インボイス制度適格請求書発行事業者公表サイト company_name: type: string description: 自社名 company_description: type: string description: 自社情報 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） DeliverySlipShowResponse: type: object required: - delivery_slip properties: delivery_slip: "$ref": "#/components/schemas/DeliverySlipShowResponse_delivery_slip" DeliverySlipShowResponse_delivery_slip: type: object required: - id - company_id - delivery_slip_number - subject - delivery_slip_date - delivery_slip_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 納品書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID delivery_slip_number: type: string maxLength: 255 description: 納品書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 delivery_slip_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 納品日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 delivery_slip_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/DeliverySlipResponse_delivery_slip_template" lines: type: array items: "$ref": "#/components/schemas/DeliverySlipShowResponse_delivery_slip_lines" description: 納品書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか DeliverySlipShowResponse_delivery_slip_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 InvoiceCancelStatusResponse: type: object required: - invoice properties: invoice: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 請求書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status InvoiceIndexResponse: type: object required: - invoices properties: invoices: type: array items: "$ref": "#/components/schemas/InvoiceIndexResponse_invoices" InvoiceIndexResponse_invoices: type: object required: - id - company_id - invoice_number - subject - billing_date - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - amount_brought_forward - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 請求書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID invoice_number: type: string maxLength: 255 description: 請求書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID billing_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 請求日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 payment_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 期日 - payment_typeがtransferの場合、入金期日に該当します。 - payment_typeがdirect_debitの場合、振替日に該当します。 - payment_typeがcardの場合、カード支払期日に該当します。 payment_type: type: string enum: - transfer - direct_debit - card description: '入金方法 (振込: transfer, 振替: direct_debit, カード: card)' memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled - canceled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み, canceled: 決済キャンセル）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_brought_forward: type: number format: double nullable: true minimum: -999999999999 maximum: 999999999999 description: 繰越金額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか InvoiceRequest: type: object required: - company_id - billing_date - tax_entry_method - tax_fraction - withholding_tax_entry_method - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） invoice_number: type: string maxLength: 255 description: |- 請求書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 billing_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 請求日 issue_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 発生日（取引登録の下書き保存で利用されます。） - 入力がない場合、請求日が補完されます。 payment_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 期日 - payment_typeがtransferの場合、入金期日に該当します。 - payment_typeがdirect_debitの場合、振替日に該当します。 payment_type: type: string enum: - transfer - direct_debit description: '入金方法 (振込: transfer, 振替: direct_debit)' default: transfer subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' include_amount_brought_forward: type: boolean description: |- 繰越金額を含めるかどうか（true: 含める、false: 含めない）
- 含める場合は、amount_brought_forwardに繰越金額を指定することができます。 - 含める場合でamount_brought_forwardの指定がない場合は、帳票に指定されたpartner_id, partner_codeに紐づく未決済残高が繰越金額として利用されます。 amount_brought_forward: type: integer format: int64 minimum: -999999999999 maximum: 999999999999 description: |- 繰越金額
include_amount_brought_forward に true を指定する場合のみ、指定できます。 invoice_note: type: string minLength: 0 maxLength: 4000 description: 備考 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_email_cc: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（CC） - 入力がない場合、メールテンプレートに指定されたCCが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_email_to: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（TO） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者メールアドレスが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: |- 取引先への送付方法 - 一括送付時に取引先マスタに登録された送付方法以外を利用したい場合に指定します。 - 入力がない場合、取引先マスタに登録された送付方法で一括送付を行います。 partner_bank_account: type: string maxLength: 255 description: |- 取引先口座 - payment_typeがdirect_debitの場合に指定可能です。 - 入力がない場合またはpayment_typeがtransferの場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先口座が利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。 bank_account_to_transfer: type: string maxLength: 255 description: 振込先を上書きする場合に指定します。 lines: type: array items: "$ref": "#/components/schemas/InvoiceRequest_lines" description: 請求書の明細行 InvoiceRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） sales_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税額計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' withholding: type: boolean description: 源泉徴収対象 account_item_id: type: integer minimum: 1 maximum: 2147483647 description: 勘定科目ID（取引登録の下書き保存で利用されます。） tax_code: type: integer minimum: 0 maximum: 2147483647 description: 税区分コード（取引登録の下書き保存で利用されます。） item_id: type: integer minimum: 1 maximum: 2147483647 description: 品目ID（取引登録の下書き保存で利用されます。） section_id: type: integer minimum: 1 maximum: 2147483647 description: |- 部門ID
- 取引登録の下書き保存で利用されます。 - 親部門は利用できません。 - グループ管理で制限された部門は利用できません。
グループ管理の設定はヘルプページを御覧ください。 tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント１ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けプロフェッショナルプラン以上で利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_2_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント２ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_3_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント３ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 InvoiceResponse: type: object required: - invoice properties: invoice: "$ref": "#/components/schemas/InvoiceResponse_invoice" InvoiceResponse_invoice: type: object required: - id - company_id - invoice_number - subject - billing_date - invoice_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - amount_brought_forward - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 請求書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID invoice_number: type: string maxLength: 255 description: 請求書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 billing_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 請求日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 payment_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 期日 - payment_typeがtransferの場合、入金期日に該当します。 - payment_typeがdirect_debitの場合、振替日に該当します。 payment_type: type: string enum: - transfer - direct_debit description: '入金方法 (振込: transfer, 振替: direct_debit)' invoice_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled - canceled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み, canceled: 決済キャンセル）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 amount_brought_forward: type: number format: double nullable: true minimum: -999999999999 maximum: 999999999999 description: 繰越金額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_email_cc: type: string maxLength: 255 description: 取引先担当者メールアドレス（CC） partner_contact_email_to: type: string maxLength: 255 description: 取引先担当者メールアドレス（TO） partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 partner_bank_account: type: string maxLength: 255 description: 取引先口座 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: 取引先への送付方法 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 company_description: type: string description: 自社情報 bank_account_to_transfer: type: string description: 振込先 template: "$ref": "#/components/schemas/InvoiceResponse_invoice_template" lines: type: array items: "$ref": "#/components/schemas/InvoiceResponse_invoice_lines" description: 請求書の明細行 report_url: type: string format: uri description: 帳票詳細ページのURL InvoiceResponse_invoice_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はsales_date、quantity、unit_price、tax_rate、amount_excluding_tax、account_item_id、tax_code、item_id、section_id、segment_1_tag_id、segment_2_tag_id、segment_3_tag_idはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） sales_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 account_item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 勘定科目ID tax_code: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 税区分コード item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 品目ID section_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 部門ID tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント１ID segment_2_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント２ID segment_3_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント３ID InvoiceResponse_invoice_template: type: object properties: title: type: string description: 請求書タイトル invoice_registration_number: type: string description: |- インボイス制度適格請求書発行事業者登録番号 - 先頭T数字13桁の固定14桁の文字列国税庁インボイス制度適格請求書発行事業者公表サイト company_name: type: string description: 自社名 company_description: type: string description: 自社情報 bank_account_to_transfer: type: string description: 振込先 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） InvoiceShowResponse: type: object required: - invoice properties: invoice: "$ref": "#/components/schemas/InvoiceShowResponse_invoice" InvoiceShowResponse_invoice: type: object required: - id - company_id - invoice_number - subject - billing_date - invoice_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - amount_brought_forward - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 請求書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID invoice_number: type: string maxLength: 255 description: 請求書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 billing_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 請求日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 payment_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 期日 - payment_typeがtransferの場合、入金期日に該当します。 - payment_typeがdirect_debitの場合、振替日に該当します。 - payment_typeがcardの場合、カード支払期日に該当します。 payment_type: type: string enum: - transfer - direct_debit - card description: '入金方法 (振込: transfer, 振替: direct_debit, カード: card)' invoice_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled - canceled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み, canceled: 決済キャンセル）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 amount_brought_forward: type: number format: double nullable: true minimum: -999999999999 maximum: 999999999999 description: 繰越金額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 partner_bank_account: type: string maxLength: 255 description: 取引先口座 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) bank_account_to_transfer: type: string description: 振込先 template: "$ref": "#/components/schemas/InvoiceResponse_invoice_template" lines: type: array items: "$ref": "#/components/schemas/InvoiceShowResponse_invoice_lines" description: 請求書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか InvoiceShowResponse_invoice_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はsales_date、quantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） sales_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 PaymentNoticeCancelStatusResponse: type: object required: - payment_notice properties: payment_notice: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 支払通知書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status PaymentNoticeIndexResponse: type: object required: - payment_notices properties: payment_notices: type: array items: "$ref": "#/components/schemas/PaymentNoticeIndexResponse_payment_notices" PaymentNoticeIndexResponse_payment_notices: type: object required: - id - company_id - payment_notice_number - subject - payment_notice_date - memo - sending_status - cancel_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 支払通知書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID payment_notice_number: type: string maxLength: 255 description: 支払通知書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID payment_notice_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払通知書日付 collects_on: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払予定日 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL PaymentNoticeRequest: type: object required: - company_id - payment_notice_date - tax_entry_method - tax_fraction - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） payment_notice_number: type: string maxLength: 255 description: |- 支払通知書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 payment_notice_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払通知書日付 collects_on: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払予定日 payment_condition: type: string minLength: 1 maxLength: 255 description: 支払方法 subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' payment_notice_note: type: string minLength: 0 maxLength: 4000 description: 備考 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは操作者の表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。 lines: type: array items: "$ref": "#/components/schemas/PaymentNoticeRequest_lines" description: 支払通知書の明細行 PaymentNoticeRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） sales_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税率計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' PaymentNoticeResponse: type: object required: - payment_notice properties: payment_notice: "$ref": "#/components/schemas/PaymentNoticeResponse_payment_notice" PaymentNoticeResponse_payment_notice: type: object required: - id - company_id - payment_notice_number - subject - payment_notice_date - payment_notice_note - memo - sending_status - cancel_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 支払通知書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID payment_notice_number: type: string maxLength: 255 description: 支払通知書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 payment_notice_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払通知書日付 collects_on: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払予定日 payment_condition: type: string maxLength: 255 description: 支払方法 payment_notice_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/PaymentNoticeResponse_payment_notice_template" lines: type: array items: "$ref": "#/components/schemas/PaymentNoticeResponse_payment_notice_lines" description: 支払通知書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL PaymentNoticeResponse_payment_notice_lines: type: object required: - id - type - description properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 description: type: string maxLength: 255 description: 摘要（品名） sales_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' amount_excluding_tax: type: number format: double nullable: true description: 税別金額 PaymentNoticeResponse_payment_notice_template: type: object properties: title: type: string description: 支払通知書タイトル company_name: type: string description: 自社名 company_description: type: string description: 自社情報 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） PaymentNoticeShowResponse: type: object required: - payment_notice properties: payment_notice: "$ref": "#/components/schemas/PaymentNoticeShowResponse_payment_notice" PaymentNoticeShowResponse_payment_notice: type: object required: - id - company_id - payment_notice_number - subject - payment_notice_date - payment_notice_note - memo - sending_status - cancel_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 支払通知書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID payment_notice_number: type: string maxLength: 255 description: 支払通知書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 payment_notice_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払通知書日付 collects_on: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払予定日 payment_condition: type: string maxLength: 255 description: 支払方法 payment_notice_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/PaymentNoticeResponse_payment_notice_template" lines: type: array items: "$ref": "#/components/schemas/PaymentNoticeShowResponse_payment_notice_lines" description: 支払通知書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL PaymentNoticeShowResponse_payment_notice_lines: type: object required: - id - type - description properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はsales_date、quantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） sales_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 取引日 unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' amount_excluding_tax: type: number format: double nullable: true description: 税別金額 PurchaseOrderCancelStatusResponse: type: object required: - purchase_order properties: purchase_order: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 発注書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status PurchaseOrderIndexResponse: type: object required: - purchase_orders properties: purchase_orders: type: array items: "$ref": "#/components/schemas/PurchaseOrderIndexResponse_purchase_orders" PurchaseOrderIndexResponse_purchase_orders: type: object required: - id - company_id - purchase_order_number - subject - purchase_order_date - memo - sending_status - cancel_status - deal_status - payment_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 発注書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID purchase_order_number: type: string maxLength: 255 description: 発注書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID purchase_order_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発注日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 collects_on: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 支払予定日 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL PurchaseOrderRequest: type: object required: - company_id - purchase_order_date - tax_entry_method - tax_fraction - withholding_tax_entry_method - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） purchase_order_number: type: string maxLength: 255 description: |- 発注書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 purchase_order_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発注日 issue_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 発生日（取引登録の下書き保存で利用されます。） - 入力がない場合、発注日が補完されます。 subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' purchase_order_note: type: string minLength: 0 maxLength: 4000 description: 発注書備考 collects_on: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 支払予定日 - 発注日（purchase_order_date）以降の日付を指定してください。 delivery_deadline: type: string maxLength: 255 description: 納品期限 delivery_location: type: string maxLength: 256 description: 納品場所 payment_condition: type: string maxLength: 256 description: 支払条件 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。 lines: type: array items: "$ref": "#/components/schemas/PurchaseOrderRequest_lines" description: 発注書の明細行 PurchaseOrderRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税額計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' withholding: type: boolean description: 源泉徴収対象 account_item_id: type: integer minimum: 1 maximum: 2147483647 description: 勘定科目ID（取引登録の下書き保存で利用されます。） tax_code: type: integer minimum: 0 maximum: 2147483647 description: 税区分コード（取引登録の下書き保存で利用されます。） item_id: type: integer minimum: 1 maximum: 2147483647 description: 品目ID（取引登録の下書き保存で利用されます。） section_id: type: integer minimum: 1 maximum: 2147483647 description: |- 部門ID
- 取引登録の下書き保存で利用されます。 - 親部門は利用できません。 - グループ管理で制限された部門は利用できません。
グループ管理の設定はヘルプページを御覧ください。 tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント１ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けプロフェッショナルプラン以上で利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_2_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント２ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_3_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント３ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 PurchaseOrderResponse: type: object required: - purchase_order properties: purchase_order: "$ref": "#/components/schemas/PurchaseOrderResponse_purchase_order" PurchaseOrderResponse_purchase_order: type: object required: - id - company_id - purchase_order_number - subject - purchase_order_date - purchase_order_note - memo - sending_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 発注書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID purchase_order_number: type: string maxLength: 255 description: 発注書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 purchase_order_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発注日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 purchase_order_note: type: string maxLength: 4000 description: 発注書備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 company_description: type: string description: 自社情報 template: "$ref": "#/components/schemas/PurchaseOrderResponse_purchase_order_template" lines: type: array items: "$ref": "#/components/schemas/PurchaseOrderResponse_purchase_order_lines" description: 発注書の明細行 report_url: type: string format: uri description: 帳票詳細ページのURL PurchaseOrderResponse_purchase_order_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_tax、account_item_id、tax_code、item_id、section_id、segment_1_tag_id、segment_2_tag_id、segment_3_tag_idはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 account_item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 勘定科目ID tax_code: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 税区分コード item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 品目ID section_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 部門ID tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント１ID segment_2_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント２ID segment_3_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント３ID PurchaseOrderResponse_purchase_order_template: type: object properties: title: type: string description: 発注書タイトル invoice_registration_number: type: string description: |- インボイス制度適格請求書発行事業者登録番号 - 先頭T数字13桁の固定14桁の文字列国税庁インボイス制度適格請求書発行事業者公表サイト company_name: type: string description: 自社名 company_description: type: string description: 自社情報 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） PurchaseOrderShowResponse: type: object required: - purchase_order properties: purchase_order: "$ref": "#/components/schemas/PurchaseOrderShowResponse_purchase_order" PurchaseOrderShowResponse_purchase_order: type: object required: - id - company_id - purchase_order_number - subject - purchase_order_date - purchase_order_note - memo - sending_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 発注書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID purchase_order_number: type: string maxLength: 255 description: 発注書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 purchase_order_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発注日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 purchase_order_note: type: string maxLength: 4000 description: 発注書備考 order_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発注日 delivery_deadline: type: string nullable: true maxLength: 255 description: 納品期限 delivery_location: type: string nullable: true maxLength: 256 description: 納品場所 payment_condition: type: string nullable: true maxLength: 256 description: 支払条件 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/PurchaseOrderResponse_purchase_order_template" lines: type: array items: "$ref": "#/components/schemas/PurchaseOrderShowResponse_purchase_order_lines" description: 発注書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL PurchaseOrderShowResponse_purchase_order_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 QuotationCancelStatusResponse: type: object required: - quotation properties: quotation: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 見積書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status QuotationIndexResponse: type: object required: - quotations properties: quotations: type: array items: "$ref": "#/components/schemas/QuotationIndexResponse_quotations" QuotationIndexResponse_quotations: type: object required: - id - company_id - quotation_number - subject - quotation_date - memo - sending_status - cancel_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 見積書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID quotation_number: type: string maxLength: 255 description: 見積書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID quotation_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 見積日 expiration_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 有効期限 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか QuotationRequest: type: object required: - company_id - quotation_date - tax_entry_method - tax_fraction - withholding_tax_entry_method - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） quotation_number: type: string maxLength: 255 description: |- 見積書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 quotation_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 見積日 expiration_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 有効期限 delivery_deadline: type: string minLength: 1 maxLength: 255 description: 納品期限 delivery_location: type: string minLength: 1 maxLength: 255 description: 納品場所 subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' quotation_note: type: string minLength: 0 maxLength: 4000 description: 備考 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_email_cc: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（CC） - 入力がない場合、メールテンプレートに指定されたCCが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_email_to: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者メールアドレス（TO） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者メールアドレスが利用されます。 - カンマ区切りで複数メールアドレスに送付可能です。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: |- 取引先への送付方法 - 一括送付時に取引先マスタに登録された送付方法以外を利用したい場合に指定します。 - 入力がない場合、取引先マスタに登録された送付方法で一括送付を行います。 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは操作者の表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。。 lines: type: array items: "$ref": "#/components/schemas/QuotationRequest_lines" description: 見積書の明細行 QuotationRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税率計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' withholding: type: boolean description: 源泉徴収対象 QuotationResponse: type: object required: - quotation properties: quotation: "$ref": "#/components/schemas/QuotationResponse_quotation" QuotationResponse_quotation: type: object required: - id - company_id - quotation_number - subject - quotation_date - delivery_deadline - delivery_location - quotation_note - memo - sending_status - cancel_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 見積書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID quotation_number: type: string maxLength: 255 description: 見積書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 quotation_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 見積日 expiration_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 有効期限 delivery_deadline: type: string maxLength: 255 description: 納品期限 delivery_location: type: string maxLength: 255 description: 納品場所 quotation_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_email_cc: type: string maxLength: 255 description: 取引先担当者メールアドレス（CC） partner_contact_email_to: type: string maxLength: 255 description: 取引先担当者メールアドレス（TO） partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 partner_sending_method: type: string enum: - email - posting - email_and_posting nullable: true description: 取引先への送付方法 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 company_description: type: string maxLength: 255 description: 自社情報 template: "$ref": "#/components/schemas/QuotationResponse_quotation_template" lines: type: array items: "$ref": "#/components/schemas/QuotationResponse_quotation_lines" description: 見積書の明細行 report_url: type: string format: uri description: 帳票詳細ページのURL QuotationResponse_quotation_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 QuotationResponse_quotation_template: type: object properties: title: type: string description: 見積書タイトル company_name: type: string description: 自社名 company_description: type: string description: 自社情報 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） QuotationShowResponse: type: object required: - quotation properties: quotation: "$ref": "#/components/schemas/QuotationShowResponse_quotation" QuotationShowResponse_quotation: type: object required: - id - company_id - quotation_number - subject - quotation_date - delivery_deadline - delivery_location - quotation_note - memo - sending_status - cancel_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 見積書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID quotation_number: type: string maxLength: 255 description: 見積書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 quotation_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 見積日 expiration_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 有効期限 delivery_deadline: type: string maxLength: 255 description: 納品期限 delivery_location: type: string maxLength: 255 description: 納品場所 quotation_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/QuotationResponse_quotation_template" lines: type: array items: "$ref": "#/components/schemas/QuotationShowResponse_quotation_lines" description: 見積書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL sales_management_origin: type: boolean description: freee販売から作成された帳票かどうか QuotationShowResponse_quotation_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はsales_date、quantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 ReceiptCancelStatusResponse: type: object required: - receipt properties: receipt: type: object properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 領収書ID cancel_status: type: string enum: - canceled - uncanceled description: '取消状態（canceled: 取消済み、uncanceled: 取消されていない）' required: - id - cancel_status ReceiptIndexResponse: type: object required: - receipts properties: receipts: type: array items: "$ref": "#/components/schemas/ReceiptIndexResponse_receipts" ReceiptIndexResponse_receipts: type: object required: - id - company_id - receipt_number - subject - receipt_date - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 領収書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID receipt_number: type: string maxLength: 255 description: 領収書番号 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID receipt_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 領収日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） total_amount: type: number format: double description: 合計金額 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: '自社担当者 (デフォルト: 表示ユーザー名)' email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL ReceiptRequest: type: object required: - company_id - receipt_date - tax_entry_method - tax_fraction - withholding_tax_entry_method - partner_title - lines properties: company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID（指定しない場合、事業所の既定のテンプレートが指定されます。） receipt_number: type: string maxLength: 255 description: |- 領収書番号
- 採番の設定が、[自動採番する]の場合、指定できません。 - 採番の設定が、[自動採番する]以外の場合、必須になります。 branch_no: type: integer minimum: 0 maximum: 2147483647 description: 枝番 receipt_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 領収日 issue_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: |- 発生日（取引登録の下書き保存で利用されます。） - 入力がない場合、領収日が補完されます。 subject: type: string minLength: 1 maxLength: 255 description: 件名 tax_entry_method: type: string enum: - in - out description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' receipt_note: type: string minLength: 0 maxLength: 4000 description: 備考 memo: type: string minLength: 1 maxLength: 2000 description: 社内メモ partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- 取引先ID
取引先IDと取引先コードはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_code: type: string description: |- 取引先コード
取引先コードと取引先IDはどちらか一方を必ず指定してください。
取引先役割に関してはヘルプページを御覧ください。 partner_title: type: string enum: - 御中 - 様 - "(空白)" - "（空白）" description: |- 敬称（御中、様、(空白)の3つから選択） - [非推奨]全角カッコの（空白）は削除予定です。 - 全角カッコの（空白）を指定した場合、はレスポンスは、半角カッコの(空白)になります。 partner_address_zipcode: type: string minLength: 1 maxLength: 10 pattern: "^[0-9]{3}-?[0-9]{4}$" description: |- 郵便番号 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく郵便番号が利用されます。 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: |- 都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄） - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく都道府県コードが利用されます。 partner_address_street_name1: type: string minLength: 1 maxLength: 255 description: |- 取引先市区町村・番地 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先市区町村・番地が利用されます。 partner_address_street_name2: type: string minLength: 1 maxLength: 255 description: |- 取引先建物名・部屋番号など - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先建物名・部屋番号などが利用されます。 partner_contact_department: type: string minLength: 1 maxLength: 255 description: |- 取引先部署 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先部署が利用されます。 partner_contact_name: type: string minLength: 1 maxLength: 255 description: |- 取引先担当者名 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先担当者名が利用されます。 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 - 入力がない場合、帳票に指定されたpartner_id, partner_codeに紐づく取引先名称が利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者(デフォルトは表示ユーザー名が補完されます) company_name: type: string maxLength: 255 description: 自社名を上書きする場合に指定します。 company_description: type: string maxLength: 255 description: 自社説明を上書きする場合に指定します。 lines: type: array items: "$ref": "#/components/schemas/ReceiptRequest_lines" description: 領収書の明細行 ReceiptRequest_lines: type: object properties: type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - tax_rate、quantityは必須になります。 - text: テキスト行 - descriptionのみ入力可能です。 - 入力がない場合、itemが利用されます。 default: item description: type: string minLength: 1 maxLength: 255 description: 摘要（品名） unit: type: string minLength: 1 maxLength: 255 description: 明細の単位名 quantity: type: number minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string pattern: "^-?[0-9]{0,13}(\\.[0-9]{1,3})?$" description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 description: 税率（%）（帳票の税額計算に用います。） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）trueはtax_rate:8の時のみ指定可能です。' withholding: type: boolean description: 源泉徴収対象 account_item_id: type: integer minimum: 1 maximum: 2147483647 description: 勘定科目ID（取引登録の下書き保存で利用されます。） tax_code: type: integer minimum: 0 maximum: 2147483647 description: 税区分コード（取引登録の下書き保存で利用されます。） item_id: type: integer minimum: 1 maximum: 2147483647 description: 品目ID（取引登録の下書き保存で利用されます。） section_id: type: integer minimum: 1 maximum: 2147483647 description: |- 部門ID
- 取引登録の下書き保存で利用されます。 - 親部門は利用できません。 - グループ管理で制限された部門は利用できません。
グループ管理の設定はヘルプページを御覧ください。 tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント１ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けプロフェッショナルプラン以上で利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_2_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント２ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 segment_3_tag_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: |- セグメント３ID
- 取引登録の下書き保存で利用されます。 - freee会計法人向けエンタープライズプランで利用可能です。
セグメント（分析用タグ）の設定はヘルプページを御覧ください。 ReceiptResponse: type: object required: - receipt properties: receipt: "$ref": "#/components/schemas/ReceiptResponse_receipt" ReceiptResponse_receipt: type: object required: - id - company_id - receipt_number - subject - receipt_date - receipt_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 領収書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID receipt_number: type: string maxLength: 255 description: 領収書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 receipt_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 領収日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 receipt_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 company_description: type: string description: 自社情報 template: "$ref": "#/components/schemas/ReceiptResponse_receipt_template" lines: type: array items: "$ref": "#/components/schemas/ReceiptResponse_receipt_lines" description: 領収書の明細行 report_url: type: string format: uri description: 帳票詳細ページのURL ReceiptResponse_receipt_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_tax、account_item_id、tax_code、item_id、section_id、segment_1_tag_id、segment_2_tag_id、segment_3_tag_idはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 account_item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 勘定科目ID tax_code: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 税区分コード item_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 品目ID section_id: type: integer nullable: true minimum: 1 maximum: 2147483647 description: 部門ID tag_ids: type: array items: type: integer segment_1_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント１ID segment_2_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント２ID segment_3_tag_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: セグメント３ID ReceiptResponse_receipt_template: type: object properties: title: type: string description: 領収書タイトル invoice_registration_number: type: string description: |- インボイス制度適格請求書発行事業者登録番号 - 先頭T数字13桁の固定14桁の文字列国税庁インボイス制度適格請求書発行事業者公表サイト company_name: type: string description: 自社名 company_description: type: string description: 自社情報 message: type: string description: メッセージ description: 帳票テンプレート情報（帳票テンプレート作成の際に設定できる項目です。） ReceiptShowResponse: type: object required: - receipt properties: receipt: "$ref": "#/components/schemas/ReceiptShowResponse_receipt" ReceiptShowResponse_receipt: type: object required: - id - company_id - receipt_number - subject - receipt_date - receipt_note - memo - sending_status - payment_status - cancel_status - deal_status - total_amount - created_at - amount_including_tax - amount_excluding_tax - amount_tax - partner_id - lines - report_url properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 領収書ID company_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 事業所ID receipt_number: type: string maxLength: 255 description: 領収書番号 branch_no: type: integer nullable: true minimum: 0 maximum: 2147483647 description: 枝番 subject: type: string maxLength: 255 description: 件名 template_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 帳票テンプレートID template_name: type: string maxLength: 255 description: 帳票テンプレート名 receipt_date: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 領収日 issue_date: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" format: date description: 発生日 receipt_note: type: string maxLength: 4000 description: 備考 memo: type: string maxLength: 2000 description: 社内メモ sending_status: type: string enum: - sent - unsent description: '送付ステータス（sent: 送付済み、 unsent: 送付待ち）' payment_status: type: string enum: - settled - unsettled description: '決済ステータス（unsettled: 決済待ち, settled: 決済済み）' cancel_status: type: string enum: - canceled - uncanceled description: '取消済み（canceled: 該当する、 uncanceled: 該当しない）' deal_status: type: string enum: - registered - unregistered description: '取引ステータス（registered: 登録済み、 unregistered: 登録待ち）' deal_id: type: integer format: int64 nullable: true minimum: 1 maximum: 9223372036854775000 description: 取引ID （deal_statusがunregisteredの場合、nullになります。） tax_entry_method: type: string enum: - in - out nullable: true description: '消費税の内税・外税区分（in: 税込表示（内税）、out: 税別表示（外税））' tax_fraction: type: string enum: - omit - round_up - round nullable: true description: '消費税端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' line_amount_fraction: type: string enum: - omit - round_up - round nullable: true description: '金額端数の計算方法（omit: 切り捨て、round_up: 切り上げ、round: 四捨五入）' withholding_tax_entry_method: type: string enum: - in - out nullable: true description: '源泉徴収の計算方法（in: 税込み価格で計算、out: 税別価格で計算）' total_amount: type: number format: double description: 合計金額 created_at: type: string pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" description: 作成日時 amount_withholding_tax: type: number nullable: true description: 源泉所得税 amount_including_tax: type: number format: double description: 税込金額 amount_excluding_tax: type: number description: 小計（税別） amount_tax: type: number description: 消費税額 amount_including_tax_10: type: number format: double nullable: true description: 10%対象税込 amount_excluding_tax_10: type: number format: double nullable: true description: 10%対象税抜 amount_tax_10: type: number format: double nullable: true description: 10%対象消費税 amount_including_tax_8: type: number format: double nullable: true description: 8%対象税込 amount_excluding_tax_8: type: number format: double nullable: true description: 8%対象税抜 amount_tax_8: type: number format: double nullable: true description: 8%対象消費税 amount_including_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税込 amount_excluding_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象税抜 amount_tax_8_reduced: type: number format: double nullable: true description: 軽減税率8%対象消費税 amount_including_tax_0: type: number format: double nullable: true description: 0%対象税込 amount_excluding_tax_0: type: number format: double nullable: true description: 0%対象税抜 amount_tax_0: type: number format: double nullable: true description: 0%対象消費税 partner_id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 取引先ID partner_code: type: string nullable: true description: 取引先コード partner_name: type: string maxLength: 255 description: |- 取引先名 - partner_nameに空文字が戻る場合は、対象レコードをweb画面から更新するか、freee請求書APIから更新すると解消されます。 partner_title: type: string enum: - 御中 - 様 - "(空白)" description: 敬称（御中、様、(空白)の3つから選択） partner_address_zipcode: type: string maxLength: 10 description: 郵便番号 partner_address_prefecture_code: type: integer minimum: -1 maximum: 46 description: '都道府県コード（-1: 設定しない、0: 北海道、1:青森、2:岩手、3:宮城、4:秋田、5:山形、6:福島、7:茨城、8:栃木、9:群馬、10:埼玉、11:千葉、12:東京、13:神奈川、14:新潟、15:富山、16:石川、17:福井、18:山梨、19:長野、20:岐阜、21:静岡、22:愛知、23:三重、24:滋賀、25:京都、26:大阪、27:兵庫、28:奈良、29:和歌山、30:鳥取、31:島根、32:岡山、33:広島、34:山口、35:徳島、36:香川、37:愛媛、38:高知、39:福岡、40:佐賀、41:長崎、42:熊本、43:大分、44:宮崎、45:鹿児島、46:沖縄）' partner_address_street_name1: type: string maxLength: 255 description: 取引先市区町村・番地 partner_address_street_name2: type: string maxLength: 255 description: 取引先建物名・部屋番号など partner_contact_department: type: string maxLength: 255 description: 取引先部署 partner_contact_name: type: string maxLength: 255 description: 取引先担当者名 partner_display_name: type: string maxLength: 255 description: |- 取引先宛名 - 帳票の宛名に利用されます。 company_contact_name: type: string maxLength: 255 description: 自社担当者名 company_name: type: string maxLength: 255 description: 自社名 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社名になります。) company_description: type: string maxLength: 255 description: 自社情報 (上書きした場合のみ反映されます、デフォルトがテンプレートの自社情報になります。) template: "$ref": "#/components/schemas/ReceiptResponse_receipt_template" lines: type: array items: "$ref": "#/components/schemas/ReceiptShowResponse_receipt_lines" description: 領収書の明細行 email_url_file_downloaded_at: type: string nullable: true pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}(:[0-9]{2})?$" format: string description: URL共有で送付された送付先のメールのダウンロード時刻 email_url_file_downloaded_status: type: string enum: - downloaded - undownloaded nullable: true description: URL共有で送付された送付先のメールのダウンロードステータス report_url: type: string format: uri description: 帳票詳細ページのURL ReceiptShowResponse_receipt_lines: type: object required: - id - type - description - withholding properties: id: type: integer format: int64 minimum: 1 maximum: 9223372036854775000 description: 明細行ID type: type: string enum: - item - text description: |- 明細の種類 - item: 品目行 - text: テキスト行 - textの時はquantity、unit_price、tax_rate、amount_excluding_taxはnullになります。 description: type: string maxLength: 255 description: 摘要（品名） unit: type: string maxLength: 255 description: 明細の単位名 quantity: type: number nullable: true minimum: -99999999.999 maximum: 99999999.999 description: 明細の数量 (整数部は8桁まで、小数部は3桁まで) unit_price: type: string nullable: true description: 明細の単価 (整数部は13桁まで、小数部は3桁まで) tax_rate: type: number enum: - 0 - 8 - 10 nullable: true description: 税率（%） reduced_tax_rate: type: boolean description: '軽減税率対象（true: 対象、 false: 対象外）' withholding: type: boolean description: 源泉徴収対象 amount_excluding_tax: type: number format: double nullable: true description: 税別金額 TemplateIndexResponse: type: object required: - templates properties: templates: type: array items: "$ref": "#/components/schemas/TemplateIndexResponse_templates" TemplateIndexResponse_templates: type: object required: - id - name properties: id: type: integer minimum: 1 maximum: 2147483647 description: 帳票テンプレートID name: type: string minLength: 1 maxLength: 255 description: 帳票テンプレート名 accessDeniedError: type: object properties: error: type: string message: type: string code: type: string badRequest: type: object properties: status_code: type: integer errors: type: array items: "$ref": "#/components/schemas/badRequest_errors" badRequest_errors: type: object properties: type: type: string messages: type: array items: type: string forbiddenError: type: object properties: status_code: type: integer errors: type: array items: "$ref": "#/components/schemas/forbiddenError_errors" forbiddenError_errors: type: object properties: type: type: string messages: type: array items: type: string internalServerError: type: object properties: status_code: type: integer errors: type: array items: "$ref": "#/components/schemas/internalServerError_errors" internalServerError_errors: type: object properties: type: type: string messages: type: array items: type: string notfoundError: type: object properties: status_code: type: integer errors: type: array items: "$ref": "#/components/schemas/notfoundError_errors" notfoundError_errors: type: object properties: type: type: string messages: type: array items: type: string unauthorizedError: type: object properties: message: type: string messages: type: string securitySchemes: OAuth2Auth: type: oauth2 flows: authorizationCode: authorizationUrl: https://accounts.secure.freee.co.jp/public_api/authorize tokenUrl: https://accounts.secure.freee.co.jp/public_api/token scopes: write: '' read: '' servers: - url: https://api.freee.co.jp/iv variables: {}