{ "openapi": "3.0.1", "info": { "title": "freee会計 API", "description": "\n
\n

スタートガイド

\n\n

freee API開発がはじめての方はfreee API スタートガイドを参照してください。

\n\n
\n

お知らせ

\n\n

\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行します。これに伴い、2023年10月にfreee会計の「請求書の作成、見積書の作成」エンドポイントは廃止、freee請求書APIに移行する予定です。詳細は freee会計 APIの仕様変更（インボイス制度対応）についてをご確認ください。\n

\n\n

仕様

\n\n

APIエンドポイント

\n\n

https://api.freee.co.jp/ (httpsのみ)

\n\n

認証について

\n

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

\n\n

データフォーマット

\n\n

リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄（application/jsonなど）を確認してください。

\n\n

後方互換性ありの変更

\n\n

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

\n\n\n\n

共通レスポンスヘッダー

\n\n

すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。

\n\n\n\n

共通エラーレスポンス

\n\n\n\n

レスポンスの例

\n\n
  {\n    "status_code" : 400,\n    "errors" : [\n      {\n        "type" : "status",\n        "messages" : ["不正なリクエストです。"]\n      },\n      {\n        "type" : "validation",\n        "messages" : ["Date は不正な日付フォーマットです。入力例：2019-12-17"]\n      }\n    ]\n  }
\n\n
\n\n

API使用制限

\n\n

freeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。

\n

その際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。

\n\n

/reportsと/receipts/{id}/downloadエンドポイント

\n\n

freeeはエンドポイント毎に一定頻度以上のアクセスを検知した場合、APIアクセスをコントロールする場合があります。その際のhttp status codeは429（too many requests）となります。

\n\n\n

http status codeが429となった場合、API使用ステータスはレスポンスヘッダに付与されます。

\n
x-ratelimit-limit:10\nx-ratelimit-remaining:1\nx-ratelimit-reset:2023-01-13T10:22:29+09:00\n
\n\n
各ヘッダの意味は次のとおりです。

\n\n\n \n \n \n \n \n \n \n \n \n
ヘッダ名説明
x-ratelimit-limit使用回数の上限
x-ratelimit-remaining残り使用回数
x-ratelimit-reset使用回数がリセットされる時刻
\n\n
\n\n

プラン別のAPI Rate Limit

\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
freee会計プラン名事業所とアプリケーション毎に1日でのAPIコール数
エンタープライズ10,000
プロフェッショナル5,000
ベーシック3,000
ミニマム3,000
上記以外3,000
\n\n

Webhookについて

\n\n

詳細は会計Webhook概要を参照してください。

\n\n
\n

連絡先

\n\n

ご不明点、ご要望等は freee サポートデスクへのお問い合わせフォーム からご連絡ください。

\n
© Since 2013 freee K.K.", "version": "v1.0", "x-copyright": "© Since 2013 freee K.K." }, "servers": [ { "url": "https://api.freee.co.jp" } ], "security": [ { "oauth2": [ "write", "read" ] } ], "tags": [ { "name": "Partners", "description": "

取引先

" }, { "name": "Selectables", "description": "

フォーム用選択項目情報

" }, { "name": "Account items", "description": "

勘定科目

" }, { "name": "Tags", "description": "

メモタグ

" }, { "name": "Sections", "description": "

部門

" }, { "name": "Invoices", "description": "

請求書

" }, { "name": "Deals", "description": "

取引（収入・支出）

" }, { "name": "Payments", "description": "

取引（収入・支出）の支払行

" }, { "name": "Renews", "description": "

取引（収入・支出）の+更新

" }, { "name": "ManualJournals", "description": "

振替伝票

" }, { "name": "Users", "description": "

ユーザー

" }, { "name": "Companies", "description": "

事業所

" }, { "name": "Items", "description": "

品目

" }, { "name": "Taxes", "description": "

税区分

" }, { "name": "Walletables", "description": "

口座

" }, { "name": "Banks", "description": "

連携サービス

" }, { "name": "Transfers", "description": "

取引（振替）

" }, { "name": "Wallet txns", "description": "

口座明細

" }, { "name": "Journals", "description": "

仕訳帳

" }, { "name": "Trial balance", "description": "

試算表

" }, { "name": "Receipts", "description": "

ファイルボックス（証憑ファイル）

" }, { "name": "Expense applications", "description": "

経費精算

" }, { "name": "Expense application line templates", "description": "

経費科目

" }, { "name": "Payment requests", "description": "

支払依頼

" }, { "name": "Approval requests", "description": "

各種申請

" }, { "name": "Approval flow routes", "description": "

申請経路

" }, { "name": "Segment tags", "description": "

セグメントタグ

" }, { "name": "Quotations", "description": "

見積書

" }, { "name": "Fixed assets", "description": "

固定資産台帳

" }, { "name": "General ledgers", "description": "

総勘定元帳

" } ], "paths": { "/api/1/partners": { "get": { "tags": [ "Partners" ], "summary": "取引先一覧の取得", "description": "\n

概要

\n\n

指定した事業所の取引先一覧を取得する

\n", "operationId": "get_partners", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_update_date", "in": "query", "description": "更新日で絞り込み：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_update_date", "in": "query", "description": "更新日で絞り込み：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3000 } }, { "name": "keyword", "in": "query", "description": "検索キーワード
\n取引先コード・取引先名・正式名称・カナ名称・ショートカットキー1・2のいずれかに対する部分一致。
\n以下のいずれかで区切って複数キーワードを指定した場合はAND検索となります。\n\n", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnersResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Partners" ], "summary": "取引先の作成", "description": "\n

概要

\n\n

指定した事業所の取引先を作成する

\n", "operationId": "create_partner", "requestBody": { "description": "取引先の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/partnerCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/partners/{id}": { "get": { "tags": [ "Partners" ], "summary": "取引先の取得", "description": "\n

概要

\n\n

指定した事業所の取引先を取得する

\n", "operationId": "get_partner", "parameters": [ { "name": "id", "in": "path", "description": "取引先ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Partners" ], "summary": "取引先の更新", "description": "\n

概要

\n\n

指定した取引先の情報を更新する

\n", "operationId": "update_partner", "parameters": [ { "name": "id", "in": "path", "description": "取引先ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引先の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/partnerUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Partners" ], "summary": "取引先の削除", "description": "\n

概要

\n\n

指定した事業所の取引先を削除する

", "operationId": "destroy_partner", "parameters": [ { "name": "id", "in": "path", "description": "取引先ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/partners/code/{code}": { "put": { "tags": [ "Partners" ], "summary": "取引先の更新", "description": "\n

概要

\n\n

取引先コードをキーに、指定した取引先の情報を更新する

\n", "operationId": "update_partner_by_code", "parameters": [ { "name": "code", "in": "path", "description": "取引先コード", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "取引先の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/partnerUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/partnerResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/forms/selectables": { "get": { "tags": [ "Selectables" ], "summary": "フォーム用選択項目情報の取得", "description": "\n

概要

\n\n

指定した事業所のフォーム用選択項目情報を取得する

", "operationId": "get_forms_selectables", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "includes", "in": "query", "description": "取得する項目(項目: account_item)", "schema": { "type": "string", "enum": [ "account_item" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/selectablesIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/account_items/{id}": { "get": { "tags": [ "Account items" ], "summary": "勘定科目の取得", "description": "\n

概要

\n\n

指定した勘定科目を取得する

\n

事業所の設定で勘定科目コードを使用する設定にしている場合、レスポンスで勘定科目コード(code)を返します

", "operationId": "get_account_item", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "勘定科目ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Account items" ], "summary": "勘定科目の更新", "description": "\n

概要

\n\n

指定した勘定科目を更新する

\n\n

注意点

\n

tax_codeは、指定した事業所の税区分一覧の取得APIでavailableの値がtrue、かつ経過措置税区分ではない5%の税区分を確認して、そのcodeを指定して勘定科目の更新をしてください。例 課対仕入の場合、34を指定してください

\n", "operationId": "update_account_item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "勘定科目の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/accountItemUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serviceUnavailableError" } } } } } }, "delete": { "tags": [ "Account items" ], "summary": "勘定科目の削除", "description": "\n

概要

\n\n

指定した勘定科目を削除する

\n

注意点

\n\n", "operationId": "destroy_account_item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/account_items": { "get": { "tags": [ "Account items" ], "summary": "勘定科目一覧の取得", "description": "\n

概要

\n\n

指定した事業所の勘定科目一覧を取得する

\n\n

定義

\n\n\n\n

注意点

\n

default_tax_code は勘定科目作成・更新時に利用するものではありません

\n

事業所の設定で勘定科目コードを使用する設定にしている場合、レスポンスで勘定科目コード(code)を返します

", "operationId": "get_account_items", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "base_date", "in": "query", "description": "基準日:指定した場合、勘定科目に紐づく税区分(default_tax_code)が、基準日の税率に基づいて返ります。", "schema": { "type": "string" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Account items" ], "summary": "勘定科目の作成", "description": "\n

概要

\n\n

指定した事業所の勘定科目を作成する

\n\n

注意点

\n

tax_codeは、指定した事業所の税区分一覧の取得APIでavailableの値がtrue、かつ経過措置税区分ではない5%の税区分を確認して、そのcodeを指定して勘定科目の作成をしてください。例 課対仕入の場合、34を指定してください

", "operationId": "create_account_item", "requestBody": { "description": "勘定科目の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/accountItemCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountItemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/tags": { "get": { "tags": [ "Tags" ], "summary": "メモタグ一覧の取得", "description": "\n

概要

\n\n

指定した事業所のメモタグ一覧を取得する

", "operationId": "get_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_update_date", "in": "query", "description": "更新日で絞り込み：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_update_date", "in": "query", "description": "更新日で絞り込み：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "tags" ], "properties": { "tags": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Tags" ], "summary": "メモタグの作成", "description": "\n

概要

\n\n

指定した事業所のメモタグを作成する

", "operationId": "create_tag", "requestBody": { "description": "メモタグの作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/tagParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/tags/{id}": { "get": { "tags": [ "Tags" ], "summary": "メモタグの取得", "description": "\n

概要

\n\n

指定した事業所のメモタグを取得する

", "operationId": "get_tag", "parameters": [ { "name": "id", "in": "path", "description": "タグID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Tags" ], "summary": "メモタグの更新", "description": "\n

概要

\n\n

指定した事業所のメモタグを更新する

", "operationId": "update_tag", "parameters": [ { "name": "id", "in": "path", "description": "メモタグID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "メモタグの更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/tagParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tagResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Tags" ], "summary": "メモタグの削除", "description": "\n

概要

\n\n

指定した事業所のメモタグを削除する

", "operationId": "destroy_tag", "parameters": [ { "name": "id", "in": "path", "description": "タグID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/sections": { "get": { "tags": [ "Sections" ], "summary": "部門一覧の取得", "description": "\n

概要

\n\n

指定した事業所の部門一覧を取得する

\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/sections?company_id=1

\n
\n\n
// プレミアムプラン（個人）、ベーシックプラン以上（法人）\n{\n  "sections" : [\n    {\n      "id" : 101,\n      "company_id" : 1,\n      "name" : "開発部門",\n      "long_name": "開発部門",\n      "shortcut1" : "DEVELOPER",\n      "shortcut2" : "123",\n      "indent_count": 1,\n      "parent_id": 11\n    },\n    ...\n  ]\n}\n// それ以外のプラン\n{\n  "sections" : [\n    {\n      "id" : 101,\n      "company_id" : 1,\n      "name" : "開発部門",\n      "long_name": "開発部門",\n      "shortcut1" : "DEVELOPER",\n      "shortcut2" : "123"\n    },\n    ...\n  ]\n}
\n", "operationId": "get_sections", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "sections" ], "properties": { "sections": { "type": "array", "items": { "$ref": "#/components/schemas/section" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Sections" ], "summary": "部門の作成", "description": "\n

概要

\n\n

指定した事業所の部門を作成する

\n\n

レスポンスの例

\n\n
// プレミアムプラン（個人）、ベーシックプラン以上（法人）\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123",\n    "indent_count": 1,\n    "parent_id": 101\n  }\n}\n// それ以外のプラン\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123"\n  }\n}
\n", "operationId": "create_section", "requestBody": { "description": "部門の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sectionParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/sectionParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sectionResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/sections/{id}": { "get": { "tags": [ "Sections" ], "summary": "部門の取得", "description": "\n

概要

\n\n

指定した事業所の部門を取得する

レスポンスの例

\n\n
// プレミアムプラン（個人）、ベーシックプラン以上（法人）\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "long_name": "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123",\n    "indent_count": 1,\n    "parent_id": 101\n  }\n}\n// それ以外のプラン\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "long_name": "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123"\n  }\n}
\n", "operationId": "get_section", "parameters": [ { "name": "id", "in": "path", "description": "部門ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sectionResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Sections" ], "summary": "部門の更新", "description": "\n

概要

\n\n

指定した事業所の部門を更新する

レスポンスの例

\n\n
// プレミアムプラン（個人）、ベーシックプラン以上（法人）\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "long_name": "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123",\n    "indent_count": 1,\n    "parent_id": 101\n  }\n}\n// それ以外のプラン\n{\n  "section" : {\n    "id" : 102,\n    "company_id" : 1,\n    "name" : "開発部門",\n    "long_name": "開発部門",\n    "shortcut1" : "DEVELOPER",\n    "shortcut2" : "123"\n  }\n}
\n", "operationId": "update_section", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "部門の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sectionParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/sectionParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sectionResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Sections" ], "summary": "部門の削除", "description": "\n

概要

\n\n

指定した事業所の部門を削除する

", "operationId": "destroy_section", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/invoices": { "get": { "tags": [ "Invoices" ], "summary": "請求書一覧の取得", "description": "\n

概要

\n\n

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

\n", "operationId": "get_invoices", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "start_issue_date", "in": "query", "description": "請求日の開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_issue_date", "in": "query", "description": "請求日の終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "start_due_date", "in": "query", "description": "期日の開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_due_date", "in": "query", "description": "期日の終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "invoice_number", "in": "query", "description": "請求書番号", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "概要", "schema": { "type": "string" } }, { "name": "invoice_status", "in": "query", "description": "請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, unsubmitted: 送付待ち, submitted: 送付済み)", "schema": { "type": "string", "enum": [ "draft", "applying", "remanded", "rejected", "approved", "unsubmitted", "submitted" ] } }, { "name": "payment_status", "in": "query", "description": "入金ステータス (unsettled: 入金待ち, settled: 入金済み)", "schema": { "type": "string", "enum": [ "unsettled", "settled" ] } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最大: 100) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Invoices" ], "summary": "請求書の作成（廃止）", "deprecated": true, "description": "\n

概要

\n\n

指定した事業所の請求書を作成する

\n\n

注意点

\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行しました。これに伴い、2023年10月からfreee会計の「請求書の作成」エンドポイントは廃止され、freee請求書APIに移行しました。詳細は freee会計 APIの仕様変更（インボイス制度対応）についてをご確認ください。\n", "operationId": "create_invoice", "requestBody": { "description": "請求書の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/invoiceCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/invoices/{id}": { "get": { "tags": [ "Invoices" ], "summary": "請求書の取得", "description": "\n

概要

\n\n

指定した事業所の請求書を取得する

", "operationId": "get_invoice", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "請求書ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Invoices" ], "summary": "請求書の更新", "description": "\n

概要

\n\n

指定した事業所の請求書を更新する

\n\n

注意点

\n", "operationId": "update_invoice", "parameters": [ { "name": "id", "in": "path", "description": "請求書ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "請求書の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/invoiceUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/invoiceResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Invoices" ], "summary": "請求書の削除", "description": "\n

概要

\n\n

指定した事業所の請求書を削除する

", "operationId": "destroy_invoice", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/quotations": { "get": { "tags": [ "Quotations" ], "summary": "見積書一覧の取得", "description": "\n

概要

\n\n

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

\n", "operationId": "get_quotations", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "start_issue_date", "in": "query", "description": "見積日の開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_issue_date", "in": "query", "description": "見積日の終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "quotation_number", "in": "query", "description": "見積書番号", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "概要", "schema": { "type": "string" } }, { "name": "quotation_status", "in": "query", "description": "見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て)", "schema": { "type": "string", "enum": [ "all", "unsubmitted", "submitted" ] } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最大: 100) ", "schema": { "maximum": 100, "minimum": 1, "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Quotations" ], "summary": "見積書の作成（廃止）", "deprecated": true, "description": "\n

概要

\n\n

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

\n\n

注意点

\nインボイス制度に伴い、freee会計の帳票機能がfreee請求書に移行しました。これに伴い、2023年10月からfreee会計の「見積書の作成」エンドポイントは廃止され、freee請求書APIに移行しました。詳細は freee会計 APIの仕様変更（インボイス制度対応）についてをご確認ください。\n", "operationId": "create_quotation", "requestBody": { "description": "見積書の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/quotationCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/quotations/{id}": { "get": { "tags": [ "Quotations" ], "summary": "見積書の取得", "description": "\n

概要

\n\n

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

", "operationId": "get_quotation", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "見積書ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Quotations" ], "summary": "見積書の更新", "description": "\n

概要

\n\n

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

\n\n

注意点

\n", "operationId": "update_quotation", "parameters": [ { "name": "id", "in": "path", "description": "見積書ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "見積書の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/quotationUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/quotationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Quotations" ], "summary": "見積書の削除", "description": "\n

概要

\n\n

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

", "operationId": "destroy_quotation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals": { "get": { "tags": [ "Deals" ], "summary": "取引（収入・支出）一覧の取得", "description": "

概要

\n

指定した事業所の取引（収入・支出）一覧を取得する

\n

定義

\n\n

注意点

\n", "operationId": "get_deals", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "account_item_id", "in": "query", "description": "勘定科目IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "決済状況で絞込 (未決済: unsettled, 完了: settled)", "schema": { "type": "string", "enum": [ "unsettled", "settled" ] } }, { "name": "type", "in": "query", "description": "収支区分 (収入: income, 支出: expense)", "schema": { "type": "string", "enum": [ "income", "expense" ] } }, { "name": "start_issue_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_issue_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "start_due_date", "in": "query", "description": "支払期日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_due_date", "in": "query", "description": "支払期日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "start_renew_date", "in": "query", "description": "+更新日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_renew_date", "in": "query", "description": "+更新日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最大: 100) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } }, { "name": "registered_from", "in": "query", "description": "取引登録元アプリで絞込（me: 本APIを叩くアプリ自身から登録した取引のみ）", "schema": { "type": "string", "enum": [ "me" ] } }, { "name": "accruals", "in": "query", "description": "取引の債権債務行の表示（without: 表示しない(デフォルト), with: 表示する）", "schema": { "type": "string", "enum": [ "without", "with" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "deals", "meta" ], "properties": { "deals": { "type": "array", "items": { "$ref": "#/components/schemas/deal" } }, "meta": { "type": "object", "required": [ "total_count" ], "properties": { "total_count": { "type": "integer", "format": "int64", "minimum": 0, "description": "検索条件に合致する取引の総数", "example": 100 } } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Deals" ], "summary": "取引（収入・支出）の作成", "description": "

概要

\n

指定した事業所の取引（収入・支出）を作成する

\n

定義

\n\n

注意点

\n\n", "operationId": "create_deal", "requestBody": { "description": "取引（収入・支出）の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/dealCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealCreateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals/{id}": { "get": { "tags": [ "Deals" ], "summary": "取引（収入・支出）の取得", "description": "

概要

\n

指定した事業所の取引（収入・支出）を取得する

\n

定義

\n\n

注意点

\n", "operationId": "get_deal", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "accruals", "in": "query", "description": "取引の債権債務行の表示（without: 表示しない(デフォルト), with: 表示する）", "schema": { "type": "string", "enum": [ "without", "with" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Deals" ], "summary": "取引（収入・支出）の更新", "description": "

概要

\n

指定した事業所の取引（収入・支出）を更新する

\n

定義

\n\n

注意点

\n", "operationId": "update_deal", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（収入・支出）の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/dealUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Deals" ], "summary": "取引（収入・支出）の削除", "description": "

概要

\n

指定した取引（収入・支出）を削除する

\n", "operationId": "destroy_deal", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals/{id}/renews": { "post": { "tags": [ "Renews" ], "summary": "取引（収入・支出）の+更新の作成", "description": "

概要

\n

指定した事業所の取引（収入・支出）の+更新を作成する

\n

定義

\n\n

注意点

\n\n", "operationId": "create_deal_renew", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（収入・支出）の+更新の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renewCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/renewCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals/{id}/renews/{renew_id}": { "put": { "tags": [ "Renews" ], "summary": "取引（収入・支出）の+更新の更新", "description": "

概要

\n

指定した事業所の取引（収入・支出）の+更新を更新する

\n

定義

\n\n

注意点

\n\n", "operationId": "update_deal_renew", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "renew_id", "in": "path", "description": "+更新ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（収入・支出）の+更新の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/renewUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/renewUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Renews" ], "summary": "取引（収入・支出）の+更新の削除", "description": "

概要

\n

指定した事業所の取引（収入・支出）の+更新を削除する

\n

注意点

\n\n", "operationId": "delete_deal_renew", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "renew_id", "in": "path", "description": "+更新ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64s" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals/{id}/payments": { "post": { "tags": [ "Payments" ], "summary": "取引（収入・支出）の支払行の作成", "description": "

概要

\n

指定した事業所の取引（収入・支出）の支払行を作成する

\n

定義

\n", "operationId": "create_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（収入・支出）の支払行の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/paymentParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/deals/{id}/payments/{payment_id}": { "put": { "tags": [ "Payments" ], "summary": "取引（収入・支出）の支払行の更新", "description": "

概要

\n

指定した事業所の取引（収入・支出）の支払行を更新する

\n

定義

\n", "operationId": "update_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "payment_id", "in": "path", "description": "決済ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（収入・支出）の支払行の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/paymentParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/dealResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Payments" ], "summary": "取引（収入・支出）の支払行の削除", "description": "

概要

\n

指定した事業所の取引（収入・支出）の支払行を削除する

\n

定義

\n", "operationId": "destroy_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "payment_id", "in": "path", "description": "決済ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/manual_journals": { "get": { "tags": [ "ManualJournals" ], "summary": "振替伝票一覧の取得", "description": "\n

概要

\n\n

指定した事業所の振替伝票一覧を取得する

\n\n

定義

\n\n\n\n

注意点

\n\n", "operationId": "get_manual_journals", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_issue_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_issue_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "entry_side", "in": "query", "description": "貸借で絞込 (貸方: credit, 借方: debit)", "schema": { "type": "string", "enum": [ "credit", "debit" ] } }, { "name": "account_item_id", "in": "query", "description": "勘定科目IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "min_amount", "in": "query", "description": "金額で絞込：下限", "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } }, { "name": "max_amount", "in": "query", "description": "金額で絞込：上限", "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_1_tag_id", "in": "query", "description": "セグメント１IDで絞込（0を指定すると、セグメント１が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_2_tag_id", "in": "query", "description": "セグメント２IDで絞込（0を指定すると、セグメント２が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_3_tag_id", "in": "query", "description": "セグメント３IDで絞込（0を指定すると、セグメント３が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "comment_status", "in": "query", "description": "コメント状態で絞込（自分宛のコメント: posted_with_mention, 自分宛のコメント-未解決: raised_with_mention, 自分宛のコメント-解決済: resolved_with_mention, コメントあり: posted, 未解決: raised, 解決済: resolved, コメントなし: none）", "schema": { "type": "string", "enum": [ "posted_with_mention", "raised_with_mention", "resolved_with_mention", "posted", "raised", "resolved", "none" ] } }, { "name": "comment_important", "in": "query", "description": "重要コメント付きの振替伝票を絞込", "schema": { "type": "boolean" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "txn_number", "in": "query", "description": "仕訳番号で絞込（事業所の仕訳番号形式が有効な場合のみ）", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "manual_journals" ], "properties": { "manual_journals": { "type": "array", "items": { "$ref": "#/components/schemas/manual_journal" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "ManualJournals" ], "summary": "振替伝票の作成", "description": "\n

概要

\n\n

指定した事業所の振替伝票を作成する

\n\n

定義

\n\n\n\n

注意点

\n\n\n\n", "operationId": "create_manual_journal", "requestBody": { "description": "振替伝票の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manualJournalCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/manualJournalCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manualJournalResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serviceUnavailableError" } } } } } } }, "/api/1/manual_journals/{id}": { "get": { "tags": [ "ManualJournals" ], "summary": "振替伝票の取得", "description": "\n

概要

\n\n

指定した事業所の振替伝票を取得する

\n\n

定義

\n\n\n\n

注意点

\n\n", "operationId": "get_manual_journal", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manualJournalResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "ManualJournals" ], "summary": "振替伝票の更新", "description": "\n

概要

\n\n

指定した事業所の振替伝票を更新する

\n\n

定義

\n\n\n\n

注意点

\n\n\n\n", "operationId": "update_manual_journal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "振替伝票の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manualJournalUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/manualJournalUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/manualJournalResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "ManualJournals" ], "summary": "振替伝票の削除", "description": "\n

概要

\n\n

指定した事業所の振替伝票を削除する

", "operationId": "destroy_manual_journal", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/users": { "get": { "tags": [ "Users" ], "summary": "事業所に所属するユーザー一覧の取得", "description": "\n

概要

\n\n

事業所に所属するユーザー一覧を取得する

", "operationId": "get_users", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "users" ], "properties": { "users": { "type": "array", "items": { "$ref": "#/components/schemas/user" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/users/me": { "get": { "tags": [ "Users" ], "summary": "ログインユーザーの取得", "description": "\n

概要

\n\n

ログインユーザーを取得する

", "operationId": "get_users_me", "parameters": [ { "name": "companies", "in": "query", "description": "取得情報にユーザーが所属する事業所一覧を含める", "schema": { "type": "boolean", "enum": [ true, false ] } }, { "name": "advisor", "in": "query", "description": "取得情報に事業がアドバイザー事象所の場合は事業所毎の一意なプロフィールIDを含める", "schema": { "type": "boolean", "enum": [ true, false ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/meResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Users" ], "summary": "ログインユーザーの更新", "description": "\n

概要

\n\n

ログインユーザーを更新する

", "operationId": "update_user", "requestBody": { "description": "ログインユーザーの更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/userParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/userResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/users/capabilities": { "get": { "tags": [ "Users" ], "summary": "ログインユーザーの権限の取得", "description": "\n

概要

\n\n

ログインユーザーの権限を取得する

", "operationId": "get_users_capabilities", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "

レスポンスの各キーは以下の項目と対応しています。

\n

詳細は https://support.freee.co.jp/hc/ja/articles/210265673 を参照してください。

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
キー対応する項目
wallet_txns自動で経理 / 取得した明細
deals取引
transfers口座振替
docs見積書・納品書・請求書・領収書・発注書
doc_postings(請求書の)郵送
receiptsファイルボックス
receipt_stream_editor連続取引登録
spreadsheetsエクセルインポート
expense_applications経費精算
expense_application_sync_payroll経費精算の給与連携
payment_requests支払依頼
approval_requests各種申請
reports収益 / 費用レポート
reports_income_expense損益レポート
reports_receivables入金管理レポート
reports_payables支払管理レポート(一括振込ファイルを含む)
reports_cash_balance現預金レポート/資金繰りレポート
reports_managements_planning経営プランニング
reports_managements_navigation経営ナビゲーション
reports_crosstabs集計表
reports_custom_reports_aggregateカスタムレポート
reports_pl損益計算書(月次推移/試算表)
reports_bs貸借対照表(月次推移/試算表)
reports_general_ledgers総勘定元帳
reports_journals仕訳帳
manual_journals振替伝票
fixed_assets固定資産台帳
inventory_refreshes在庫棚卸
biz_allocations家事按分
payment_records支払調書
annual_reports決算書、確定申告書類
tax_reports消費税区分別表・消費税集計表
consumption_entries消費税申告書
tax_return連携用データ
account_item_statements勘定科目内訳明細書
month_end月締め
year_end年度締め
walletables口座 / 口座の同期
companies事業所の設定
invitationsメンバー招待
access_controls権限管理
sign_in_logsログイン履歴
user_attribute_logsユーザー更新履歴
app_role_logs権限変更履歴
txn_relationship_logs仕訳関連履歴
backupsバックアップ
opening_balances開始残高の設定
system_conversion乗り換え設定
resetsリセット
partners取引先
items品目
sections部門
tagsメモタグ
account_items勘定科目
taxes税区分
payroll_item_sets給与連携の設定
user_matchers自動登録ルール
deal_templates取引テンプレート
manual_journal_templates振替伝票テンプレート
cost_allocations部門配賦
approval_flow_routes承認経路
expense_application_templates経費科目
request_forms申請フォーム
system_messages_for_admin管理者向けお知らせ
company_internal_announcementsアナウンス
doc_change_logs受発注書類変更履歴
workflows仕訳承認
oauth_applicationsアプリ利用
oauth_authorizationsアプリ認可
bank_accountant_staff_usersアドバイザー事業所内でのメンバー管理
\n", "content": { "application/json": { "schema": { "type": "object", "required": [ "access_controls", "account_item_statements", "account_items", "annual_reports", "approval_flow_routes", "approval_requests", "app_role_logs", "backups", "bank_accountant_staff_users", "biz_allocations", "companies", "company_internal_announcements", "consumption_entries", "cost_allocations", "deal_templates", "deals", "doc_change_logs", "doc_postings", "docs", "expense_application_sync_payroll", "expense_application_templates", "expense_applications", "fixed_assets", "inventory_refreshes", "invitations", "items", "manual_journal_templates", "manual_journals", "month_end", "oauth_applications", "oauth_authorizations", "opening_balances", "partners", "payment_records", "payment_requests", "payroll_item_sets", "receipt_stream_editor", "receipts", "reports", "reports_bs", "reports_cash_balance", "reports_crosstabs", "reports_custom_reports_aggregate", "reports_general_ledgers", "reports_income_expense", "reports_journals", "reports_managements_navigation", "reports_managements_planning", "reports_payables", "reports_pl", "reports_receivables", "request_forms", "resets", "sections", "sign_in_logs", "spreadsheets", "system_conversion", "system_messages_for_admin", "tags", "tax_reports", "tax_return", "taxes", "transfers", "txn_relationship_logs", "user_attribute_logs", "user_matchers", "wallet_txns", "walletables", "workflows", "year_end" ], "properties": { "wallet_txns": { "$ref": "#/components/schemas/userCapabilityWithConfirm" }, "deals": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "transfers": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "docs": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "doc_postings": { "$ref": "#/components/schemas/userCapabilityJustCreate" }, "receipts": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "receipt_stream_editor": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "spreadsheets": { "$ref": "#/components/schemas/userCapabilityJustCreateRead" }, "expense_applications": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "expense_application_sync_payroll": { "$ref": "#/components/schemas/userCapabilityJustCreate" }, "payment_requests": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "approval_requests": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "reports": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_income_expense": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_receivables": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_payables": { "$ref": "#/components/schemas/userCapabilityJustReadWrite" }, "reports_cash_balance": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_managements_planning": { "$ref": "#/components/schemas/userCapabilityJustReadWrite" }, "reports_managements_navigation": { "$ref": "#/components/schemas/userCapabilityJustReadWrite" }, "reports_crosstabs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_custom_reports_aggregate": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_pl": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_bs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_general_ledgers": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "reports_journals": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "manual_journals": { "$ref": "#/components/schemas/userCapabilityWithSelfOnly" }, "fixed_assets": { "$ref": "#/components/schemas/userCapability" }, "inventory_refreshes": { "$ref": "#/components/schemas/userCapability" }, "biz_allocations": { "$ref": "#/components/schemas/userCapability" }, "payment_records": { "$ref": "#/components/schemas/userCapability" }, "annual_reports": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "tax_reports": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "consumption_entries": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "tax_return": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "account_item_statements": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "month_end": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "year_end": { "$ref": "#/components/schemas/userCapabilityJustReadUpdate" }, "walletables": { "$ref": "#/components/schemas/userCapabilityWithSync" }, "companies": { "$ref": "#/components/schemas/userCapabilityJustReadUpdate" }, "invitations": { "$ref": "#/components/schemas/userCapability" }, "access_controls": { "$ref": "#/components/schemas/userCapabilityWithWrite" }, "sign_in_logs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "user_attribute_logs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "app_role_logs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "txn_relationship_logs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "backups": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "opening_balances": { "$ref": "#/components/schemas/userCapabilityJustReadUpdate" }, "system_conversion": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "resets": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "partners": { "$ref": "#/components/schemas/userCapability" }, "items": { "$ref": "#/components/schemas/userCapability" }, "sections": { "$ref": "#/components/schemas/userCapability" }, "tags": { "$ref": "#/components/schemas/userCapability" }, "account_items": { "$ref": "#/components/schemas/userCapability" }, "taxes": { "$ref": "#/components/schemas/userCapabilityJustReadUpdate" }, "payroll_item_sets": { "$ref": "#/components/schemas/userCapability" }, "user_matchers": { "$ref": "#/components/schemas/userCapability" }, "deal_templates": { "$ref": "#/components/schemas/userCapability" }, "manual_journal_templates": { "$ref": "#/components/schemas/userCapability" }, "cost_allocations": { "$ref": "#/components/schemas/userCapabilityJustReadUpdate" }, "approval_flow_routes": { "$ref": "#/components/schemas/userCapability" }, "expense_application_templates": { "$ref": "#/components/schemas/userCapability" }, "request_forms": { "$ref": "#/components/schemas/userCapability" }, "system_messages_for_admin": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "company_internal_announcements": { "$ref": "#/components/schemas/userCapabilityJustUpdate" }, "doc_change_logs": { "$ref": "#/components/schemas/userCapabilityJustRead" }, "workflows": { "$ref": "#/components/schemas/userCapabilityJustReadUpdateDestroy" }, "oauth_applications": { "$ref": "#/components/schemas/userCapability" }, "oauth_authorizations": { "$ref": "#/components/schemas/userCapability" }, "bank_accountant_staff_users": { "$ref": "#/components/schemas/userCapability" } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/companies": { "get": { "tags": [ "Companies" ], "summary": "事業所一覧の取得", "description": "\n

概要

\n\n

ユーザーが所属する事業所一覧を取得する

\n\n

定義

\n\n", "operationId": "get_companies", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "事業所の取得", "description": "\n

概要

\n\n

ユーザーが所属する事業所を取得する

\n\n

定義

\n\n\n\n

", "operationId": "get_company", "parameters": [ { "name": "id", "in": "path", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "details", "in": "query", "description": "取得情報に勘定科目・税区分コード・品目・取引先・部門・メモタグ・口座の一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "account_items", "in": "query", "description": "取得情報に勘定科目一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "taxes", "in": "query", "description": "取得情報に税区分コード一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "items", "in": "query", "description": "取得情報に品目一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "partners", "in": "query", "description": "取得情報に取引先一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "sections", "in": "query", "description": "取得情報に部門一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "tags", "in": "query", "description": "取得情報にメモタグ一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } }, { "name": "walletables", "in": "query", "description": "取得情報に口座一覧を含める", "schema": { "type": "boolean", "enum": [ true ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/companyResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/items": { "get": { "tags": [ "Items" ], "summary": "品目一覧の取得", "description": "\n

概要

\n\n

指定した事業所の品目一覧を取得する

\n

事業所の設定で品目コードを使用する設定にしている場合、レスポンスで品目コード(code)を返します

", "operationId": "get_items", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_update_date", "in": "query", "description": "更新日で絞り込み：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_update_date", "in": "query", "description": "更新日で絞り込み：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/item" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Items" ], "summary": "品目の作成", "description": "\n

概要

\n\n

指定した事業所の品目を作成する

\n\n", "operationId": "create_item", "requestBody": { "description": "品目の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/itemParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/items/{id}": { "get": { "tags": [ "Items" ], "summary": "品目の取得", "description": "\n

概要

\n\n

指定した事業所の品目を取得する

\n

事業所の設定で品目コードを使用する設定にしている場合、レスポンスで品目コード(code)を返します

", "operationId": "get_item", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "品目ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Items" ], "summary": "品目の更新", "description": "\n

概要

\n\n

指定した事業所の品目を更新する

\n", "operationId": "update_item", "parameters": [ { "name": "id", "in": "path", "description": "品目ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "品目の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/itemParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/itemResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Items" ], "summary": "品目の削除", "description": "\n

概要

\n\n

指定した事業所の品目を削除する

", "operationId": "destroy_item", "parameters": [ { "name": "id", "in": "path", "description": "品目ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/taxes/codes": { "get": { "tags": [ "Taxes" ], "summary": "税区分一覧の取得（廃止予定）", "description": "\n

概要

\n\n

税区分一覧を取得する

\n\n

注意点

\n\n

このAPIは廃止予定のため非推奨です。api/1/taxes/companies/{company_id}（指定した事業所の税区分一覧の取得）をご利用ください。

", "operationId": "get_tax_codes", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "taxes" ], "properties": { "taxes": { "type": "array", "items": { "$ref": "#/components/schemas/tax" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/taxes/codes/{code}": { "get": { "tags": [ "Taxes" ], "summary": "税区分の取得", "description": "\n

概要

\n\n

税区分を取得する

", "operationId": "get_tax_code", "parameters": [ { "name": "code", "in": "path", "description": "税区分コード", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/taxResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/taxes/companies/{company_id}": { "get": { "tags": [ "Taxes" ], "summary": "指定した事業所の税区分一覧の取得", "description": "\n

概要

\n\n

指定した事業所の税区分一覧を取得する

", "operationId": "get_taxes_companies", "parameters": [ { "name": "company_id", "in": "path", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "display_category", "in": "query", "description": "税区分の表示カテゴリ（ tax_5: 5%表示の税区分、 tax_8: 8%表示の税区分、 tax_r8: 軽減税率8%表示の税区分、 tax_10: 10%表示の税区分、 tax_5_e80: インボイス経過措置5%表示80%控除の税区分、 tax_5_e50: インボイス経過措置5%表示50%控除の税区分、 tax_8_e80: インボイス経過措置8%表示80%控除の税区分、 tax_8_e50: インボイス経過措置8%表示50%控除の税区分、 tax_r8_e80: インボイス経過措置軽減税率8%表示80%控除の税区分、 tax_r8_e50: インボイス経過措置軽減税率8%表示50%控除の税区分、 tax_10_e80: インボイス経過措置10%表示80%控除の税区分、 tax_10_e50: インボイス経過措置10%表示50%控除の税区分）", "schema": { "type": "string", "enum": [ "tax_5", "tax_8", "tax_r8", "tax_10", "tax_5_e80", "tax_5_e50", "tax_8_e80", "tax_8_e50", "tax_r8_e80", "tax_r8_e50", "tax_10_e80", "tax_10_e50" ] } }, { "name": "available", "in": "query", "description": "税区分の使用設定。true: 使用する、false: 使用しない", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "taxes" ], "properties": { "taxes": { "type": "array", "items": { "type": "object", "required": [ "available", "code", "display_category", "name", "name_ja" ], "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 21 }, "name": { "type": "string", "description": "税区分名", "example": "sales_with_tax" }, "name_ja": { "type": "string", "description": "税区分名（日本語表示用）", "example": "課税売上" }, "display_category": { "type": "string", "description": "税区分の表示カテゴリ（ tax_5: 5%表示の税区分、 tax_8: 8%表示の税区分、 tax_r8: 軽減税率8%表示の税区分、 tax_10: 10%表示の税区分、 tax_5_e80: インボイス経過措置5%表示80%控除の税区分、 tax_5_e50: インボイス経過措置5%表示50%控除の税区分、 tax_8_e80: インボイス経過措置8%表示80%控除の税区分、 tax_8_e50: インボイス経過措置8%表示50%控除の税区分、 tax_r8_e80: インボイス経過措置軽減税率8%表示80%控除の税区分、 tax_r8_e50: インボイス経過措置軽減税率8%表示50%控除の税区分、 tax_10_e80: インボイス経過措置10%表示80%控除の税区分、 tax_10_e50: インボイス経過措置10%表示50%控除の税区分、 null: 税率未設定税区分）", "example": "tax_8", "enum": [ "tax_5", "tax_8", "tax_r8", "tax_10", "tax_5_e80", "tax_5_e50", "tax_8_e80", "tax_8_e50", "tax_r8_e80", "tax_r8_e50", "tax_10_e80", "tax_10_e50" ], "nullable": true }, "available": { "type": "boolean", "description": "税区分の使用設定。true: 使用する、false: 使用しない", "example": true } } } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/walletables": { "get": { "tags": [ "Walletables" ], "summary": "口座一覧の取得", "description": "\n

概要

\n\n

指定した事業所の口座一覧を取得する

\n\n

定義

\n\n", "operationId": "get_walletables", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "with_balance", "in": "query", "description": "残高情報を含める", "example": false, "schema": { "default": false, "type": "boolean" } }, { "name": "type", "in": "query", "description": "口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）", "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "walletables" ], "properties": { "walletables": { "type": "array", "items": { "$ref": "#/components/schemas/walletable" } }, "meta": { "type": "object", "properties": { "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true } } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Walletables" ], "summary": "口座の作成", "description": "\n

概要

\n\n

指定した事業所の口座を作成する

\n\n

注意点

\n\n\n

定義

\n\n", "operationId": "create_walletable", "requestBody": { "description": "口座の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletableCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/walletableCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletableCreateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/walletables/{type}/{id}": { "get": { "tags": [ "Walletables" ], "summary": "口座の取得", "description": "\n

概要

\n\n

指定した事業所の口座を取得する

\n\n

定義

\n\n", "operationId": "get_walletable", "parameters": [ { "name": "id", "in": "path", "description": "口座ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "path", "description": "口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）", "required": true, "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "walletable" ], "properties": { "walletable": { "$ref": "#/components/schemas/walletable" }, "meta": { "type": "object", "properties": { "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true } } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Walletables" ], "summary": "口座の更新", "description": "\n

概要

\n\n

指定した事業所の口座を更新する

", "operationId": "update_walletable", "parameters": [ { "name": "id", "description": "口座ID", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "path", "description": "口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）", "required": true, "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } } ], "requestBody": { "description": "口座の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletableUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/walletableUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "walletable" ], "properties": { "walletable": { "$ref": "#/components/schemas/walletableUpdateResponse" }, "meta": { "type": "object", "properties": { "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true } } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Walletables" ], "summary": "口座の削除", "description": "\n

概要

\n\n

指定した事業所の口座を削除する

\n\n

注意点

\n", "operationId": "destroy_walletable", "parameters": [ { "name": "id", "in": "path", "description": "口座ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "type", "in": "path", "description": "口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）", "required": true, "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/banks": { "get": { "tags": [ "Banks" ], "summary": "連携サービス一覧の取得", "description": "\n

概要

\n\n

連携しているサービス一覧を取得する

\n\n

定義

\n\n", "operationId": "get_banks", "parameters": [ { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 500 } }, { "name": "type", "in": "query", "description": "サービス種別", "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "banks" ], "properties": { "banks": { "type": "array", "items": { "$ref": "#/components/schemas/bank" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/banks/{id}": { "get": { "tags": [ "Banks" ], "summary": "連携サービスの取得", "description": "\n

概要

\n\n

連携しているサービスを取得する

\n\n

定義

\n\n", "operationId": "get_bank", "parameters": [ { "name": "id", "in": "path", "description": "連携サービスID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bankResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/transfers": { "get": { "tags": [ "Transfers" ], "summary": "取引（振替）一覧の取得", "description": "\n

概要

\n\n

指定した事業所の取引（振替）一覧を取得する

\n\n

定義

\n\n", "operationId": "get_transfers", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "振替日で絞込：開始日 (yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "振替日で絞込：終了日 (yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "transfers" ], "properties": { "transfers": { "type": "array", "items": { "$ref": "#/components/schemas/transfer" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Transfers" ], "summary": "取引（振替）の作成", "description": "\n

概要

\n\n

指定した事業所の取引（振替）を作成する

\n\n

定義

\n\n", "operationId": "create_transfer", "requestBody": { "description": "取引（振替）の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/transferParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/transfers/{id}": { "get": { "tags": [ "Transfers" ], "summary": "取引（振替）の取得", "description": "\n

概要

\n\n

指定した事業所の取引（振替）を取得する

\n\n

定義

\n\n", "operationId": "get_transfer", "parameters": [ { "name": "id", "in": "path", "description": "取引(振替)ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Transfers" ], "summary": "取引（振替）の更新", "description": "\n

概要

\n\n

指定した事業所の取引（振替）を更新する

\n\n

定義

\n\n", "operationId": "update_transfer", "parameters": [ { "name": "id", "in": "path", "description": "取引(振替)ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "取引（振替）の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/transferParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/transferResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Transfers" ], "summary": "取引（振替）の削除", "description": "\n

概要

\n\n

指定した事業所の取引（振替）を削除する

", "operationId": "destroy_transfer", "parameters": [ { "name": "id", "in": "path", "description": "取引(振替)ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/wallet_txns": { "get": { "tags": [ "Wallet txns" ], "summary": "口座明細一覧の取得", "description": "\n

概要

\n\n

指定した事業所の口座明細一覧を取得する

\n\n

定義

\n\n", "operationId": "get_wallet_txns", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "walletable_type", "in": "query", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet) walletable_type、walletable_idは同時に指定が必要です。", "schema": { "type": "string", "enum": [ "bank_account", "credit_card", "wallet" ] } }, { "name": "walletable_id", "in": "query", "description": "口座ID walletable_type、walletable_idは同時に指定が必要です。", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "取引日で絞込：開始日 (yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "取引日で絞込：終了日 (yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "entry_side", "in": "query", "description": "入金／出金 (入金: income, 出金: expense)", "schema": { "type": "string", "enum": [ "income", "expense" ] } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "wallet_txns" ], "properties": { "wallet_txns": { "type": "array", "items": { "$ref": "#/components/schemas/wallet_txn" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Wallet txns" ], "summary": "口座明細の作成", "description": "\n

概要

\n\n

指定した事業所の口座明細を作成する

\n\n

定義

\n\n", "operationId": "create_wallet_txn", "requestBody": { "description": "口座明細の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletTxnParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/walletTxnParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletTxnResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/wallet_txns/{id}": { "get": { "tags": [ "Wallet txns" ], "summary": "口座明細の取得", "description": "\n

概要

\n\n

指定した事業所の口座明細を取得する

\n\n

定義

\n\n", "operationId": "get_wallet_txn", "parameters": [ { "name": "id", "in": "path", "description": "明細ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/walletTxnResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Wallet txns" ], "summary": "口座明細の削除", "description": "\n

概要

\n

指定した事業所の口座明細を削除する

\n\n

注意点

\n", "operationId": "destroy_wallet_txn", "parameters": [ { "name": "id", "in": "path", "description": "明細ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/journals": { "get": { "tags": [ "Journals" ], "summary": "仕訳帳のダウンロード要求", "description": "\n

概要

\n\n

ユーザーが所属する事業所の仕訳帳のダウンロードをリクエストします。

\n\n

生成されるファイルのファイル形式と出力項目に関しては、ヘルプページをご参照ください。

\n\n

＊このAPIは無料プランのアカウントではご利用になれません。

\n\n

定義

\n\n", "operationId": "get_journals", "parameters": [ { "name": "download_type", "in": "query", "description": "ダウンロード形式", "required": true, "schema": { "type": "string", "enum": [ "generic", "generic_v2", "csv", "pdf" ] } }, { "name": "encoding", "in": "query", "description": "文字コード", "schema": { "type": "string", "enum": [ "sjis", "utf-8" ] } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "visible_tags[]", "in": "query", "description": "補助科目やコメントとして出力する項目", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "partner", "item", "tag", "section", "description", "wallet_txn_description", "segment_1_tag", "segment_2_tag", "segment_3_tag", "all" ] } } }, { "name": "visible_ids[]", "in": "query", "description": "追加出力するID項目", "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string", "enum": [ "deal_id", "transfer_id", "manual_journal_id" ] } } }, { "name": "start_date", "in": "query", "description": "取得開始日 (yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "取得終了日 (yyyy-mm-dd)", "schema": { "type": "string" } } ], "responses": { "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/journals/reports/{id}/status": { "get": { "tags": [ "Journals" ], "summary": "仕訳帳のステータスの取得", "description": "\n

概要

\n\n

仕訳帳のダウンロードリクエストのステータスを取得する

\n\n

＊このAPIは無料プランのアカウントではご利用になれません

\n\n

定義

\n\n", "operationId": "get_journal_status", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "id", "in": "path", "description": "受け付けID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journalStatusResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/journals/reports/{id}/download": { "get": { "tags": [ "Journals" ], "summary": "仕訳帳のダウンロード", "description": "\n

概要

\n\n

仕訳帳をダウンロードする

\n\n

＊このAPIは無料プランのアカウントではご利用になれません

\n\n

定義

\n\n", "operationId": "download_journal", "parameters": [ { "name": "id", "in": "path", "description": "受け付けID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_bs": { "get": { "tags": [ "Trial balance" ], "summary": "貸借対照表の取得", "description": "\n

概要

\n

指定した事業所の貸借対照表を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_bs?company_id=1&fiscal_year=2019&breakdown_display_type=partner

\n
\n\n
{\n  "trial_bs" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "breakdown_display_type" : "partner",\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1000,\n        "account_item_name" : "現金",\n        "hierarchy_level" : 2,\n        "account_category_name" : "流動資産",\n        "opening_balance" : 100000,\n        "debit_amount" : 50000,\n        "credit_amount" : 20000,\n        "closing_balance" : 130000,\n        "composition_ratio" : 0.25\n        "partners" : [{\n          "id" : 123,\n          "name" : "freee",\n          "opening_balance" : 100000,\n          "debit_amount" : 50000,\n          "credit_amount" : 20000,\n          "closing_balance" : 130000,\n          "composition_ratio" : 0.25\n          },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_bs", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない\n", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialBsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_bs_two_years": { "get": { "tags": [ "Trial balance" ], "summary": "貸借対照表(前年比較)の取得", "description": "\n

概要

\n

指定した事業所の貸借対照表(前年比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_bs_two_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_bs_two_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1000,\n        "account_item_name" : "現金",\n        "hierarchy_level" : 2,\n        "account_category_name" : "流動資産",\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_bs_two_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialBsTwoYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_bs_three_years": { "get": { "tags": [ "Trial balance" ], "summary": "貸借対照表(３期間比較)の取得", "description": "\n

概要

\n

指定した事業所の貸借対照表(３期間比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_bs_three_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_bs_three_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1000,\n        "account_item_name" : "現金",\n        "hierarchy_level" : 2,\n        "account_category_name" : "流動資産",\n        "two_year_before_closing_balance" : 50000,\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_bs_three_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialBsThreeYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書の取得", "description": "\n

概要

\n

指定した事業所の損益計算書を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl?company_id=1&fiscal_year=2019&breakdown_display_type=partner

\n
\n\n
{\n  "trial_pl" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "breakdown_display_type" : "partner",\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "opening_balance" : 100000,\n        "debit_amount" : 50000,\n        "credit_amount" : 20000,\n        "closing_balance" : 130000,\n        "composition_ratio" : 0.25\n        "partners" : [{\n          "id" : 123,\n          "name" : "freee",\n          "opening_balance" : 100000,\n          "debit_amount" : 50000,\n          "credit_amount" : 20000,\n          "closing_balance" : 130000,\n          "composition_ratio" : 0.25\n          },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_two_years": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(前年比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(前年比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_two_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_two_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_two_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlTwoYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_three_years": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(３期間比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(３期間比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_three_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_three_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "two_year_before_closing_balance" : 50000,\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_three_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlThreeYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_sections": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(部門比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(部門比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_sections?company_id=1&section_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_sections" :\n    {\n      "company_id" : 1,\n      "section_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "closing_balance" : 1000000,\n        "sections" : [{\n          "id": 1\n          "name": "営業部",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "広報部",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "人事部",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_sections", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "section_ids", "in": "query", "description": "出力する部門の指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択の部門で比較できます。）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlSectionsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_segment_1_tags": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(セグメント1比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(セグメント1比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_segment_1_tags?company_id=1&segment_1_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_segment_1_tags" :\n    {\n      "company_id" : 1,\n      "segment_1_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "closing_balance" : 1000000,\n        "segment_1_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_segment_1_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_1_tag_ids", "in": "query", "description": "出力するセグメント1タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlSegment_1TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_segment_2_tags": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(セグメント2比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(セグメント2比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_segment_2_tags?company_id=1&segment_2_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_segment_2_tags" :\n    {\n      "company_id" : 1,\n      "segment_2_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "closing_balance" : 1000000,\n        "segment_2_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_segment_2_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_2_tag_ids", "in": "query", "description": "出力するセグメント2タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlSegment_2TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_pl_segment_3_tags": { "get": { "tags": [ "Trial balance" ], "summary": "損益計算書(セグメント3比較)の取得", "description": "\n

概要

\n

指定した事業所の損益計算書(セグメント3比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_pl_segment_3_tags?company_id=1&segment_3_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_pl_segment_3_tags" :\n    {\n      "company_id" : 1,\n      "segment_3_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "売上高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "営業収益",\n        "closing_balance" : 1000000,\n        "segment_3_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_pl_segment_3_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_3_tag_ids", "in": "query", "description": "出力するセグメント3タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialPlSegment_3TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書の取得", "description": "

概要

\n

指定した事業所の製造原価報告書を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr?company_id=1&fiscal_year=2019&breakdown_display_type=partner

\n
\n
{\n  "trial_cr" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "breakdown_display_type" : "partner",\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "opening_balance" : 100000,\n        "debit_amount" : 50000,\n        "credit_amount" : 20000,\n        "closing_balance" : 130000,\n        "composition_ratio" : 0.25\n        "partners" : [{\n          "id" : 123,\n          "name" : "freee",\n          "opening_balance" : 100000,\n          "debit_amount" : 50000,\n          "credit_amount" : 20000,\n          "closing_balance" : 130000,\n          "composition_ratio" : 0.25\n          },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト), 全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_two_years": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(前年比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(前年比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_two_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_two_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_two_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト), 全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrTwoYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_three_years": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(３期間比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(３期間比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_three_years?company_id=1&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_three_years" :\n    {\n      "company_id" : 1,\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "two_year_before_closing_balance" : 50000,\n        "last_year_closing_balance" : 25000,\n        "closing_balance" : 100000,\n        "year_on_year" : 0.85\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_three_years", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト), 全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrThreeYearsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_sections": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(部門比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(部門比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_sections?company_id=1&section_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_sections" :\n    {\n      "company_id" : 1,\n      "section_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "closing_balance" : 1000000,\n        "sections" : [{\n          "id": 1\n          "name": "営業部",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "広報部",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "人事部",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_sections", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "section_ids", "in": "query", "description": "出力する部門の指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択の部門で比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item, セグメント1(法人向けプロフェッショナルプラン, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向けエンタープライズプラン):segment_2_tag, セグメント3(法人向けエンタープライズプラン): segment_3_tag） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、セグメント の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrSectionsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_segment_1_tags": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(セグメント1比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(セグメント1比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_segment_1_tags?company_id=1&segment_1_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_segment_1_tags" :\n    {\n      "company_id" : 1,\n      "segment_1_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "closing_balance" : 1000000,\n        "segment_1_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_segment_1_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_1_tag_ids", "in": "query", "description": "出力するセグメント1タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrSegment_1TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_segment_2_tags": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(セグメント2比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(セグメント2比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_segment_2_tags?company_id=1&segment_2_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_segment_2_tags" :\n    {\n      "company_id" : 1,\n      "segment_2_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "closing_balance" : 1000000,\n        "segment_2_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_segment_2_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_2_tag_ids", "in": "query", "description": "出力するセグメント2タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrSegment_2TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/trial_cr_segment_3_tags": { "get": { "tags": [ "Trial balance" ], "summary": "製造原価報告書(セグメント3比較)の取得", "description": "\n

概要

\n

指定した事業所の製造原価報告書(セグメント3比較)を取得する

\n\n

定義

\n\n\n

注意点

\n\n\n

レスポンスの例

\n\n
\n

GET https://api.freee.co.jp/api/1/reports/trial_cr_segment_3_tags?company_id=1&segment_3_tag_ids=1,2,3&fiscal_year=2019

\n
\n\n
{\n  "trial_cr_segment_3_tags" :\n    {\n      "company_id" : 1,\n      "segment_3_tag_ids" : "1,2,3",\n      "fiscal_year" : 2019,\n      "created_at" : "2019-12-17 12:00:50"\n      "balances" : [{\n        "account_item_id" : 1500,\n        "account_item_name" : "[製]期首材料棚卸高",\n        "hierarchy_level" : 2,\n        "account_category_name" : "期首原材料棚卸",\n        "closing_balance" : 1000000,\n        "segment_3_tags" : [{\n          "id": 1\n          "name": "プロジェクトA",\n          "closing_balance" : 100000\n        },\n        {\n          "id": 2\n          "name": "プロジェクトB",\n          "closing_balance" : 200000\n        },\n        {\n          "id": 3\n          "name": "プロジェクトC",\n          "closing_balance" : 300000\n        },\n        ...\n        ]\n      },\n      ...\n      ]\n    }\n}
\n", "operationId": "get_trial_cr_segment_3_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_3_tag_ids", "in": "query", "description": "出力するセグメント3タグの指定（半角数字のidを半角カンマ区切りスペースなしで指定してください。0を指定すると、未選択のセグメントで比較できます）", "required": true, "schema": { "type": "string" } }, { "name": "fiscal_year", "in": "query", "description": "会計年度", "schema": { "type": "integer", "format": "int64" } }, { "name": "start_month", "in": "query", "description": "発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "end_month", "in": "query", "description": "発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12 } }, { "name": "start_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "account_item_display_type", "in": "query", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）。指定されない場合、勘定科目: account_itemが指定されます。", "schema": { "type": "string", "enum": [ "account_item", "group" ] } }, { "name": "breakdown_display_type", "in": "query", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item） ※勘定科目はaccount_item_display_typeが「group」の時のみ指定できます。\n\n取引先、品目、部門 の各項目が単独で1,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。\n\n例）取引先の登録数が1,000以上、品目の登録数が999以下の場合\n* breakdown_display_type: 取引先を指定 → エラーになる\n* breakdown_display_type: 品目を指定 → エラーにならない", "schema": { "type": "string", "enum": [ "partner", "item", "section", "account_item" ] } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64" } }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ: only, 決算整理仕訳以外: without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] } }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n個人: プレミアムプラン、法人: プロフェッショナルプラン以上で指定可能です。
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "without_in_progress", "all" ] } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/trialCrSegment_3TagsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "429": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tooManyRequestsError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/reports/general_ledgers": { "get": { "tags": [ "General ledgers" ], "summary": "総勘定元帳一覧の取得（β版）", "description": "

概要

\n

指定した事業所の総勘定元帳一覧を取得する

\n
\n※このAPIはβ版として提供しています。\n\n

注意点

\n", "operationId": "get_general_ledgers", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" }, "example": 1000001 }, { "name": "start_date", "in": "query", "description": "期間で絞込：開始日 (yyyy-mm-dd)", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2020-01-01" }, { "name": "end_date", "in": "query", "description": "期間で絞込：終了日 (yyyy-mm-dd)", "required": true, "schema": { "type": "string", "format": "date", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2020-01-01" }, { "name": "account_item_name", "in": "query", "description": "勘定科目名で絞込", "schema": { "type": "string" }, "example": "売掛金" }, { "name": "tax_name", "in": "query", "description": "税区分名で絞込", "schema": { "type": "string", "enum": [ "課税", "対象外", "非課税", "不課税", "輸出等", "未選択", "課税売上", "輸出売上", "非課売上", "非資売上", "有価譲渡", "対外売上", "課税売返", "輸出売返", "非課売返", "非資売返", "課税売倒", "輸出売倒", "非課売倒", "非資売倒", "課税売回", "課対輸本", "非対輸本", "共対輸本", "課対輸税", "非対輸税", "共対輸税", "地消貨割", "課対仕入", "非対仕入", "共対仕入", "非課仕入", "対外仕入", "課対仕返", "非対仕返", "共対仕返", "非課仕返", "課売上一", "課売上二", "課売上三", "課売上四", "課売上五", "課売上六", "課対輸返", "非対輸返", "共対輸返", "課売返一", "課売返二", "課売返三", "課売返四", "課売返五", "課売返六" ] }, "example": "課税" }, { "name": "tax_rate", "in": "query", "description": "税率で絞込", "schema": { "type": "string", "enum": [ "tax_rate_5", "tax_rate_8", "tax_rate_10", "tax_rate_r8", "tax_rate_5_exempt_80", "tax_rate_5_exempt_50", "tax_rate_8_exempt_80", "tax_rate_8_exempt_50", "tax_rate_10_exempt_80", "tax_rate_10_exempt_50", "tax_rate_r8_exempt_80", "tax_rate_r8_exempt_50" ] }, "example": "tax_rate_5" }, { "name": "adjustment", "in": "query", "description": "決算整理仕訳で絞込（決算整理仕訳のみ：only, 決算整理仕訳以外：without）。指定されない場合、決算整理仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] }, "example": "only" }, { "name": "cost_allocation", "in": "query", "description": "配賦仕訳で絞込（配賦仕訳のみ：only,配賦仕訳以外：without）。指定されない場合、配賦仕訳を含む金額が返却されます。", "schema": { "type": "string", "enum": [ "only", "without" ] }, "example": "only" }, { "name": "partner_name", "in": "query", "description": "取引先で絞込（未選択を指定すると、取引先が未選択で絞り込めます）", "schema": { "type": "string" }, "example": "freeeパートナー" }, { "name": "item_name", "in": "query", "description": "品目で絞込（未選択を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "string" }, "example": "通勤手当" }, { "name": "section_name", "in": "query", "description": "部門で絞込（未選択を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "string" }, "example": "営業部" }, { "name": "tag_name", "in": "query", "description": "メモタグで絞込
\n取引数が多すぎる場合はタイムアウトする場合があります。
\nその場合はWeb画面よりPDF/CSV出力をご利用ください。\n", "schema": { "type": "string" }, "example": "タグ１" }, { "name": "segment_tag_1_name", "in": "query", "description": "セグメント1タグで絞込（未選択を指定すると、セグメント1タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント1タグ" }, { "name": "segment_tag_2_name", "in": "query", "description": "セグメント2タグで絞込（未選択を指定すると、セグメント2タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント2タグ" }, { "name": "segment_tag_3_name", "in": "query", "description": "セグメント3タグで絞込（未選択を指定すると、セグメント3タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント3タグ" }, { "name": "approval_flow_status", "in": "query", "description": "承認ステータスで絞込 (未承認を除く: without_in_progress (デフォルト)、全てのステータス: all)
\n事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。\n", "schema": { "type": "string", "enum": [ "all", "without_in_progress" ] }, "example": "without_in_progress" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/generalLedgersResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/serviceUnavailableError" } } } } } } }, "/api/1/receipts": { "get": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）一覧の取得", "description": "\n

概要

\n\n

指定した事業所のファイルボックス（証憑ファイル）一覧を取得する

", "operationId": "get_receipts", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "start_date", "in": "query", "description": "アップロード日 (yyyy-mm-dd)", "required": true, "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "description": "アップロード日 (yyyy-mm-dd)", "required": true, "schema": { "type": "string" } }, { "name": "user_name", "in": "query", "description": "アップロードしたユーザー名、メールアドレス", "schema": { "type": "string" } }, { "name": "number", "in": "query", "description": "アップロードファイルNo", "schema": { "type": "integer", "format": "int64" } }, { "name": "comment_type", "in": "query", "description": "posted:コメントあり, raised:未解決, resolved:解決済", "schema": { "type": "string", "enum": [ "posted", "raised", "resolved" ] } }, { "name": "comment_important", "in": "query", "description": "trueの時、重要コメント付きが対象", "schema": { "type": "boolean" } }, { "name": "category", "in": "query", "description": "all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視", "schema": { "type": "string", "enum": [ "all", "without_deal", "with_expense_application_line", "with_deal", "ignored" ] } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3000 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "receipts" ], "properties": { "receipts": { "type": "array", "items": { "$ref": "#/components/schemas/receipt" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）のアップロード", "description": "\n

概要

\n\n

ファイルボックス（証憑ファイル）をアップロードする

\n

注意点

\n", "operationId": "create_receipt", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/receiptCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/receiptResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/receipts/{id}": { "get": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）の取得", "description": "\n

概要

\n\n

指定した事業所のファイルボックス（証憑ファイル）を取得する

", "operationId": "get_receipt", "parameters": [ { "name": "id", "in": "path", "description": "ファイルボックス（証憑ファイル）ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/receiptResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）の更新", "description": "\n

概要

\n\n

ファイルボックス（証憑ファイル）を更新する

\n

注意点

\n", "operationId": "update_receipt", "parameters": [ { "name": "id", "in": "path", "description": "ファイルボックス（証憑ファイル）ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/receiptUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/receiptUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/receiptResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）の削除", "description": "\n

概要

\n\n

ファイルボックス（証憑ファイル）を削除する

", "operationId": "destroy_receipt", "parameters": [ { "name": "id", "in": "path", "description": "ファイルボックス（証憑ファイル）ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/receipts/{id}/download": { "get": { "tags": [ "Receipts" ], "summary": "ファイルボックス（証憑ファイル）のダウンロード", "description": "\n

概要

\n\n

指定した事業所のファイルボックス（証憑ファイル）をダウンロードする

", "operationId": "download_receipt", "parameters": [ { "name": "id", "in": "path", "description": "ファイルボックス（証憑ファイル）ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "text/csv": { "schema": { "type": "string" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_applications": { "get": { "tags": [ "Expense applications" ], "summary": "経費申請一覧の取得", "description": "\n

概要

\n\n

指定した事業所の経費申請一覧を取得する

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_expense_applications", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback", "unsettled", "settled" ] }, "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)、 取引ステータス(unsettled:清算待ち, settled:精算済み)" }, { "name": "payroll_attached", "in": "query", "schema": { "type": "boolean" }, "description": "true:給与連携あり、false:給与連携なし、未指定時:絞り込みなし", "example": true }, { "name": "start_transaction_date", "in": "query", "description": "発生日(経費申請項目の日付)で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "end_transaction_date", "in": "query", "description": "発生日(経費申請項目の日付)で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "application_number", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "申請No.", "example": 2 }, { "name": "title", "in": "query", "schema": { "type": "string", "maxLength": 250 }, "description": "申請タイトル", "example": "大阪出張" }, { "name": "start_issue_date", "in": "query", "description": "申請日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "end_issue_date", "in": "query", "description": "申請日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "applicant_id", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "申請者のユーザーID", "example": 1 }, { "name": "approver_id", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "承認者のユーザーID", "example": 1 }, { "name": "min_amount", "in": "query", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "description": "金額で絞込 (下限金額)", "example": 5000 }, { "name": "max_amount", "in": "query", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "description": "金額で絞込 (上限金額)", "example": 10000 }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationsIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Expense applications" ], "summary": "経費申請の作成", "description": "\n

概要

\n\n

指定した事業所の経費申請を作成する

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "create_expense_application", "requestBody": { "description": "経費申請の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_applications/{id}": { "get": { "tags": [ "Expense applications" ], "summary": "経費申請詳細の取得", "description": "\n

概要

\n\n

指定した事業所の経費申請を取得する

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_expense_application", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Expense applications" ], "summary": "経費申請の更新", "description": "\n

概要

\n\n

指定した事業所の経費申請を更新する

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_expense_application", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "経費申請の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Expense applications" ], "summary": "経費申請の削除", "description": "\n

概要

\n\n

指定した事業所の経費申請を削除する

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "destroy_expense_application", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_applications/{id}/actions": { "post": { "tags": [ "Expense applications" ], "summary": "経費申請の承認操作", "description": "\n

概要

\n\n

指定した事業所の経費申請の承認操作を行う

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_expense_application_action", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "経費申請の承認操作", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationActionCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationActionCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_applications/{id}/parent_approvable_requests": { "put": { "tags": [ "Expense applications" ], "summary": "経費申請に関連付ける各種申請の更新", "description": "\n

概要

\n\n

指定した事業所の経費申請に関連付ける各種申請の更新を行う

\n\n

経費精算APIの使い方については、freee会計経費精算APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_expense_application_parent_approvable_requests", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "経費申請に関連付ける各種申請の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationParentApprovableRequestUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationParentApprovableRequestUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_application_line_templates": { "get": { "tags": [ "Expense application line templates" ], "summary": "経費科目一覧の取得", "description": "\n

概要

\n\n

指定した事業所の経費科目一覧を取得する

", "operationId": "get_expense_application_line_templates", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 100 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "expense_application_line_templates" ], "properties": { "expense_application_line_templates": { "type": "array", "items": { "$ref": "#/components/schemas/expense_application_line_template" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Expense application line templates" ], "summary": "経費科目の作成", "operationId": "create_expense_application_line_template", "requestBody": { "description": "経費科目の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/expense_application_line_templates/{id}": { "get": { "tags": [ "Expense application line templates" ], "summary": "経費科目の取得", "operationId": "get_expense_application_line_template", "parameters": [ { "name": "id", "in": "path", "description": "経費科目ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Expense application line templates" ], "summary": "経費科目の更新", "operationId": "update_expense_application_line_template", "parameters": [ { "name": "id", "in": "path", "description": "経費科目ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "経費科目の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/expenseApplicationLineTemplateResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Expense application line templates" ], "summary": "経費科目の削除", "operationId": "destroy_expense_application_line_template", "parameters": [ { "name": "id", "in": "path", "description": "経費科目ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/payment_requests": { "get": { "tags": [ "Payment requests" ], "summary": "支払依頼一覧の取得", "description": "\n

概要

\n\n

指定した事業所の支払依頼一覧を取得する

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_payment_requests", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback", "unsettled", "settled" ] }, "description": "'申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)、 取引ステータス(unsettled:支払待ち, settled:支払済み)'
\napprover_id を指定した場合は無効です。\n" }, { "name": "start_application_date", "in": "query", "description": "申請日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "end_application_date", "in": "query", "description": "申請日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "start_issue_date", "in": "query", "description": "発生日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "end_issue_date", "in": "query", "description": "発生日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "application_number", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "申請No.", "example": 2 }, { "name": "title", "in": "query", "schema": { "type": "string", "maxLength": 250 }, "description": "申請タイトル", "example": "大阪出張" }, { "name": "applicant_id", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "申請者のユーザーID", "example": 1 }, { "name": "approver_id", "in": "query", "schema": { "type": "integer", "format": "int64" }, "description": "承認者のユーザーID
\n'approver_id を指定した場合は、 in_progress: 申請中 の支払依頼のみを返します。'\n", "example": 1 }, { "name": "min_amount", "in": "query", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "description": "金額で絞込 (下限金額)", "example": 5000 }, { "name": "max_amount", "in": "query", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "description": "金額で絞込 (上限金額)", "example": 10000 }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込", "schema": { "type": "integer", "format": "int64" } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "payment_method", "in": "query", "schema": { "type": "string", "enum": [ "none", "domestic_bank_transfer", "abroad_bank_transfer", "account_transfer", "credit_card" ] }, "description": "支払方法で絞込 (none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード)", "example": "credit_card" }, { "name": "start_payment_date", "in": "query", "description": "支払期限で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "end_payment_date", "in": "query", "description": "支払期限で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" }, "example": "2019-12-17" }, { "name": "document_code", "in": "query", "schema": { "type": "string" }, "description": "請求書番号で絞込", "example": "2" }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestsIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Payment requests" ], "summary": "支払依頼の作成", "description": "\n

概要

\n\n

指定した事業所の支払依頼を作成する

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "create_payment_request", "requestBody": { "description": "支払依頼の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/paymentRequestCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/payment_requests/{id}": { "get": { "tags": [ "Payment requests" ], "summary": "支払依頼の取得", "description": "\n

概要

\n\n

指定した事業所の支払依頼を取得する

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_payment_request", "parameters": [ { "name": "id", "in": "path", "description": "支払依頼ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Payment requests" ], "summary": "支払依頼の更新", "description": "\n

概要

\n\n

指定した事業所の支払依頼を更新する

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_payment_request", "parameters": [ { "name": "id", "in": "path", "description": "支払依頼ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "支払依頼の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/paymentRequestUpdateParams" } } }, "required": false }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Payment requests" ], "summary": "支払依頼の削除", "description": "\n

概要

\n\n

指定した事業所の支払依頼を削除する

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "destroy_payment_request", "parameters": [ { "name": "id", "in": "path", "description": "支払依頼ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/payment_requests/{id}/actions": { "post": { "tags": [ "Payment requests" ], "summary": "支払依頼の承認操作", "description": "\n

概要

\n\n

指定した事業所の支払依頼の承認操作を行う

\n\n

支払依頼APIの使い方については、freee会計支払依頼APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_payment_request_action", "parameters": [ { "name": "id", "in": "path", "description": "支払依頼ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "支払依頼の承認操作", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestActionCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/paymentRequestActionCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/paymentRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_requests": { "get": { "tags": [ "Approval requests" ], "summary": "各種申請一覧の取得", "description": "\n

概要

\n\n

指定した事業所の各種申請一覧を取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_approval_requests", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "schema": { "type": "string", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)\n承認者指定時には無効です。", "example": "draft" }, { "name": "application_number", "in": "query", "schema": { "type": "integer" }, "description": "申請No.", "example": 2 }, { "name": "title", "in": "query", "schema": { "type": "string" }, "description": "申請タイトル", "example": "大阪出張" }, { "name": "form_id", "in": "query", "schema": { "type": "integer" }, "description": "申請フォームID" }, { "name": "start_application_date", "in": "query", "description": "申請日で絞込：開始日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "end_application_date", "in": "query", "description": "申請日で絞込：終了日(yyyy-mm-dd)", "schema": { "type": "string" } }, { "name": "applicant_id", "in": "query", "schema": { "type": "integer" }, "description": "申請者のユーザーID" }, { "name": "min_amount", "in": "query", "description": "金額で絞込：以上", "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } }, { "name": "max_amount", "in": "query", "description": "金額で絞込：以下", "schema": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807 } }, { "name": "approver_id", "in": "query", "schema": { "type": "integer" }, "description": "承認者のユーザーID\n承認者指定時には申請ステータスが申請中のものだけが取得可能です。", "example": 1 }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "minimum": 0, "maximum": 2147483647 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestsIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Approval requests" ], "summary": "各種申請の作成", "description": "\n

概要

\n\n

指定した事業所の各種申請を作成する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "create_approval_request", "requestBody": { "description": "各種申請の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/approvalRequestCreateParams" } } }, "required": false }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_requests/{id}": { "get": { "tags": [ "Approval requests" ], "summary": "各種申請の取得", "description": "\n

概要

\n\n

指定した事業所の各種申請を取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_approval_request", "parameters": [ { "name": "id", "in": "path", "description": "各種申請ID", "required": true, "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "put": { "tags": [ "Approval requests" ], "summary": "各種申請の更新", "description": "\n

概要

\n\n

指定した事業所の各種申請を更新する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_approval_request", "parameters": [ { "name": "id", "in": "path", "description": "各種申請ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "各種申請の更新", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestUpdateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/approvalRequestUpdateParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Approval requests" ], "summary": "各種申請の削除", "description": "\n

概要

\n\n

指定した事業所の各種申請を削除する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "destroy_approval_request", "parameters": [ { "name": "id", "in": "path", "description": "各種申請ID", "required": true, "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_requests/{id}/actions": { "post": { "tags": [ "Approval requests" ], "summary": "各種申請の承認操作", "description": "\n

概要

\n\n

指定した事業所の各種申請の承認操作を行う

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "update_approval_request_action", "parameters": [ { "name": "id", "in": "path", "description": "各種申請ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "各種申請の承認操作", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestActionCreateParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/approvalRequestActionCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_requests/forms": { "get": { "tags": [ "Approval requests" ], "summary": "各種申請の申請フォーム一覧の取得", "description": "\n

概要

\n\n

指定した事業所の各種申請の申請フォーム一覧を取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_approval_request_forms", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestFormIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_requests/forms/{id}": { "get": { "tags": [ "Approval requests" ], "summary": "各種申請の申請フォームの取得", "description": "\n

概要

\n\n

指定した事業所の各種申請の申請フォームを取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n\n

注意点

\n", "operationId": "get_approval_request_form", "parameters": [ { "name": "id", "in": "path", "description": "申請フォームID", "required": true, "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalRequestFormResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_flow_routes": { "get": { "tags": [ "Approval flow routes" ], "summary": "申請経路一覧の取得", "description": "\n

概要

\n\n

指定した事業所の申請経路一覧を取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n

経費精算APIの使い方については、freee会計の経費精算APIの使い方をご参照ください

\n\n

注意点

\n\n", "operationId": "get_approval_flow_routes", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "included_user_id", "in": "query", "description": "経路に含まれるユーザーのユーザーID", "schema": { "type": "integer", "format": "int64" } }, { "name": "usage", "in": "query", "description": "申請種別（各申請種別が使用できる申請経路に絞り込めます。例えば、ApprovalRequest を指定すると、各種申請が使用できる申請経路に絞り込めます。）\n* `TxnApproval` - 仕訳承認\n* `ExpenseApplication` - 経費精算\n* `PaymentRequest` - 支払依頼\n* `ApprovalRequest` - 各種申請\n* `DocApproval` - 請求書等 (見積書・納品書・請求書・発注書)", "schema": { "type": "string", "enum": [ "TxnApproval", "ExpenseApplication", "PaymentRequest", "ApprovalRequest", "DocApproval" ] } }, { "name": "request_form_id", "in": "query", "description": "申請フォームID request_form_id指定時はusage条件をApprovalRequestに指定してください。指定しない場合無効になります。", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalFlowRoutesIndexResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/approval_flow_routes/{id}": { "get": { "tags": [ "Approval flow routes" ], "summary": "申請経路の取得", "description": "\n

概要

\n\n

指定した事業所の申請経路を取得する

\n\n

各種申請APIの使い方については、freee会計の各種申請APIの使い方をご参照ください

\n

経費精算APIの使い方については、freee会計の経費精算APIの使い方をご参照ください

\n\n

注意点

\n\n", "operationId": "get_approval_flow_route", "parameters": [ { "name": "id", "in": "path", "description": "経路申請ID", "required": true, "schema": { "type": "integer" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/approvalFlowRouteResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestNotFoundError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/segments/{segment_id}/tags": { "get": { "tags": [ "Segment tags" ], "summary": "セグメントタグ一覧の取得", "description": "\n

概要

\n\n

指定した事業所のセグメントタグ一覧を取得する

\n\n

注意点

\n\n", "operationId": "get_segment_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\n 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン\n 2,3: 法人向け エンタープライズプラン\n", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3 } }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 9223372036854775807 } }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) ", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 500 } } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "required": [ "segment_tags" ], "properties": { "segment_tags": { "type": "array", "items": { "$ref": "#/components/schemas/segment_tag" } } } } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "post": { "tags": [ "Segment tags" ], "summary": "セグメントタグの作成", "description": "\n

概要

\n\n

指定した事業所のセグメントタグを作成する

\n\n

注意点

\n\n", "operationId": "create_segment_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\n 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン\n 2,3: 法人向け エンタープライズプラン\n", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3 } } ], "requestBody": { "description": "セグメントタグの作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segmentTagParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/segmentTagParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segmentTagResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/segments/{segment_id}/tags/{id}": { "put": { "tags": [ "Segment tags" ], "summary": "セグメントタグの更新", "description": "\n

概要

\n\n

指定した事業所のセグメントタグを更新する

\n\n

注意点

\n\n", "operationId": "update_segment_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\n 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン\n 2,3: 法人向け エンタープライズプラン\n", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3 } }, { "name": "id", "in": "path", "description": "セグメントタグID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "requestBody": { "description": "セグメントタグの作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segmentTagParams" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/segmentTagParams" } } }, "required": true }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segmentTagResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } }, "delete": { "tags": [ "Segment tags" ], "summary": "セグメントタグの削除", "description": "\n

概要

\n\n

指定した事業所のセグメントタグを削除する

\n\n

注意点

\n\n", "operationId": "destroy_segments_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\n 1: 法人向けプロフェッショナル, 法人向けエンタープライズプラン\n 2,3: 法人向け エンタープライズプラン\n", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 3 } }, { "name": "id", "in": "path", "description": "セグメントタグID", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "description": "", "content": { } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } }, "/api/1/fixed_assets": { "get": { "tags": [ "Fixed assets" ], "summary": "固定資産一覧の取得", "description": "

概要

\n

指定した事業所の固定資産一覧を取得する

\n\n

定義

\n\n

注意点

\n", "operationId": "get_fixed_assets", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "example": 1000001 } }, { "name": "target_date", "in": "query", "description": "表示したい会計期間の開始年月日。開始年月日以外を指定した場合は、その日付が含まれる会計期間が対象となります。", "required": true, "schema": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "example": "2020-01-01" }, { "name": "offset", "in": "query", "description": "取得レコードのオフセット (デフォルト: 0)", "schema": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647 }, "example": 50 }, { "name": "limit", "in": "query", "description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 200)", "schema": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 200 }, "example": 50 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/fixedAssetResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/badRequestError" } } } }, "401": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/unauthorizedError" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/forbiddenError" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/internalServerError" } } } } } } } }, "components": { "schemas": { "paymentParams": { "required": [ "amount", "company_id", "date", "from_walletable_id", "from_walletable_type" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "date": { "type": "string", "description": "支払日", "example": "2019-12-17" }, "from_walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item)：payments指定時は必須", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet", "private_account_item" ] }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID）：payments指定時は必須", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 9223372036854775807, "description": "金額", "example": 10000 } } }, "dealCreateParams": { "required": [ "company_id", "details", "issue_date", "type" ], "type": "object", "properties": { "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "type": { "type": "string", "description": "収支区分 (収入: income, 支出: expense)", "example": "income", "enum": [ "income", "expense" ] }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "due_date": { "type": "string", "description": "支払期日(yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "ref_number": { "type": "string", "description": "管理番号", "example": "1" }, "details": { "type": "array", "items": { "required": [ "tax_code", "account_item_id", "amount" ], "type": "object", "properties": { "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）。 tax_code で非課税の税区分を指定する場合は指定できません。", "example": 800 } } } }, "payments": { "type": "array", "description": "支払行一覧（配列）：未指定の場合、未決済の取引を作成します。", "items": { "required": [ "amount", "date", "from_walletable_id", "from_walletable_type" ], "type": "object", "properties": { "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "支払金額：payments指定時は必須", "example": 5250 }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID）：payments指定時は必須", "example": 1 }, "from_walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item)：payments指定時は必須", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet", "private_account_item" ] }, "date": { "type": "string", "description": "支払日：payments指定時は必須", "example": "2019-12-17" } } } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } } } }, "dealUpdateParams": { "required": [ "company_id", "details", "issue_date", "type" ], "type": "object", "properties": { "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "type": { "type": "string", "description": "収支区分 (収入: income, 支出: expense)", "example": "income", "enum": [ "income", "expense" ] }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "due_date": { "type": "string", "description": "支払期日(yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "ref_number": { "type": "string", "description": "管理番号", "example": "1" }, "details": { "type": "array", "items": { "required": [ "tax_code", "account_item_id", "amount" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "取引行ID: 既存取引行を更新する場合に指定します。IDを指定しない取引行は、新規行として扱われ追加されます。また、detailsに含まれない既存の取引行は削除されます。更新後も残したい行は、必ず取引行IDを指定してdetailsに含めてください。", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）。 tax_code で非課税の税区分を指定する場合は指定できません。", "example": 800 } } } }, "receipt_ids": { "type": "array", "nullable": true, "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } } } }, "manualJournalCreateParams": { "required": [ "company_id", "details", "issue_date" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "adjustment": { "type": "boolean", "description": "決算整理仕訳フラグ（falseまたは未指定の場合: 日常仕訳）", "example": false }, "details": { "type": "array", "items": { "required": [ "account_item_id", "amount", "entry_side", "tax_code" ], "type": "object", "properties": { "entry_side": { "type": "string", "description": "貸借（貸方: credit, 借方: debit）", "example": "debit", "enum": [ "debit", "credit" ] }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）", "example": 10800 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）", "example": 800 }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } }, "description": "貸借行一覧（配列）: 貸借合わせて100行まで登録できます。" } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } } } }, "manualJournalUpdateParams": { "required": [ "company_id", "details", "issue_date" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "adjustment": { "type": "boolean", "description": "決算整理仕訳フラグ（falseまたは未指定の場合: 日常仕訳）", "example": false }, "details": { "type": "array", "items": { "required": [ "account_item_id", "amount", "entry_side", "tax_code" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "貸借行ID: 既存貸借行を更新または削除する場合に指定します。IDを指定しない貸借行は、新規行として扱われ追加されます。", "example": 1 }, "entry_side": { "type": "string", "description": "貸借（貸方: credit, 借方: debit）", "example": "debit", "enum": [ "debit", "credit" ] }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）", "example": 10800 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）", "example": 800 }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } }, "description": "貸借行一覧（配列）: 貸借合わせて100行まで登録できます。" } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } } } }, "itemParams": { "type": "object", "required": [ "company_id", "name" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "品目名 (30文字以内)", "example": "新しい品目" }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "NEWITEM" }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "202" }, "code": { "type": "string", "maxLength": 20, "description": "品目コード (品目コードを使用する設定の場合は、codeの指定が必須です)", "example": "code001", "pattern": "^[0-9a-zA-Z_-]+$" } } }, "walletableCreateParams": { "type": "object", "required": [ "company_id", "name", "type" ], "properties": { "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "ＸＸ銀行" }, "type": { "type": "string", "description": "口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "bank_id": { "type": "integer", "format": "int64", "description": "連携サービスID（typeにbank_account、credit_cardを指定する場合は必須）", "example": 1 }, "is_asset": { "type": "boolean", "description": "口座を資産口座とするか負債口座とするか（true: 資産口座 (デフォルト), false: 負債口座）
\nbank_idを指定しない場合にのみ使われます。
\nbank_idを指定する場合には資産口座か負債口座かはbank_idに指定したサービスに応じて決定され、is_assetに指定した値は無視されます。\n", "example": true } } }, "walletableUpdateParams": { "type": "object", "required": [ "company_id", "name" ], "properties": { "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "ＸＸ銀行" }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 } } }, "walletableUpdateResponse": { "type": "object", "required": [ "bank_id", "id", "name", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "freee銀行" }, "bank_id": { "type": "integer", "format": "int64", "description": "サービスID", "example": 3, "nullable": true }, "type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "last_balance": { "type": "integer", "format": "int64", "description": "同期残高", "example": 1565583 }, "walletable_balance": { "type": "integer", "format": "int64", "description": "登録残高", "example": 1340261 } } }, "transferParams": { "required": [ "amount", "company_id", "date", "from_walletable_id", "from_walletable_type", "to_walletable_id", "to_walletable_type" ], "type": "object", "properties": { "to_walletable_id": { "type": "integer", "format": "int64", "description": "振替先口座ID", "example": 1 }, "to_walletable_type": { "type": "string", "description": "振替先口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "振替元口座ID", "example": 1 }, "from_walletable_type": { "type": "string", "description": "振替元口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "credit_card", "enum": [ "bank_account", "credit_card", "wallet" ] }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "金額", "example": 5000 }, "date": { "type": "string", "description": "振替日 (yyyy-mm-dd)", "example": "2019-12-17" }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } } }, "walletTxnParams": { "type": "object", "required": [ "amount", "company_id", "date", "entry_side", "walletable_id", "walletable_type" ], "properties": { "entry_side": { "type": "string", "description": "入金／出金 (入金: income, 出金: expense)", "example": "income", "enum": [ "income", "expense" ] }, "description": { "type": "string", "description": "取引内容", "example": "取引内容" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額", "example": 5000 }, "walletable_id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "date": { "type": "string", "description": "取引日 (yyyy-mm-dd)", "example": "2019-12-17" }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "balance": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "残高 (銀行口座等)", "example": 10000 } } }, "expenseApplicationCreateParams": { "type": "object", "required": [ "company_id", "title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "maxLength": 250, "description": "申請タイトル (250文字以内)", "example": "大阪出張" }, "issue_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。\n", "example": "2019-12-17" }, "description": { "type": "string", "maxLength": 10000, "description": "備考 (10000文字以内)", "example": "◯◯連携先ID: cx12345" }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 101 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "transaction_date" ], "properties": { "receipt_id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 606 }, "transaction_date": { "type": "string", "description": "発生日(yyyy-mm-dd)", "example": "2019-12-17" }, "sub_receipt_ids": { "type": "array", "description": "補足資料（配列）\n receipt_id（証憑ファイル）を指定してください。\n receipt_id（証憑ファイル）は5個まで指定できます", "items": { "type": "integer", "format": "int64", "example": 606 } }, "expense_application_lines": { "type": "array", "description": "明細行一覧（配列）", "items": { "type": "object", "properties": { "description": { "type": "string", "maxLength": 250, "description": "内容 (250文字以内)", "example": "交通費：新幹線往復（東京〜大阪）" }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "金額", "example": 30000 }, "expense_application_line_template_id": { "type": "integer", "format": "int64", "description": "経費科目ID", "example": 505 } } } } } } }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID
\n\n", "example": 1 }, "approver_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID
\n「承認者を指定」の経路を申請経路として使用する場合に指定してください。
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "draft": { "type": "boolean", "description": "経費申請のステータス
\nfalseを指定した時は申請中（in_progress）で経費申請を作成します。
\ntrueを指定した時は下書き（draft）で経費申請を作成します。
\n未指定の時は下書きとみなして経費申請を作成します。\n", "example": true }, "parent_id": { "type": "integer", "format": "int64", "description": "親申請ID(法人向けプロフェッショナル, 法人向け エンタープライズプラン)
\n\n", "example": 2 }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID(法人向けプロフェッショナル, 法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID(法人向け エンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 2 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID(法人向け エンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 3 } } }, "expenseApplicationUpdateParams": { "type": "object", "required": [ "company_id", "title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "maxLength": 250, "description": "申請タイトル (250文字以内)", "example": "大阪出張" }, "issue_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。\n", "example": "2019-12-17" }, "description": { "type": "string", "maxLength": 10000, "description": "備考 (10000文字以内)", "example": "◯◯連携先ID: cx12345" }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 101 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "transaction_date" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請の申請行ID: 既存申請行を更新する場合に指定します。IDを指定しない申請行は、新規行として扱われ追加されます。また、purchase_linesに含まれない既存の申請行は削除されます。更新後も残したい行は、必ず経費申請の申請行IDを指定してpurchase_linesに含めてください。", "example": 1 }, "transaction_date": { "type": "string", "description": "発生日(yyyy-mm-dd)", "example": "2019-12-17" }, "receipt_id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 606 }, "sub_receipt_ids": { "type": "array", "description": "補足資料（配列）\n receipt_id（証憑ファイル）を指定してください。\n receipt_id（証憑ファイル）は5個まで指定できます", "items": { "type": "integer", "format": "int64", "example": 606 } }, "expense_application_lines": { "type": "array", "description": "明細行一覧（配列）", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請の明細行ID: 既存明細行を更新する場合に指定します。IDを指定しない明細行は、新規行として扱われ追加されます。また、expense_application_linesに含まれない既存の明細行は削除されます。更新後も残したい行は、必ず経費申請の明細行IDを指定してexpense_application_linesに含めてください。", "example": 1 }, "description": { "type": "string", "maxLength": 250, "description": "内容 (250文字以内)", "example": "交通費：新幹線往復（東京〜大阪）" }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "金額", "example": 30000 }, "expense_application_line_template_id": { "type": "integer", "format": "int64", "description": "経費科目ID", "example": 505 } } } } } } }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID
\n\n", "example": 1 }, "approver_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "draft": { "type": "boolean", "description": "経費申請のステータス
\nfalseを指定した時は申請中（in_progress）で経費申請を更新します。
\ntrueを指定した時は下書き（draft）で経費申請を更新します。
\n未指定の時は下書きとみなして経費申請を更新します。\n", "example": true }, "parent_id": { "type": "integer", "format": "int64", "description": "親申請ID(法人向け プロフェッショナルプラン, 法人向け エンタープライズプラン)
\n\n", "example": 2, "nullable": true }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID(法人向けプロフェッショナル, 法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID(法人向け エンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 2 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID(法人向け エンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 3 } } }, "expenseApplicationActionCreateParams": { "type": "object", "required": [ "company_id", "approval_action", "target_step_id", "target_round" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "approval_action": { "type": "string", "description": "操作(approve: 承認する、force_approve: 代理承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す)", "example": "approve", "enum": [ "approve", "force_approve", "cancel", "reject", "feedback", "force_feedback" ] }, "target_step_id": { "type": "integer", "format": "int64", "description": "対象承認ステップID 経費申請の取得APIレスポンス.current_step_idを送信してください。", "example": 1 }, "target_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "対象round。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。経費申請の取得APIレスポンス.current_roundを送信してください。", "example": 1 }, "next_approver_id": { "type": "integer", "format": "int64", "description": "次ステップの承認者のユーザーID", "example": 1, "nullable": true } } }, "expenseApplicationParentApprovableRequestUpdateParams": { "type": "object", "required": [ "company_id", "parent_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "parent_id": { "type": "integer", "format": "int64", "description": "各種申請ID\n- 経費申請に関連付ける各種申請IDを指定します\n- 閲覧権限のある承認済みの既存各種申請IDのみ指定ができます\n- 既に経費申請に紐付いている各種申請との関連は解除されます\n- 経費申請に紐付く各種申請を解除する場合はnullを指定してください\n", "example": 1, "nullable": true } } }, "paymentRequestCreateParams": { "type": "object", "required": [ "company_id", "title", "payment_request_lines", "approval_flow_route_id", "draft", "issue_date" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル", "example": "仕入代金支払い" }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。\n", "example": "2019-12-17" }, "description": { "type": "string", "description": "備考", "example": "◯◯連携先ID: cx12345" }, "payment_request_lines": { "type": "array", "description": "支払依頼の項目行一覧（配列）", "items": { "type": "object", "required": [ "amount" ], "properties": { "line_type": { "type": "string", "description": "'行の種類 (deal_line: 支払依頼の通常取引行, negative_line: 支払依頼の控除・マイナス行, withholding_tax: 源泉所得税行)'
\n'デフォルトは deal_line: 支払依頼の通常取引行 です'\n", "example": "deal_line", "enum": [ "deal_line", "negative_line", "withholding_tax" ] }, "description": { "type": "string", "description": "内容", "example": "原稿料" }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 99999999999, "description": "金額", "example": 30000 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード
\n勘定科目IDを指定する場合は必須です。\n", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID(法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID(法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 } } } }, "approver_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID
\n「承認者を指定」の経路を申請経路として使用する場合に指定してください。
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID
\n指定する申請経路IDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "parent_id": { "type": "integer", "format": "int64", "description": "親申請ID(法人向け エンタープライズプラン、プロフェッショナルプラン)
\n\n", "example": 2, "nullable": true }, "draft": { "type": "boolean", "description": "支払依頼のステータス
\nfalseを指定した時は申請中（in_progress）で支払依頼を作成します。
\ntrueを指定した時は下書き（draft）で支払依頼を作成します。\n", "example": true }, "document_code": { "type": "string", "maxLength": 255, "description": "請求書番号（255文字以内）", "example": "2" }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "payment_date": { "type": "string", "description": "支払期限 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "payment_method": { "type": "string", "description": "'支払方法(none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード)'
\n'デフォルトは none: 指定なし です。'\n", "example": "none", "enum": [ "none", "domestic_bank_transfer", "abroad_bank_transfer", "account_transfer", "credit_card" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "支払先の取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "支払先の取引先コード
\n支払先の取引先ID指定時には無効\n", "example": "code001", "nullable": true }, "bank_code": { "type": "string", "maxLength": 4, "description": "銀行コード（半角数字1桁〜4桁）
\n支払先指定時には無効\n", "example": "0001" }, "bank_name": { "type": "string", "maxLength": 255, "description": "銀行名（255文字以内）
\n支払先指定時には無効\n", "example": "freee銀行" }, "bank_name_kana": { "type": "string", "maxLength": 15, "description": "銀行名（カナ）（15文字以内）
\n支払先指定時には無効\n", "example": "フリーギンコウ" }, "branch_code": { "type": "string", "maxLength": 3, "description": "支店番号（半角数字1桁〜3桁）
\n支払先指定時には無効\n", "example": "101" }, "branch_name": { "type": "string", "maxLength": 255, "description": "支店名（255文字以内）
\n支払先指定時には無効\n", "example": "銀座支店" }, "branch_kana": { "type": "string", "maxLength": 15, "description": "支店名（カナ）（15文字以内）
\n指定可能な文字は、英数・カナ・丸括弧・ハイフン・スペースのみです。
\n支払先指定時には無効\n", "example": "ギンザシテン" }, "account_name": { "type": "string", "maxLength": 48, "description": "受取人名（カナ）（48文字以内）
\n支払先指定時には無効\n", "example": "フリータロウ" }, "account_number": { "type": "string", "maxLength": 7, "description": "口座番号（半角数字1桁〜7桁）
\n支払先指定時には無効\n", "example": "1010101" }, "account_type": { "type": "string", "description": "'口座種別(ordinary: 普通、checking: 当座、earmarked: 納税準備預金、savings: 貯蓄、other: その他)'
\n'支払先指定時には無効'
\n'デフォルトは ordinary: 普通 です'\n", "example": "ordinary", "enum": [ "ordinary", "checking", "earmarked", "savings", "other" ] }, "qualified_invoice_status": { "type": "string", "description": "適格請求書発行事業者（qualified: 該当する、not_qualified: 該当しない、unspecified: 未選択）\n- 支払依頼をインボイス要件をみたす申請として扱うかどうかを表します。\n- qualified_invoice_statusキーをリクエストに含めない場合、unspecifiedが適用されます。\n- issue_dateが2023年9月30日以前の場合、unspecified以外利用できません。\n- インボイス経過措置の税区分の設定が使用する設定になっていない場合、unspecified以外利用できません。\n", "enum": [ "qualified", "not_qualified", "unspecified" ], "example": "qualified" } } }, "paymentRequestUpdateParams": { "type": "object", "required": [ "company_id", "title", "payment_request_lines", "approval_flow_route_id", "draft", "issue_date" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル
\n申請者が、下書き状態もしくは差戻し状態の支払依頼に対して指定する場合のみ有効\n", "example": "仕入代金支払い" }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。
\n申請者が、下書き状態もしくは差戻し状態の支払依頼に対して指定する場合のみ有効\n", "example": "2019-12-17" }, "description": { "type": "string", "description": "備考", "example": "◯◯連携先ID: cx12345" }, "payment_request_lines": { "type": "array", "description": "支払依頼の項目行一覧（配列）", "items": { "type": "object", "required": [ "amount" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "支払依頼の項目行ID: 既存項目行を更新する場合に指定します。IDを指定しない項目行は、新規行として扱われ追加されます。また、payment_request_linesに含まれない既存の項目行は削除されます。更新後も残したい行は、必ず支払依頼の項目行IDを指定してpayment_request_linesに含めてください。", "example": 1 }, "line_type": { "type": "string", "description": "'行の種類 (deal_line: 支払依頼の通常取引行, negative_line: 支払依頼の控除・マイナス行, withholding_tax: 源泉所得税行)'
\n'デフォルトは deal_line: 支払依頼の通常取引行 です'\n", "example": "deal_line", "enum": [ "deal_line", "negative_line", "withholding_tax" ] }, "description": { "type": "string", "description": "内容", "example": "原稿料" }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 99999999999, "description": "金額", "example": 30000 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード
\n勘定科目IDを指定する場合は必須です。\n", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID(法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID(法人向けエンタープライズプラン)
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 } } } }, "approver_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID
\n「承認者を指定」の経路を申請経路として使用する場合に指定してください。
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID
\n指定する申請経路IDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "draft": { "type": "boolean", "description": "支払依頼のステータス
\nfalseを指定した時は申請中（in_progress）で支払依頼を更新します。
\ntrueを指定した時は下書き（draft）で支払依頼を更新します。\n", "example": true }, "document_code": { "type": "string", "maxLength": 255, "description": "請求書番号（255文字以内）", "example": "2" }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "example": 1 } }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "payment_date": { "type": "string", "description": "支払期限 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "payment_method": { "type": "string", "description": "'支払方法(none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード)'
\n'デフォルトは none: 指定なし です。'\n", "example": "none", "enum": [ "none", "domestic_bank_transfer", "abroad_bank_transfer", "account_transfer", "credit_card" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "支払先の取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "支払先の取引先コード
\n支払先の取引先ID指定時には無効\n", "example": "code001", "nullable": true }, "bank_code": { "type": "string", "maxLength": 4, "description": "銀行コード（半角数字1桁〜4桁）
\n支払先指定時には無効\n", "example": "0001" }, "bank_name": { "type": "string", "maxLength": 255, "description": "銀行名（255文字以内）
\n支払先指定時には無効\n", "example": "freee銀行" }, "bank_name_kana": { "type": "string", "maxLength": 15, "description": "銀行名（カナ）（15文字以内）
\n支払先指定時には無効\n", "example": "フリーギンコウ" }, "branch_code": { "type": "string", "maxLength": 3, "description": "支店番号（半角数字1桁〜3桁）
\n支払先指定時には無効\n", "example": "101" }, "branch_name": { "type": "string", "maxLength": 255, "description": "支店名（255文字以内）
\n支払先指定時には無効\n", "example": "銀座支店" }, "branch_kana": { "type": "string", "maxLength": 15, "description": "支店名（カナ）（15文字以内）
\n指定可能な文字は、英数・カナ・丸括弧・ハイフン・スペースのみです。
\n支払先指定時には無効\n", "example": "ギンザシテン" }, "account_name": { "type": "string", "maxLength": 48, "description": "受取人名（カナ）（48文字以内）
\n支払先指定時には無効\n", "example": "フリータロウ" }, "account_number": { "type": "string", "maxLength": 7, "description": "口座番号（半角数字1桁〜7桁）
\n支払先指定時には無効\n", "example": "1010101" }, "account_type": { "type": "string", "description": "'口座種別(ordinary: 普通、checking: 当座、earmarked: 納税準備預金、savings: 貯蓄、other: その他)'
\n'支払先指定時には無効'
\n'デフォルトは ordinary: 普通 です'\n", "example": "ordinary", "enum": [ "ordinary", "checking", "earmarked", "savings", "other" ] }, "qualified_invoice_status": { "type": "string", "description": "適格請求書発行事業者（qualified: 該当する、not_qualified: 該当しない、unspecified: 未選択）\n- 支払依頼をインボイス要件をみたす申請として扱うかどうかを表します。\n- qualified_invoice_statusキーをリクエストに含めない場合、unspecifiedが適用されます。\n- issue_dateが2023年9月30日以前の場合、unspecified以外利用できません。\n- インボイス経過措置の税区分の設定が使用する設定になっていない場合、unspecified以外利用できません。\n", "enum": [ "qualified", "not_qualified", "unspecified" ], "example": "qualified" } } }, "partnerCreateParams": { "required": [ "company_id", "name" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "取引先名 (255文字以内、重複不可)", "example": "新しい取引先" }, "code": { "type": "string", "description": "取引先コード（取引先コードの利用を有効にしている場合は、codeの指定は必須です。ただし重複は不可。）", "example": "code001" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット１ (255文字以内)", "example": "NEWPARTNER" }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット２ (255文字以内)", "example": "502" }, "org_code": { "type": "integer", "format": "int64", "description": "事業所種別（null: 未設定、1: 法人、2: 個人）", "example": 1, "enum": [ 1, 2 ], "nullable": true }, "country_code": { "type": "string", "description": "地域（JP: 国内、ZZ:国外）、指定しない場合JPになります。", "example": "JP", "enum": [ "JP", "ZZ" ] }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "新しい取引先正式名称" }, "name_kana": { "type": "string", "maxLength": 255, "description": "カナ名称（255文字以内）", "example": "アタラシイトリヒキサキメイショウ" }, "default_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中" }, "phone": { "type": "string", "description": "電話番号", "example": "03-1234-xxxx" }, "contact_name": { "type": "string", "maxLength": 255, "description": "担当者 氏名 (255文字以内)", "example": "営業担当" }, "email": { "type": "string", "maxLength": 255, "description": "担当者 メールアドレス (255文字以内)", "example": "contact@example.com" }, "payer_walletable_id": { "type": "integer", "format": "int64", "description": "振込元口座ID（一括振込ファイル用）:（walletableのtypeが'bank_account'のidのみ指定できます。また、未設定にする場合は、nullを指定してください。）", "example": 1, "nullable": true }, "transfer_fee_handling_side": { "type": "string", "description": "振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee)、指定しない場合payerになります。", "example": "payer", "enum": [ "payer", "payee" ] }, "qualified_invoice_issuer": { "type": "boolean", "description": "インボイス制度適格請求書発行事業者（true: 対象事業者、false: 非対象事業者）\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": false, "default": false }, "invoice_registration_number": { "type": "string", "maxLength": 14, "minLength": 13, "pattern": "^T?[1-9][0-9]{12}$", "description": "インボイス制度適格請求書発行事業者登録番号\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001", "nullable": true }, "address_attributes": { "type": "object", "properties": { "zipcode": { "type": "string", "maxLength": 8, "description": "郵便番号（8文字以内）", "example": "000-0000" }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4 }, "street_name1": { "type": "string", "maxLength": 255, "description": "市区町村・番地（255文字以内）", "example": "ＸＸ区ＹＹ１−１−１" }, "street_name2": { "type": "string", "maxLength": 255, "description": "建物名・部屋番号など（255文字以内）", "example": "ビル１Ｆ" } } }, "partner_doc_setting_attributes": { "type": "object", "properties": { "sending_method": { "type": "string", "description": "請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送、null:設定しない)", "example": "posting", "enum": [ "email", "posting", "email_and_posting" ], "nullable": true } } }, "partner_bank_account_attributes": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "銀行名", "example": "freee銀行" }, "bank_name_kana": { "type": "string", "description": "銀行名（カナ）", "example": "フリーギンコウ" }, "bank_code": { "type": "string", "description": "銀行コード", "example": "0001" }, "branch_name": { "type": "string", "description": "支店名", "example": "銀座支店" }, "branch_kana": { "type": "string", "description": "支店名（カナ）", "example": "ギンザシテン" }, "branch_code": { "type": "string", "description": "支店番号", "example": "101" }, "account_type": { "type": "string", "description": "口座種別(ordinary:普通、checking：当座、earmarked：納税準備預金、savings：貯蓄、other:その他)、指定しない場合ordinaryになります。", "example": "ordinary" }, "account_number": { "type": "string", "description": "口座番号", "example": "1010101" }, "long_account_name": { "type": "string", "description": "受取人名", "example": "freee太郎" }, "account_name": { "type": "string", "description": "受取人名（カナ）", "example": "フリータロウ" } } }, "payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 15 }, "additional_months": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 6, "description": "支払月（当月を指定する場合は、0を指定してください。）", "example": 1 }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 32 } } }, "invoice_payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 15 }, "additional_months": { "type": "integer", "minimum": 0, "maximum": 6, "description": "入金月（当月を指定する場合は、0を指定してください。）", "example": 1 }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "入金日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 32 } } } } }, "partnerUpdateParams": { "required": [ "company_id", "name" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "取引先名 (255文字以内、重複不可)", "example": "新しい取引先" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット１ (255文字以内)", "example": "NEWPARTNER" }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット２ (255文字以内)", "example": "502" }, "org_code": { "type": "integer", "format": "int64", "description": "事業所種別（null: 未設定、1: 法人、2: 個人）", "example": 1, "enum": [ 1, 2 ], "nullable": true }, "country_code": { "type": "string", "description": "地域（JP: 国内、ZZ:国外）、指定しない場合JPになります。", "example": "JP", "enum": [ "JP", "ZZ" ] }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "新しい取引先正式名称" }, "name_kana": { "type": "string", "maxLength": 255, "description": "カナ名称（255文字以内）", "example": "アタラシイトリヒキサキメイショウ" }, "default_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中" }, "phone": { "type": "string", "description": "電話番号", "example": "03-1234-xxxx" }, "contact_name": { "type": "string", "maxLength": 255, "description": "担当者 氏名 (255文字以内)", "example": "営業担当" }, "email": { "type": "string", "maxLength": 255, "description": "担当者 メールアドレス (255文字以内)", "example": "contact@example.com" }, "payer_walletable_id": { "type": "integer", "format": "int64", "description": "振込元口座ID（一括振込ファイル用）:（walletableのtypeが'bank_account'のidのみ指定できます。また、未設定にする場合は、nullを指定してください。）", "example": 1, "nullable": true }, "transfer_fee_handling_side": { "type": "string", "description": "振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee)、指定しない場合payerになります。", "example": "payer", "enum": [ "payer", "payee" ] }, "qualified_invoice_issuer": { "type": "boolean", "description": "インボイス制度適格請求書発行事業者（true: 対象事業者、false: 非対象事業者）\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": false }, "invoice_registration_number": { "type": "string", "maxLength": 14, "minLength": 13, "pattern": "^T?[1-9][0-9]{12}$", "description": "インボイス制度適格請求書発行事業者登録番号\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001", "nullable": true }, "address_attributes": { "type": "object", "properties": { "zipcode": { "type": "string", "maxLength": 8, "description": "郵便番号（8文字以内）", "example": "000-0000" }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4 }, "street_name1": { "type": "string", "maxLength": 255, "description": "市区町村・番地（255文字以内）", "example": "ＸＸ区ＹＹ１−１−１" }, "street_name2": { "type": "string", "maxLength": 255, "description": "建物名・部屋番号など（255文字以内）", "example": "ビル１Ｆ" } } }, "partner_doc_setting_attributes": { "type": "object", "properties": { "sending_method": { "type": "string", "description": "請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送、null:設定しない)", "example": "posting", "enum": [ "email", "posting", "email_and_posting" ], "nullable": true } } }, "partner_bank_account_attributes": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "銀行名", "example": "freee銀行" }, "bank_name_kana": { "type": "string", "description": "銀行名（カナ）", "example": "フリーギンコウ" }, "bank_code": { "type": "string", "description": "銀行コード", "example": "0001" }, "branch_name": { "type": "string", "description": "支店名", "example": "銀座支店" }, "branch_kana": { "type": "string", "description": "支店名（カナ）", "example": "ギンザシテン" }, "branch_code": { "type": "string", "description": "支店番号", "example": "101" }, "account_type": { "type": "string", "description": "口座種別(ordinary:普通、checking：当座、earmarked：納税準備預金、savings：貯蓄、other:その他)、指定しない場合ordinaryになります。", "example": "ordinary" }, "account_number": { "type": "string", "description": "口座番号", "example": "1010101" }, "long_account_name": { "type": "string", "description": "受取人名", "example": "freee太郎" }, "account_name": { "type": "string", "description": "受取人名（カナ）", "example": "フリータロウ" } } }, "payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 15 }, "additional_months": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 6, "description": "支払月（当月を指定する場合は、0を指定してください。）", "example": 1 }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "支払日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 32 } }, "nullable": true }, "invoice_payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 15 }, "additional_months": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 6, "description": "入金月（当月を指定する場合は、0を指定してください。）", "example": 1 }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "入金日（29, 30, 31日の末日を指定する場合は、32を指定してください。）", "example": 32 } }, "nullable": true } } }, "receiptCreateParams": { "type": "object", "required": [ "company_id", "receipt" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID" }, "description": { "type": "string", "maxLength": 255, "description": "メモ (255文字以内)" }, "receipt": { "type": "string", "description": "証憑ファイル", "format": "binary" }, "receipt_metadatum_partner_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "発行元", "example": "freeeパートナー" }, "receipt_metadatum_issue_date": { "type": "string", "nullable": true, "description": "発行日 (yyyy-mm-dd)", "example": "2019-12-17" }, "receipt_metadatum_amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "nullable": true, "description": "金額", "example": 5250 }, "qualified_invoice": { "type": "string", "description": "適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択）", "enum": [ "qualified", "not_qualified", "unselected" ], "example": "qualified" }, "document_type": { "type": "string", "description": "書類の種類（receipt: 領収書、invoice: 請求書、other: その他）", "enum": [ "receipt", "invoice", "other" ], "example": "receipt" } } }, "receiptUpdateParams": { "type": "object", "required": [ "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "description": { "type": "string", "maxLength": 255, "description": "メモ (255文字以内)", "example": "メモ" }, "receipt_metadatum": { "type": "object", "properties": { "partner_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "発行元", "example": "freeeパートナー" }, "issue_date": { "type": "string", "nullable": true, "description": "発行日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "nullable": true, "description": "金額", "example": 5250 } } }, "qualified_invoice": { "type": "string", "description": "適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択）", "enum": [ "qualified", "not_qualified", "unselected" ], "example": "qualified" }, "invoice_registration_number": { "type": "string", "maxLength": 14, "minLength": 13, "pattern": "^T?[1-9][0-9]{12}$", "description": "インボイス制度適格請求書発行事業者登録番号\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001" }, "document_type": { "type": "string", "description": "書類の種類（receipt: 領収書、invoice: 請求書、other: その他）", "enum": [ "receipt", "invoice", "other" ], "example": "receipt" } } }, "accountItemCreateParams": { "type": "object", "required": [ "account_item", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "account_item": { "type": "object", "required": [ "account_category_id", "corresponding_expense_id", "corresponding_income_id", "group_name", "name", "tax_code" ], "properties": { "name": { "type": "string", "maxLength": 30, "description": "勘定科目名 (30文字以内)", "example": "新しい勘定科目" }, "shortcut": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "NEWACCOUNTITEM" }, "shortcut_num": { "type": "string", "maxLength": 20, "description": "ショートカット2 (20文字以内)", "example": "999" }, "code": { "type": "string", "maxLength": 20, "description": "勘定科目コード (勘定科目コードを使用する設定の場合は、codeの指定が必須です)", "example": "999", "pattern": "^[0-9a-zA-Z_-]+$" }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード 指定できるコードは本APIの注意点をご確認ください。", "example": 1 }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー） Selectablesフォーム用選択項目情報エンドポイント(account_groups.name)で取得可能です", "example": "その他預金" }, "account_category_id": { "type": "integer", "format": "int64", "description": "勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です", "example": 1 }, "corresponding_income_id": { "type": "integer", "format": "int64", "description": "収入取引相手勘定科目ID", "example": 1 }, "corresponding_expense_id": { "type": "integer", "format": "int64", "description": "支出取引相手勘定科目ID", "example": 1 }, "accumulated_dep_account_item_id": { "type": "integer", "format": "int64", "description": "減価償却累計額勘定科目ID（法人のみ利用可能）", "example": 1 }, "searchable": { "type": "integer", "format": "int64", "minimum": 2, "maximum": 3, "description": "検索可能:2, 検索不可：3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。)", "example": 2 }, "items": { "type": "array", "description": "品目", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 } } } }, "partners": { "type": "array", "description": "取引先", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 } } } } } } } }, "accountItemsResponse": { "type": "object", "required": [ "account_items" ], "properties": { "account_items": { "type": "array", "items": { "required": [ "account_category", "account_category_id", "available", "categories", "default_tax_code", "id", "name", "tax_code", "walletable_id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "name": { "type": "string", "description": "勘定科目名 (30文字以内)", "example": "ソフトウェア" }, "tax_code": { "type": "integer", "format": "int64", "description": "税区分コード", "example": 1 }, "shortcut": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "SOFUTO", "nullable": true }, "shortcut_num": { "type": "string", "maxLength": 20, "description": "ショートカット2 (20文字以内)", "example": "123", "nullable": true }, "code": { "type": "string", "maxLength": 20, "description": "勘定科目コード", "example": "123", "nullable": true }, "default_tax_code": { "type": "integer", "format": "int64", "description": "デフォルト設定がされている税区分コード", "example": 34 }, "account_category": { "type": "string", "description": "勘定科目カテゴリー", "example": "現金・預金" }, "account_category_id": { "type": "integer", "format": "int64", "description": "勘定科目のカテゴリーID", "example": 1 }, "categories": { "type": "array", "items": { "type": "string", "description": "勘定科目カテゴリー", "example": "資産" } }, "available": { "type": "boolean", "description": "勘定科目の使用設定（true: 使用する、false: 使用しない）", "example": true }, "walletable_id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1, "nullable": true }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー）", "example": "売掛金", "nullable": true }, "group_id": { "type": "integer", "format": "int64", "description": "決算書表示名ID（小カテゴリー）", "example": 1, "nullable": true }, "corresponding_income_name": { "type": "string", "description": "収入取引相手勘定科目名", "example": "売掛金", "nullable": true }, "corresponding_income_id": { "type": "integer", "format": "int64", "description": "収入取引相手勘定科目ID", "example": 1, "nullable": true }, "corresponding_expense_name": { "type": "string", "description": "支出取引相手勘定科目名", "example": "買掛金", "nullable": true }, "corresponding_expense_id": { "type": "integer", "format": "int64", "description": "支出取引相手勘定科目ID", "example": 1, "nullable": true } } } } } }, "accountItemResponse": { "type": "object", "required": [ "account_item" ], "properties": { "account_item": { "type": "object", "required": [ "account_category", "account_category_id", "available", "company_id", "id", "name", "searchable", "tax_code", "walletable_id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "勘定科目名 (30文字以内)", "example": "ソフトウェア" }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "account_category": { "type": "string", "description": "勘定科目カテゴリー", "example": "現金・預金" }, "account_category_id": { "type": "integer", "format": "int64", "description": "勘定科目のカテゴリーID", "example": 1 }, "shortcut": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "SOFUTO" }, "shortcut_num": { "type": "string", "maxLength": 20, "description": "ショートカット2 (20文字以内)", "example": "123" }, "code": { "type": "string", "maxLength": 20, "description": "勘定科目コード", "example": "123", "nullable": true }, "searchable": { "type": "integer", "format": "int64", "minimum": 2, "maximum": 3, "description": "検索可能:2, 検索不可：3", "example": 2 }, "accumulated_dep_account_item_name": { "type": "string", "description": "減価償却累計額勘定科目（法人のみ利用可能）", "example": "減価償却累計額" }, "accumulated_dep_account_item_id": { "type": "integer", "format": "int64", "description": "減価償却累計額勘定科目ID（法人のみ利用可能）", "example": 1, "nullable": true }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "住民税" } } } }, "partners": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "name": { "type": "string", "description": "取引先", "example": "test" } } } }, "available": { "type": "boolean", "description": "勘定科目の使用設定（true: 使用する、false: 使用しない）", "example": true }, "walletable_id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1, "nullable": true }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー）", "example": "売掛金", "nullable": true }, "group_id": { "type": "integer", "format": "int64", "description": "決算書表示名ID（小カテゴリー）", "example": 1, "nullable": true }, "corresponding_income_name": { "type": "string", "description": "収入取引相手勘定科目名", "example": "売掛金", "nullable": true }, "corresponding_income_id": { "type": "integer", "format": "int64", "description": "収入取引相手勘定科目ID", "example": 1, "nullable": true }, "corresponding_expense_name": { "type": "string", "description": "支出取引相手勘定科目名", "example": "買掛金", "nullable": true }, "corresponding_expense_id": { "type": "integer", "format": "int64", "description": "支出取引相手勘定科目ID", "example": 1, "nullable": true } } } } }, "accountItemUpdateParams": { "type": "object", "required": [ "account_item", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "account_item": { "type": "object", "required": [ "account_category_id", "corresponding_expense_id", "corresponding_income_id", "group_name", "tax_code" ], "properties": { "name": { "type": "string", "maxLength": 30, "description": "勘定科目名 (30文字以内)\n口座に紐付かない勘定科目の更新時は必須です。\n口座に紐付く勘定科目の更新時は指定することができません。\n", "example": "新しい勘定科目" }, "shortcut": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "NEWACCOUNTITEM" }, "shortcut_num": { "type": "string", "maxLength": 20, "description": "ショートカット2 (20文字以内)", "example": "999" }, "code": { "type": "string", "maxLength": 20, "description": "勘定科目コード (勘定科目コードを使用する設定の場合は、codeの指定が必須です)", "example": "999", "pattern": "^[0-9a-zA-Z_-]+$" }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード 指定できるコードは本APIの注意点をご確認ください。", "example": 1 }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー） Selectablesフォーム用選択項目情報エンドポイント(account_groups.name)で取得可能です", "example": "その他預金" }, "account_category_id": { "type": "integer", "format": "int64", "description": "勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です", "example": 1 }, "corresponding_income_id": { "type": "integer", "format": "int64", "description": "収入取引相手勘定科目ID", "example": 1 }, "corresponding_expense_id": { "type": "integer", "format": "int64", "description": "支出取引相手勘定科目ID", "example": 1 }, "accumulated_dep_account_item_id": { "type": "integer", "format": "int64", "description": "減価償却累計額勘定科目ID（法人のみ利用可能）", "example": 1 }, "searchable": { "type": "integer", "format": "int64", "minimum": 2, "maximum": 3, "description": "検索可能:2, 検索不可：3(登録時未指定の場合は2で登録されます。更新時未指定の場合はsearchableは変更されません。)", "example": 2 }, "items": { "type": "array", "description": "品目", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 } } } }, "partners": { "type": "array", "description": "取引先", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "example": 1 } } } } } } } }, "bank": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "連携サービスID", "example": 1 }, "name": { "type": "string", "description": "連携サービス名", "example": "フリー銀行" }, "type": { "type": "string", "description": "連携サービス種別: (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "name_kana": { "type": "string", "description": "連携サービス名(カナ)", "example": "フリーギンコウ", "nullable": true } } }, "bankResponse": { "type": "object", "required": [ "bank" ], "properties": { "bank": { "$ref": "#/components/schemas/bank" } } }, "journalsResponse": { "required": [ "journals" ], "type": "object", "properties": { "journals": { "required": [ "company_id", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "受け付けID", "example": 1 }, "messages": { "type": "array", "items": { "type": "string", "description": "受け付けメッセージ", "example": "id でリクエストを受け付けました。" } }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "download_type": { "type": "string", "description": "ダウンロード形式", "example": "csv", "enum": [ "generic", "generic_v2", "csv", "pdf" ] }, "encoding": { "type": "string", "description": "文字コード", "example": "sjis", "nullable": true, "enum": [ "sjis", "utf-8" ] }, "start_date": { "type": "string", "description": "取得開始日 (yyyy-mm-dd)", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "取得終了日 (yyyy-mm-dd)", "example": "2019-12-17" }, "visible_tags": { "type": "array", "items": { "type": "string", "description": "補助科目やコメントとして出力する項目", "example": "all", "enum": [ "partner", "item", "tag", "section", "description", "wallet_txn_description", "all", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, "visible_ids": { "type": "array", "items": { "type": "string", "description": "追加出力するID項目", "example": "deal_id", "enum": [ "deal_id", "transfer_id", "manual_journal_id" ] } }, "status_url": { "type": "string", "description": "仕訳帳のステータスの取得用URL", "example": "https://api.freee.co.jp/api/1/journals/reports/4/status" }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } } } }, "journalStatusResponse": { "type": "object", "required": [ "journals" ], "properties": { "journals": { "type": "object", "required": [ "company_id", "download_type", "end_date", "id", "start_date", "status" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "受け付けID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "download_type": { "type": "string", "description": "ダウンロード形式", "example": "csv", "enum": [ "generic", "generic_v2", "csv", "pdf" ] }, "encoding": { "type": "string", "description": "文字コード", "example": "sjis", "nullable": true, "enum": [ "sjis", "utf-8" ] }, "status": { "type": "string", "description": "ダウンロードリクエストのステータス", "example": "csv", "enum": [ "enqueued", "working", "uploaded", "failed" ] }, "start_date": { "type": "string", "description": "取得開始日 (yyyy-mm-dd)", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "取得終了日 (yyyy-mm-dd)", "example": "2019-12-17" }, "visible_tags": { "type": "array", "items": { "type": "string", "description": "補助科目やコメントとして出力する項目", "example": "all", "enum": [ "partner", "item", "tag", "section", "description", "wallet_txn_description", "all", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] } }, "visible_ids": { "type": "array", "items": { "type": "string", "description": "追加出力するID項目", "example": "deal_id", "enum": [ "deal_id", "transfer_id", "manual_journal_id" ] } }, "download_url": { "type": "string", "description": "ダウンロードURL", "example": "https://api.freee.co.jp/api/1/journals/reports/1/download" } } } } }, "trialBsResponse": { "type": "object", "required": [ "trial_bs", "up_to_date" ], "properties": { "trial_bs": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialBsTwoYearsResponse": { "type": "object", "required": [ "trial_bs_two_years", "up_to_date" ], "properties": { "trial_bs_two_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialBsThreeYearsResponse": { "required": [ "trial_bs_three_years", "up_to_date" ], "type": "object", "properties": { "trial_bs_three_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlResponse": { "type": "object", "required": [ "trial_pl", "up_to_date" ], "properties": { "trial_pl": { "required": [ "balances", "company_id" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlTwoYearsResponse": { "type": "object", "required": [ "trial_pl_two_years", "up_to_date" ], "properties": { "trial_pl_two_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlThreeYearsResponse": { "type": "object", "required": [ "trial_pl_three_years", "up_to_date" ], "properties": { "trial_pl_three_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlSectionsResponse": { "type": "object", "required": [ "trial_pl_sections", "up_to_date" ], "properties": { "trial_pl_sections": { "type": "object", "required": [ "balances", "company_id", "section_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "section_ids": { "type": "string", "description": "出力する部門の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "sections": { "type": "array", "description": "部門", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlSegment_1TagsResponse": { "type": "object", "required": [ "trial_pl_segment_1_tags", "up_to_date" ], "properties": { "trial_pl_segment_1_tags": { "type": "object", "required": [ "balances", "company_id", "segment_1_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_1_tag_ids": { "type": "string", "description": "出力するセグメント1の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_1_tags": { "type": "array", "description": "セグメント1タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlSegment_2TagsResponse": { "type": "object", "required": [ "trial_pl_segment_2_tags", "up_to_date" ], "properties": { "trial_pl_segment_2_tags": { "type": "object", "required": [ "balances", "company_id", "segment_2_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_2_tag_ids": { "type": "string", "description": "出力するセグメント2の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_2_tags": { "type": "array", "description": "セグメント2タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialPlSegment_3TagsResponse": { "type": "object", "required": [ "trial_pl_segment_3_tags", "up_to_date" ], "properties": { "trial_pl_segment_3_tags": { "type": "object", "required": [ "balances", "company_id", "segment_3_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_3_tag_ids": { "type": "string", "description": "出力するセグメント3の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_3_tags": { "type": "array", "description": "セグメント3タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrResponse": { "type": "object", "required": [ "trial_cr", "up_to_date" ], "properties": { "trial_cr": { "required": [ "balances", "company_id" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高", "example": 0 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方金額", "example": 0 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方金額", "example": 2592 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "composition_ratio": { "type": "number", "description": "構成比", "example": 0.85 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrTwoYearsResponse": { "type": "object", "required": [ "trial_cr_two_years", "up_to_date" ], "properties": { "trial_cr_two_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrThreeYearsResponse": { "type": "object", "required": [ "trial_cr_three_years", "up_to_date" ], "properties": { "trial_cr_three_years": { "type": "object", "required": [ "balances", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "two_years_before_closing_balance": { "type": "integer", "format": "int64", "description": "前々年度期末残高", "example": 0 }, "last_year_closing_balance": { "type": "integer", "format": "int64", "description": "前年度期末残高", "example": 0 }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "year_on_year": { "type": "number", "description": "前年比", "example": 0.12 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrSectionsResponse": { "type": "object", "required": [ "trial_cr_sections", "up_to_date" ], "properties": { "trial_cr_sections": { "type": "object", "required": [ "balances", "company_id", "section_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "section_ids": { "type": "string", "description": "出力する部門の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 勘定科目: account_item, セグメント1(法人向けプロフェッショナル, 法人向けエンタープライズプラン): segment_1_tag, セグメント2(法人向け エンタープライズプラン):segment_2_tag, セグメント3(法人向け エンタープライズプラン): segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "sections": { "type": "array", "description": "部門", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_1_tags": { "type": "array", "description": "breakdown_display_type:segment_1_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_2_tags": { "type": "array", "description": "breakdown_display_type:segment_2_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "segment_3_tags": { "type": "array", "description": "breakdown_display_type:segment_3_tag, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrSegment_1TagsResponse": { "type": "object", "required": [ "trial_cr_segment_1_tags", "up_to_date" ], "properties": { "trial_cr_segment_1_tags": { "type": "object", "required": [ "balances", "company_id", "segment_1_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_1_tag_ids": { "type": "string", "description": "出力するセグメント1の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_1_tags": { "type": "array", "description": "セグメント1タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント1タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント1タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrSegment_2TagsResponse": { "type": "object", "required": [ "trial_cr_segment_2_tags", "up_to_date" ], "properties": { "trial_cr_segment_2_tags": { "type": "object", "required": [ "balances", "company_id", "segment_2_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_2_tag_ids": { "type": "string", "description": "出力するセグメント2の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_2_tags": { "type": "array", "description": "セグメント2タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント2タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント2タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "trialCrSegment_3TagsResponse": { "type": "object", "required": [ "trial_cr_segment_3_tags", "up_to_date" ], "properties": { "trial_cr_segment_3_tags": { "type": "object", "required": [ "balances", "company_id", "segment_3_tag_ids" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "segment_3_tag_ids": { "type": "string", "description": "出力するセグメント3の指定", "example": "123" }, "fiscal_year": { "type": "integer", "format": "int64", "description": "会計年度(条件に指定した時、または条件に月、日条件がない時のみ含まれる）", "example": 2019 }, "start_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：開始会計月(1-12)(条件に指定した時のみ含まれる）", "example": 1 }, "end_month": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 12, "description": "発生月で絞込：終了会計月(1-12)(条件に指定した時のみ含まれる）", "example": 12 }, "start_date": { "type": "string", "description": "発生日で絞込：開始日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "発生日で絞込：終了日(yyyy-mm-dd)(条件に指定した時のみ含まれる）", "example": "2019-12-17" }, "account_item_display_type": { "type": "string", "description": "勘定科目の表示（勘定科目: account_item, 決算書表示:group）(条件に指定した時のみ含まれる）", "enum": [ "account_item", "group" ] }, "breakdown_display_type": { "type": "string", "description": "内訳の表示（取引先: partner, 品目: item, 部門: section, 勘定科目: account_item）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID(条件に指定した時のみ含まれる）", "example": 1 }, "adjustment": { "type": "string", "description": "決算整理仕訳のみ: only, 決算整理仕訳以外: without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "cost_allocation": { "type": "string", "description": "配賦仕訳のみ：only,配賦仕訳以外：without(条件に指定した時のみ含まれる）", "example": "only", "enum": [ "only", "without" ] }, "approval_flow_status": { "type": "string", "description": "未承認を除く: without_in_progress (デフォルト), 全てのステータス: all(条件に指定した時のみ含まれる）", "example": "without_in_progress", "enum": [ "without_in_progress", "all" ] }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "balances": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID(勘定科目の時のみ含まれる)", "example": 192 }, "account_item_name": { "type": "string", "description": "勘定科目名(勘定科目の時のみ含まれる)", "example": "現金" }, "account_group_name": { "type": "string", "description": "決算書表示名(account_item_display_type:group指定時に決算書表示名の時のみ含まれる)", "example": "現金及び預金" }, "segment_3_tags": { "type": "array", "description": "セグメント3タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメント3タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント3タグ名", "example": "プロジェクトA" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 }, "partners": { "type": "array", "description": "breakdown_display_type:partner, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 22 }, "name": { "type": "string", "description": "取引先名", "example": "freee" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "items": { "type": "array", "description": "breakdown_display_type:item, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "源泉所得税" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } }, "sections": { "type": "array", "description": "breakdown_display_type:section, account_item_display_type:account_item指定時のみ含まれる", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "description": "部門名", "example": "開発部門" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } } }, "account_category_name": { "type": "string", "description": "勘定科目カテゴリー名", "example": "販売管理費" }, "total_line": { "type": "boolean", "description": "合計行(勘定科目カテゴリーの時のみ含まれる)", "example": true }, "hierarchy_level": { "type": "integer", "format": "int64", "description": "階層レベル", "example": 3 }, "parent_account_category_name": { "type": "string", "description": "上位勘定科目カテゴリー名(勘定科目カテゴリーの時のみ、上層が存在する場合含まれる)", "example": "他流動資産" }, "closing_balance": { "type": "integer", "format": "int64", "description": "期末残高", "example": -25920 } } } } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。しばらく時間をおいてからもう一度お試しください。" } } } } } }, "sectionParams": { "type": "object", "required": [ "company_id", "name" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "部門名 (30文字以内)", "example": "開発部門" }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称 (255文字以内)", "example": "xxxx開発部門" }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "DEVELOPER" }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "123" }, "parent_id": { "type": "integer", "format": "int64", "description": "親部門ID (個人:プレミアムプラン、法人:ベーシックプラン以上)", "example": 101 } } }, "section": { "type": "object", "required": [ "company_id", "id", "name", "available" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "部門名 (30文字以内)", "example": "開発部門" }, "available": { "type": "boolean", "description": "部門の使用設定（true: 使用する、false: 使用しない）\n
\n", "example": true }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "開発部門", "nullable": true }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "DEVELOPER", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "123", "nullable": true }, "indent_count": { "type": "integer", "format": "int64", "minimum": 0, "description": "部門階層\n
\n※ indent_count が 0 のときは第一階層の親部門です。\n", "example": 0 }, "parent_id": { "type": "integer", "format": "int64", "description": "親部門ID\n
\n※ parent_id が null のときは第一階層の親部門です。\n", "example": 1, "nullable": true } } }, "sectionResponse": { "type": "object", "required": [ "section" ], "properties": { "section": { "$ref": "#/components/schemas/section" } } }, "dealCreateResponse": { "type": "object", "required": [ "deal" ], "properties": { "deal": { "type": "object", "required": [ "amount", "company_id", "id", "issue_date", "partner_id", "status" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "due_date": { "type": "string", "description": "支払期日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "金額", "example": 5250 }, "due_amount": { "type": "integer", "format": "int64", "description": "支払残額", "example": 0 }, "type": { "type": "string", "description": "収支区分 (収入: income, 支出: expense)", "example": "expense", "enum": [ "income", "expense" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "ref_number": { "type": "string", "description": "管理番号", "example": "123-456" }, "status": { "type": "string", "description": "決済状況 (未決済: unsettled, 完了: settled)", "example": "settled", "enum": [ "unsettled", "settled" ] }, "deal_origin_name": { "type": "string", "description": "取引の登録元", "example": "手動" }, "details": { "type": "array", "description": "取引の明細行", "items": { "type": "object", "required": [ "account_item_id", "amount", "entry_side", "id", "tax_code", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引行ID", "example": 11 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 803 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 2 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 501, "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額", "example": 5250 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 250 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "entry_side": { "type": "string", "description": "貸借（貸方: credit, 借方: debit）", "example": "debit", "enum": [ "credit", "debit" ] } } } }, "payments": { "type": "array", "description": "取引の支払行", "items": { "type": "object", "required": [ "amount", "date", "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引行ID", "example": 202 }, "date": { "type": "string", "description": "支払日", "example": "2019-12-17" }, "from_walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet", "private_account_item" ] }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID）", "example": 103 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "支払金額", "example": 5250 } } } }, "receipts": { "type": "array", "description": "ファイルボックス（証憑ファイル）", "items": { "type": "object", "required": [ "created_at", "id", "mime_type", "origin", "status", "user" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 1 }, "status": { "type": "string", "description": "ステータス(confirmed:確認済み、deleted:削除済み、ignored:無視)", "example": "confirmed", "enum": [ "confirmed", "deleted", "ignored" ] }, "description": { "type": "string", "description": "メモ", "example": "タクシー利用" }, "mime_type": { "type": "string", "description": "MIMEタイプ", "example": "image/png" }, "issue_date": { "type": "string", "description": "発生日", "example": "2019-12-17" }, "origin": { "type": "string", "description": "アップロード元種別", "example": "public_api", "enum": [ "unknown", "web", "mobile_camera", "mobile_album", "scansnap", "scannable", "dropbox", "mail", "safety_contact_file", "public_api" ] }, "created_at": { "type": "string", "description": "作成日時（ISO8601形式）", "example": "2019-12-17T18:30:24+09:00" }, "user": { "required": [ "email", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "email": { "type": "string", "description": "メールアドレス", "example": "contact@example.com" }, "display_name": { "type": "string", "description": "表示名", "example": "フリー太郎", "nullable": true } } }, "receipt_metadatum": { "type": "object", "properties": { "partner_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "発行元", "example": "freeeパートナー" }, "issue_date": { "type": "string", "nullable": true, "description": "発行日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "nullable": true, "description": "金額", "example": 5250 } } } } } } } } } }, "deal": { "type": "object", "required": [ "amount", "company_id", "id", "issue_date", "partner_id", "status" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "due_date": { "type": "string", "description": "支払期日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "金額", "example": 5250 }, "due_amount": { "type": "integer", "format": "int64", "description": "支払残額", "example": 0 }, "type": { "type": "string", "description": "収支区分 (収入: income, 支出: expense)", "example": "expense", "enum": [ "income", "expense" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "ref_number": { "type": "string", "description": "管理番号", "example": "123-456" }, "status": { "type": "string", "description": "決済状況 (未決済: unsettled, 完了: settled)", "example": "settled", "enum": [ "unsettled", "settled" ] }, "deal_origin_name": { "type": "string", "description": "取引の登録元", "example": "手動" }, "details": { "type": "array", "description": "取引の明細行", "items": { "type": "object", "required": [ "account_item_id", "amount", "entry_side", "id", "tax_code", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引行ID", "example": 11 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 803 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 2 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 501, "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額", "example": 5250 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 250 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "entry_side": { "type": "string", "description": "貸借（貸方: credit, 借方: debit）", "example": "debit", "enum": [ "credit", "debit" ] } } } }, "renews": { "type": "array", "description": "取引の+更新行", "items": { "type": "object", "required": [ "details", "id", "renew_target_id", "renew_target_type", "update_date" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "+更新行ID", "example": 11 }, "update_date": { "type": "string", "description": "更新日 (yyyy-mm-dd)", "example": "2019-12-17" }, "renew_target_id": { "type": "integer", "format": "int64", "description": "+更新の対象行ID", "example": 12 }, "renew_target_type": { "type": "string", "description": "+更新の対象行タイプ", "example": "detail", "enum": [ "detail", "accrual", "renew" ] }, "details": { "type": "array", "description": "+更新の明細行一覧（配列）", "items": { "required": [ "account_item_id", "amount", "entry_side", "id", "tag_ids", "tax_code", "vat" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "+更新の明細行ID", "example": 1 }, "entry_side": { "type": "string", "description": "貸借(貸方: credit, 借方: debit)", "example": "debit", "enum": [ "credit", "debit" ] }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "金額（税込で指定してください）", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true } } } } } } }, "payments": { "type": "array", "description": "取引の支払行", "items": { "type": "object", "required": [ "amount", "date", "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引行ID", "example": 202 }, "date": { "type": "string", "description": "支払日", "example": "2019-12-17" }, "from_walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）: private_account_item)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet", "private_account_item" ] }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID）", "example": 103 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "支払金額", "example": 5250 } } } }, "receipts": { "type": "array", "description": "ファイルボックス（証憑ファイル）", "items": { "type": "object", "required": [ "created_at", "file_src", "id", "mime_type", "origin", "status", "user" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 1 }, "status": { "type": "string", "description": "ステータス(confirmed:確認済み、deleted:削除済み、ignored:無視)", "example": "confirmed", "enum": [ "confirmed", "deleted", "ignored" ] }, "description": { "type": "string", "description": "メモ", "example": "タクシー利用" }, "mime_type": { "type": "string", "description": "MIMEタイプ", "example": "image/png" }, "issue_date": { "type": "string", "description": "発生日", "example": "2019-12-17" }, "origin": { "type": "string", "description": "アップロード元種別", "example": "public_api", "enum": [ "unknown", "web", "mobile_camera", "mobile_album", "scansnap", "scannable", "dropbox", "mail", "safety_contact_file", "public_api" ] }, "created_at": { "type": "string", "description": "作成日時（ISO8601形式）", "example": "2019-12-17T18:30:24+09:00" }, "file_src": { "type": "string", "description": "ファイルのダウンロードURL（freeeにログインした状態でのみ閲覧可能です。）\n
\n
\nfile_srcは廃止予定の属性になります。
\nfile_srcに替わり、ファイルボックス（証憑ファイル）のダウンロード APIをご利用ください。
\nファイルボックス（証憑ファイル）のダウンロードAPIを利用することで、以下のようになります。\n", "example": "https://www.freee.co.jp/api/p/receipts/revisions/1234xxxxx/download", "deprecated": true }, "user": { "required": [ "email", "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "email": { "type": "string", "description": "メールアドレス", "example": "contact@example.com" }, "display_name": { "type": "string", "description": "表示名", "example": "フリー太郎", "nullable": true } } }, "receipt_metadatum": { "type": "object", "properties": { "partner_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "発行元", "example": "freeeパートナー" }, "issue_date": { "type": "string", "nullable": true, "description": "発行日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "nullable": true, "description": "金額", "example": 5250 } } } } } } } }, "dealResponse": { "type": "object", "required": [ "deal" ], "properties": { "deal": { "$ref": "#/components/schemas/deal" } } }, "selectablesIndexResponse": { "type": "object", "properties": { "account_categories": { "type": "array", "items": { "required": [ "account_items", "balance", "org_code", "role", "title" ], "type": "object", "properties": { "balance": { "type": "string", "description": "収支", "example": "expense", "enum": [ "expense", "income" ] }, "org_code": { "type": "string", "description": "事業形態（個人事業主: personal、法人: corporate）", "example": "personal", "enum": [ "personal", "corporate" ] }, "role": { "type": "string", "description": "カテゴリーコード", "example": "ex_food" }, "title": { "type": "string", "description": "カテゴリー名", "example": "飲食費" }, "desc": { "type": "string", "description": "カテゴリーの説明", "example": "飲食に使用した経費" }, "account_items": { "type": "array", "description": "勘定科目の一覧", "items": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "name": { "type": "string", "description": "勘定科目", "example": "交際費" }, "desc": { "type": "string", "description": "勘定科目の説明", "example": "福利厚生以外の飲食費" }, "help": { "type": "string", "description": "勘定科目の説明（詳細）", "example": "" }, "shortcut": { "type": "string", "description": "ショートカット", "example": "KOUSAI" }, "default_tax": { "type": "object", "properties": { "tax_rate_5": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入" } } }, "tax_rate_8": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入8%" } } }, "tax_rate_10": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入10%" } } }, "tax_rate_r8": { "type": "object", "properties": { "code": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入8%（軽）" } } }, "tax_rate_5_exempt_80": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控80）" } } }, "tax_rate_5_exempt_50": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控50）" } } }, "tax_rate_8_exempt_80": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控80）8%" } } }, "tax_rate_8_exempt_50": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控50）8%" } } }, "tax_rate_10_exempt_80": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控80）10%" } } }, "tax_rate_10_exempt_50": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控50）10%" } } }, "tax_rate_r8_exempt_80": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控80）8%（軽）" } } }, "tax_rate_r8_exempt_50": { "type": "object", "properties": { "code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "name": { "type": "string", "description": "税区分", "example": "課対仕入（控50）8%（軽）" } } } } } } } } } } }, "account_groups": { "type": "array", "description": "決算書表示名（小カテゴリー）", "items": { "required": [ "account_category_id", "account_structure_id", "id", "index", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "決算書表示名（小カテゴリー）ID", "example": 1 }, "name": { "type": "string", "description": "決算書表示名", "example": "預託金" }, "account_structure_id": { "type": "integer", "format": "int64", "description": "年度ID", "example": 1 }, "account_category_id": { "type": "integer", "format": "int64", "description": "勘定科目カテゴリーID", "example": 1 }, "detail_type": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 4, "description": "詳細パラメータの種類", "example": 1 }, "index": { "type": "integer", "format": "int64", "description": "並び順", "example": 1 }, "created_at": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "updated_at": { "type": "string", "description": "更新日時", "example": "2019-12-17T13:47:24+09:00" } } } } } }, "item": { "required": [ "company_id", "id", "name", "update_date", "available" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "品目名 (30文字以内)", "example": "タクシー代" }, "update_date": { "type": "string", "description": "更新日(yyyy-mm-dd)", "example": "2019-12-17" }, "available": { "type": "boolean", "description": "品目の使用設定（true: 使用する、false: 使用しない）\n
\n" }, "shortcut1": { "type": "string", "description": "ショートカット１ (20文字以内)", "example": "TAXI", "nullable": true }, "shortcut2": { "type": "string", "description": "ショートカット２ (20文字以内)", "example": 201, "nullable": true }, "code": { "type": "string", "maxLength": 20, "description": "品目コード", "example": "code001", "pattern": "^[0-9a-zA-Z_-]+$", "nullable": true } } }, "itemResponse": { "required": [ "item" ], "type": "object", "properties": { "item": { "$ref": "#/components/schemas/item" } } }, "manual_journal": { "type": "object", "required": [ "adjustment", "company_id", "details", "id", "issue_date", "txn_number" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "振替伝票ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "adjustment": { "type": "boolean", "description": "決算整理仕訳フラグ（falseまたは未指定の場合: 日常仕訳）", "example": false }, "txn_number": { "type": "string", "description": "仕訳番号", "example": "2CX05", "nullable": true }, "details": { "type": "array", "description": "貸借行一覧（配列）: 貸借合わせて100行まで登録できます。", "items": { "type": "object", "required": [ "account_item_id", "amount", "description", "entry_side", "id", "item_id", "item_name", "partner_id", "partner_long_name", "partner_name", "section_id", "section_name", "tag_ids", "tag_names", "tax_code", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "貸借行ID", "example": 1 }, "entry_side": { "type": "string", "description": "貸借(貸方: credit, 借方: debit)", "example": "credit", "enum": [ "credit", "debit" ] }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1, "nullable": true }, "partner_name": { "type": "string", "description": "取引先名", "example": "freee", "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "partner_long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "freee株式会社", "nullable": true }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "item_name": { "type": "string", "description": "品目", "example": "freee会計", "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "section_name": { "type": "string", "description": "部門", "example": "開発部", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "tag_names": { "type": "array", "items": { "type": "string", "description": "メモタグ", "example": "メモタグ" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_1_tag_name": { "type": "string", "description": "セグメント１", "example": "セグメント１", "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_2_tag_name": { "type": "string", "description": "セグメント２", "example": "セグメント２", "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "segment_3_tag_name": { "type": "string", "description": "セグメント３", "example": "セグメント３", "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2147483647, "description": "金額（税込で指定してください）", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額（指定しない場合は自動で計算されます）", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考" } } } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } } } }, "manualJournalResponse": { "type": "object", "required": [ "manual_journal" ], "properties": { "manual_journal": { "$ref": "#/components/schemas/manual_journal" } } }, "tagParams": { "required": [ "company_id", "name" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "メモタグ名 (30文字以内)", "example": "メモタグ1" }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "tag1" }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット2 (20文字以内)", "example": "t1" } } }, "tag": { "type": "object", "required": [ "company_id", "id", "name", "update_date" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "タグID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "名前(30文字以内)", "example": "メモタグ" }, "update_date": { "type": "string", "description": "更新日(yyyy-mm-dd)", "example": "2019-12-17" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット1 (255文字以内)", "example": "MEMOTAG", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット2 (255文字以内)", "example": "123", "nullable": true } } }, "tagResponse": { "type": "object", "required": [ "tag" ], "properties": { "tag": { "$ref": "#/components/schemas/tag" } } }, "companyIndexResponse": { "type": "object", "required": [ "companies" ], "properties": { "companies": { "type": "array", "items": { "type": "object", "required": [ "company_number", "display_name", "id", "name", "name_kana", "role" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "description": "事業所名", "example": "freee事務所", "nullable": true }, "name_kana": { "type": "string", "description": "事業所名（カナ）", "example": "フリージムショ", "nullable": true }, "display_name": { "type": "string", "description": "事業所名", "example": "freee事務所", "nullable": true }, "company_number": { "type": "string", "description": "事業所番号（ハイフン無し）", "example": "1234567890" }, "role": { "type": "string", "description": "ユーザーの権限", "example": "admin", "enum": [ "admin", "simple_accounting", "self_only", "read_only", "workflow" ] } } } } } }, "companyResponse": { "type": "object", "required": [ "company" ], "properties": { "company": { "type": "object", "required": [ "amount_fraction", "company_number", "contact_name", "corporate_number", "display_name", "fax", "fiscal_years", "head_count", "id", "industry_class", "industry_code", "invoice_layout", "minus_format", "name", "name_kana", "org_code", "phone1", "phone2", "prefecture_code", "private_settlement", "role", "street_name1", "street_name2", "tax_at_source_calc_type", "txn_number_format", "use_partner_code", "workflow_setting", "zipcode" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 100, "description": "事業所の正式名称 (100文字以内)", "example": "freee事務所", "nullable": true }, "name_kana": { "type": "string", "maxLength": 100, "description": "正式名称フリガナ (100文字以内)", "example": "フリージムショ", "nullable": true }, "display_name": { "type": "string", "description": "事業所名", "example": "freee事務所" }, "tax_at_source_calc_type": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 1, "description": "源泉徴収税計算（0: 消費税を含める、1: 消費税を含めない）", "example": 0 }, "contact_name": { "type": "string", "maxLength": 50, "description": "担当者名 (50文字以内)", "example": "user1", "nullable": true }, "head_count": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 99, "description": "従業員数（0: 経営者のみ、1: 2〜5人、2: 6〜10人、3: 11〜20人、4: 21〜30人、5: 31〜40人、6: 41〜100人、7: 100人以上、13: 21〜50人、14: 51〜100人、15: 101〜300人、16: 501〜1000人、17: 1001人以上、18: 301〜500人", "example": 1, "nullable": true }, "corporate_number": { "type": "string", "description": "法人番号 (半角数字13桁、法人のみ)", "example": "1234567890123" }, "txn_number_format": { "type": "string", "description": "仕訳番号形式（not_used: 使用しない、digits: 数字（例：5091824）、alnum: 英数字（例：59J0P））", "example": "not_used", "enum": [ "not_used", "digits", "alnum" ] }, "default_wallet_account_id": { "type": "integer", "format": "int64", "description": "デフォルトの決済口座が紐づく勘定科目ID", "example": 1 }, "private_settlement": { "type": "boolean", "description": "プライベート資金/役員資金（false: 使用しない、true: 使用する）", "example": true }, "minus_format": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 1, "description": "マイナスの表示方法（0: -、 1: △）", "example": 0 }, "org_code": { "type": "integer", "minimum": 1, "maximum": 2, "description": "事業所種別コード（1: 法人、 2: 個人事業主）", "example": 1 }, "company_number": { "type": "string", "description": "事業所番号（ハイフン無し）", "example": "1234567890" }, "role": { "type": "string", "description": "ユーザーの権限", "example": "admin", "enum": [ "admin", "simple_accounting", "self_only", "read_only", "workflow" ] }, "phone1": { "type": "string", "description": "電話番号１", "example": "03-1234-xxxx", "nullable": true }, "phone2": { "type": "string", "description": "電話番号２", "example": "090-1234-xxxx", "nullable": true }, "fax": { "type": "string", "description": "FAX", "example": "03-1234-xxxx", "nullable": true }, "zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "street_name1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＹＹ１−１−１", "nullable": true }, "street_name2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル１Ｆ", "nullable": true }, "invoice_layout": { "type": "string", "description": "請求書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `carried_forward_standard_classic` - レイアウト３（繰越金額欄あり）/クラシック\n\n* `carried_forward_envelope_classic` - 封筒２（繰越金額欄あり）/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "carried_forward_standard_classic", "carried_forward_envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "amount_fraction": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2, "description": "金額端数処理方法（0: 切り捨て、1: 切り上げ、2: 四捨五入）", "example": 0 }, "use_partner_code": { "type": "boolean", "description": "取引先コードの利用設定（true: 有効、 false: 無効）", "example": true }, "industry_class": { "type": "string", "nullable": true, "description": "種別（agriculture_forestry_fisheries_ore: 農林水産業/鉱業,construction: 建設,manufacturing_processing: 製造/加工,it: IT,transportation_logistics: 運輸/物流,retail_wholesale: 小売/卸売,finance_insurance: 金融/保険,real_estate_rental: 不動産/レンタル,profession: 士業/学術/専門技術サービス,design_production: デザイン/制作,food: 飲食,leisure_entertainment: レジャー/娯楽,lifestyle: 生活関連サービス,education: 教育/学習支援,medical_welfare: 医療/福祉,other_services: その他サービス,other_association: NPO、一般社団法人等,other: その他, \"\": 未選択）", "example": "agriculture_forestry_fisheries_ore", "enum": [ "agriculture_forestry_fisheries_ore", "construction", "manufacturing_processing", "it", "transportation_logistics", "retail_wholesale", "finance_insurance", "real_estate_rental", "profession", "design_production", "food", "leisure_entertainment", "lifestyle", "education", "medical_welfare", "other_services", "other_association", "other", "" ] }, "industry_code": { "type": "string", "nullable": true, "description": "### 業種 法人
\n - '': 未選択\n - agriculture: 農業\n - forestry: 林業\n - fishing_industry: 漁業、水産養殖業\n - mining: 鉱業、採石業、砂利採取業\n - civil_contractors: 土木工事業\n - pavement: 舗装工事業\n - carpenter: とび、大工、左官等の建設工事業\n - renovation: リフォーム工事業\n - electrical_plumbing: 電気、管工事等の設備工事業\n - grocery: 食料品の製造加工業\n - machinery_manufacturing: 機械器具の製造加工業\n - printing: 印刷業\n - other_manufacturing: その他の製造加工業\n - software_development: 受託：ソフトウェア、アプリ開発業\n - system_development: 受託：システム開発業\n - survey_analysis: 受託：調査、分析等の情報処理業\n - server_management: 受託：サーバー運営管理\n - website_production: 受託：ウェブサイト制作\n - online_service_management: オンラインサービス運営業\n - online_advertising_agency: オンライン広告代理店業\n - online_advertising_planning_production: オンライン広告企画・制作業\n - online_media_management: オンラインメディア運営業\n - portal_site_management: ポータルサイト運営業\n - other_it_services: その他、IT サービス業\n - transport_delivery: 輸送業、配送業\n - delivery: バイク便等の配達業\n - other_transportation_logistics: その他の運輸業、物流業\n - other_wholesale: 卸売業：その他\n - clothing_wholesale_fiber: 卸売業：衣類卸売／繊維\n - food_wholesale: 卸売業：飲食料品\n - entrusted_development_wholesale: 卸売業：機械器具\n - online_shop: 小売業：無店舗　オンラインショップ\n - fashion_grocery_store: 小売業：店舗あり　ファッション、雑貨\n - food_store: 小売業：店舗あり　生鮮食品、飲食料品\n - entrusted_store: 小売業：店舗あり　機械、器具\n - other_store: 小売業：店舗あり　その他\n - financial_instruments_exchange: 金融業：金融商品取引\n - commodity_futures_investment_advisor: 金融業：商品先物取引、商品投資顧問\n - other_financial: 金融業：その他\n - brokerage_insurance: 保険業：仲介、代理\n - other_insurance: 保険業：その他\n - real_estate_developer: 不動産業：ディベロッパー\n - real_estate_brokerage: 不動産業：売買、仲介\n - rent_coin_parking_management: 不動産業：賃貸、コインパーキング、管理\n - rental_office_co_working_space: 不動産業：レンタルオフィス、コワーキングスペース\n - rental_lease: レンタル業、リース業\n - cpa_tax_accountant: 士業：公認会計士事務所、税理士事務所\n - law_office: 士業：法律事務所\n - judicial_and_administrative_scrivener: 士業：司法書士事務所／行政書士事務所\n - labor_consultant: 士業：社会保険労務士事務所\n - other_profession: 士業：その他\n - business_consultant: 経営コンサルタント\n - academic_research_development: 学術・開発研究機関\n - advertising_agency: 広告代理店\n - advertising_planning_production: 広告企画／制作\n - design_development: ソフトウェア、アプリ開発業（受託）\n - apparel_industry_design: 服飾デザイン業、工業デザイン業\n - website_design: ウェブサイト制作（受託）\n - advertising_planning_design: 広告企画／制作業\n - other_design: その他、デザイン／制作\n - restaurants_coffee_shops: レストラン、喫茶店等の飲食店業\n - sale_of_lunch: 弁当の販売業\n - bread_confectionery_manufacture_sale: パン、菓子等の製造販売業\n - delivery_catering_mobile_catering: デリバリー業、ケータリング業、移動販売業\n - hotel_inn: 宿泊業：ホテル、旅館\n - homestay: 宿泊業：民泊\n - travel_agency: 旅行代理店業\n - leisure_sports_facility_management: レジャー、スポーツ等の施設運営業\n - show_event_management: ショー、イベント等の興行、イベント運営業\n - barber: ビューティ、ヘルスケア業：床屋、理容室\n - beauty_salon: ビューティ、ヘルスケア業：美容室\n - spa_sand_bath_sauna: ビューティ、ヘルスケア業：スパ、砂風呂、サウナ等\n - este_ail_salon: ビューティ、ヘルスケア業：その他、エステサロン、ネイルサロン等\n - bridal_planning_introduce_wedding: 冠婚葬祭業：ブライダルプランニング、結婚式場紹介等\n - memorial_ceremony_funeral: 冠婚葬祭業：メモリアルセレモニー、葬儀等\n - moving: 引っ越し業\n - courier_industry: 宅配業\n - house_maid_cleaning_agency: 家事代行サービス業：無店舗　ハウスメイド、掃除代行等\n - re_tailoring_clothes: 家事代行サービス業：店舗あり　衣類修理、衣類仕立て直し等\n - training_institute_management: 研修所等の施設運営業\n - tutoring_school: 学習塾、進学塾等の教育・学習支援業\n - music_calligraphy_abacus_classroom: 音楽教室、書道教室、そろばん教室等の教育・学習支援業\n - english_school: 英会話スクール等の語学学習支援業\n - tennis_yoga_judo_school: テニススクール、ヨガ教室、柔道場等のスポーツ指導、支援業\n - culture_school: その他、カルチャースクール等の教育・学習支援業\n - seminar_planning_management: セミナー等の企画、運営業\n - hospital_clinic: 医療業：病院、一般診療所、クリニック等\n - dental_clinic: 医療業：歯科診療所\n - other_medical_services: 医療業：その他、医療サービス等\n - nursery: 福祉業：保育所等、児童向け施設型サービス\n - nursing_home: 福祉業：老人ホーム等、老人向け施設型サービス\n - rehabilitation_support_services: 福祉業：療育支援サービス等、障害者等向け施設型サービス\n - other_welfare: 福祉業：その他、施設型福祉サービス\n - visit_welfare_service: 福祉業：訪問型福祉サービス\n - recruitment_temporary_staffing: 人材紹介業、人材派遣業\n - life_related_recruitment_temporary_staffing: 生活関連サービスの人材紹介業、人材派遣業\n - car_maintenance_car_repair: 自動車整備業、自動車修理業\n - machinery_equipment_maintenance_repair: 機械機器類の整備業、修理業\n - cleaning_maintenance_building_management: 清掃業、メンテナンス業、建物管理業\n - security: 警備業\n - other_services: その他のサービス業\n - npo: 'NPO'\n - general_incorporated_association: '一般社団法人'\n - general_incorporated_foundation: '一般財団法人'\n - other_association: 'その他組織'\n
\n
\n### 業種 個人
\n - '': 未選択\n - manufacturing: 製造業\n - education: 教育\n - medical: 医療/福祉\n - ict: ソフトウェア・情報サービス業\n - food: 飲食業\n - construction: 建設業\n - transportation: 運送業\n - trading: 卸売業\n - retail: 小売業\n - finance: 金融/保険業\n - real_estate: 不動産業\n - agriculture: 農業\n - travel: 旅行・宿泊業\n - accountant: 専門業（税理士・会計士）\n - lawer: その他専門業（法律など）\n - consultant: サービス業（コンサルティング）\n - recruit: サービス業（人材）\n - publication: サービス業（出版）\n - design: サービス業（デザイン）\n - barber: サービス業（理容・美容）\n - others: その他サービス業\n - company_employee: 会社員\n - others_side_business: その他(副業や株取引のみなど)\n - others_deduction: その他(医療費などの控除のみ)\n - default: 未定", "enum": [ "", "agriculture", "forestry", "fishing_industry", "mining", "civil_contractors", "pavement", "carpenter", "renovation", "electrical_plumbing", "grocery", "machinery_manufacturing", "printing", "other_manufacturing", "software_development", "system_development", "survey_analysis", "server_management", "website_production", "online_service_management", "online_advertising_agency", "online_advertising_planning_production", "online_media_management", "portal_site_management", "other_it_services", "transport_delivery", "delivery", "other_transportation_logistics", "other_wholesale", "clothing_wholesale_fiber", "food_wholesale", "entrusted_development_wholesale", "online_shop", "fashion_grocery_store", "food_store", "entrusted_store", "other_store", "financial_instruments_exchange", "commodity_futures_investment_advisor", "other_financial", "brokerage_insurance", "other_insurance", "real_estate_developer", "real_estate_brokerage", "rent_coin_parking_management", "rental_office_co_working_space", "rental_lease", "cpa_tax_accountant", "law_office", "judicial_and_administrative_scrivener", "labor_consultant", "other_profession", "business_consultant", "academic_research_development", "advertising_agency", "advertising_planning_production", "design_development", "apparel_industry_design", "website_design", "advertising_planning_design", "other_design", "restaurants_coffee_shops", "sale_of_lunch", "bread_confectionery_manufacture_sale", "delivery_catering_mobile_catering", "hotel_inn", "homestay", "travel_agency", "leisure_sports_facility_management", "show_event_management", "barber", "beauty_salon", "spa_sand_bath_sauna", "este_ail_salon", "bridal_planning_introduce_wedding", "memorial_ceremony_funeral", "moving", "courier_industry", "house_maid_cleaning_agency", "re_tailoring_clothes", "training_institute_management", "tutoring_school", "music_calligraphy_abacus_classroom", "english_school", "tennis_yoga_judo_school", "culture_school", "seminar_planning_management", "hospital_clinic", "dental_clinic", "other_medical_services", "nursery", "nursing_home", "rehabilitation_support_services", "other_welfare", "visit_welfare_service", "recruitment_temporary_staffing", "life_related_recruitment_temporary_staffing", "car_maintenance_car_repair", "machinery_equipment_maintenance_repair", "cleaning_maintenance_building_management", "security", "other_services", "npo", "general_incorporated_association", "general_incorporated_foundation", "other_association", "manufacturing", "education", "medical", "ict", "food", "construction", "transportation", "trading", "retail", "finance", "real_estate", "travel", "accountant", "lawer", "consultant", "recruit", "publication", "design", "others", "company_employee", "others_side_business", "others_deduction", "default" ] }, "workflow_setting": { "type": "string", "description": "仕訳承認フロー（enable: 有効、 disable: 無効）", "example": "disabled", "enum": [ "enable", "disable" ] }, "fiscal_years": { "type": "array", "items": { "$ref": "#/components/schemas/fiscal_years" } }, "account_items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "categories" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "name": { "type": "string", "description": "勘定科目名 (30文字以内)", "example": "ソフトウェア" }, "shortcut": { "type": "string", "maxLength": 20, "description": "ショートカット1 (20文字以内)", "example": "SOFUTO", "nullable": true }, "categories": { "type": "array", "items": { "type": "string", "description": "勘定科目カテゴリー", "example": "資産" } } } } }, "tax_codes": { "type": "array", "items": { "type": "object", "required": [ "code", "name", "name_ja" ], "properties": { "code": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2147483647, "description": "税区分コード", "example": 21 }, "name": { "type": "string", "description": "税区分名", "example": "sales_with_tax" }, "name_ja": { "type": "string", "description": "税区分名（日本語表示用）", "example": "課税売上" } } } }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 101 }, "name": { "type": "string", "maxLength": 30, "description": "品目名 (30文字以内)", "example": "タクシー代" }, "shortcut1": { "type": "string", "description": "ショートカット１ (20文字以内)", "example": "TAXI", "nullable": true }, "shortcut2": { "type": "string", "description": "ショートカット２ (20文字以内)", "example": 201, "nullable": true } } } }, "partners": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "name": { "type": "string", "description": "取引先名", "example": "ABC商店" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット1 (255文字以内)", "example": "ABC", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット2 (255文字以内)", "example": "501", "nullable": true } } } }, "sections": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "部門名 (30文字以内)", "example": "開発部門" }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "DEVELOPER", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "123", "nullable": true }, "indent_count": { "type": "integer", "format": "int64", "minimum": 0, "description": "部門階層\n
\n※ indent_count が 0 のときは第一階層の親部門です。\n", "example": 0 }, "parent_id": { "type": "integer", "format": "int64", "description": "親部門ID\n
\n※ parent_id が null のときは第一階層の親部門です。\n", "example": 1, "nullable": true } } } }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "タグID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "名前(30文字以内)", "example": "メモタグ" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット1 (255文字以内)", "example": "MEMOTAG", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット2 (255文字以内)", "example": "123", "nullable": true } } } }, "walletables": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "freee銀行" }, "type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] } } } } } } } }, "unauthorizedError": { "type": "object", "properties": { "message": { "type": "string" }, "messages": { "type": "string" } } }, "forbiddenError": { "type": "object", "properties": { "message": { "type": "string" }, "messages": { "type": "string" } } }, "badRequestError": { "type": "object", "properties": { "status_code": { "type": "integer", "example": 400 }, "errors": { "type": "array", "items": { "required": [ "messages", "type" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "不正なリクエストです。" } }, "type": { "type": "string", "example": "validation", "enum": [ "status", "validation", "error" ] } } } } } }, "badRequestNotFoundError": { "type": "object", "properties": { "status_code": { "type": "integer", "example": 404 }, "errors": { "type": "array", "items": { "required": [ "messages", "type" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "リソースが見つかりません。" } }, "type": { "type": "string", "example": "validation", "enum": [ "status", "validation", "error" ] } } } } } }, "conflictError": { "type": "object", "properties": { "status_code": { "type": "integer", "example": 409 }, "errors": { "type": "array", "items": { "required": [ "messages", "type" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "リクエストが競合しました。" } }, "type": { "type": "string", "example": "validation", "enum": [ "status", "validation", "error" ] } } } } } }, "tooManyRequestsError": { "type": "object", "required": [ "status_code", "meta" ], "properties": { "status_code": { "type": "integer", "example": 429 }, "meta": { "required": [ "limit", "remaining", "reset" ], "type": "object", "properties": { "limit": { "type": "integer", "description": "設定されている上限値", "example": 100 }, "period": { "type": "integer", "description": "使用回数をカウントする期間 (秒)", "example": 5 }, "remaining": { "type": "integer", "description": "上限に達するまでの使用可能回数", "example": 0 }, "reset": { "type": "string", "description": "（上限値に達した場合）使用回数がリセットされる時刻", "example": "2019-12-17T18:30:24+09:00" } } } } }, "internalServerError": { "type": "object", "properties": { "status_code": { "type": "integer", "example": 500 }, "errors": { "type": "array", "items": { "required": [ "messages", "type" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "エラーが発生しました。" } }, "type": { "type": "string", "example": "status", "enum": [ "status", "validation", "error" ] } } } } } }, "serviceUnavailableError": { "type": "object", "required": [ "status_code", "errors" ], "properties": { "status_code": { "type": "integer", "example": 503 }, "errors": { "type": "array", "items": { "required": [ "messages", "type" ], "type": "object", "properties": { "messages": { "type": "array", "items": { "type": "string", "example": "このAPIは現在ご利用いただけません。" } }, "type": { "type": "string", "example": "error", "enum": [ "status", "error" ] } } } } } }, "partnersResponse": { "required": [ "partners" ], "type": "object", "properties": { "partners": { "type": "array", "items": { "type": "object", "required": [ "code", "company_id", "id", "name", "update_date", "available" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "description": "取引先名", "example": "ABC商店" }, "update_date": { "type": "string", "description": "更新日 (yyyy-mm-dd)", "example": "2019-12-17" }, "available": { "type": "boolean", "description": "取引先の使用設定（true: 使用する、false: 使用しない）\n
\n" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット1 (255文字以内)", "example": "ABC", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット2 (255文字以内)", "example": "501", "nullable": true }, "org_code": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2, "description": "事業所種別（null: 未設定、1: 法人、2: 個人）", "example": 1, "nullable": true }, "country_code": { "type": "string", "description": "地域（JP: 国内、ZZ:国外）", "example": "JP" }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "新しい取引先正式名称", "nullable": true }, "name_kana": { "type": "string", "maxLength": 255, "description": "カナ名称（255文字以内）", "example": "アタラシイトリヒキサキメイショウ", "nullable": true }, "default_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "phone": { "type": "string", "description": "電話番号", "example": "03-1234-xxxx", "nullable": true }, "contact_name": { "type": "string", "description": "担当者 氏名", "example": "営業担当", "nullable": true }, "email": { "type": "string", "description": "担当者 メールアドレス", "example": "contact@example.com", "nullable": true }, "payer_walletable_id": { "type": "integer", "format": "int64", "description": "振込元口座ID（一括振込ファイル用）:（未設定の場合は、nullです。）", "example": 1, "nullable": true }, "transfer_fee_handling_side": { "type": "string", "description": "振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee)", "example": "payer", "enum": [ "payer", "payee" ] }, "qualified_invoice_issuer": { "type": "boolean", "description": "インボイス制度適格請求書発行事業者（true: 対象事業者、false: 非対象事業者）\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": false }, "invoice_registration_number": { "type": "string", "description": "インボイス制度適格請求書発行事業者登録番号\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001", "nullable": true }, "address_attributes": { "type": "object", "properties": { "zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "street_name1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＹＹ１−１−１", "nullable": true }, "street_name2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル１Ｆ", "nullable": true } } }, "partner_doc_setting_attributes": { "type": "object", "properties": { "sending_method": { "type": "string", "description": "請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送、null:設定しない)", "example": "posting", "enum": [ "email", "posting", "email_and_posting" ], "nullable": true } } }, "partner_bank_account_attributes": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "銀行名", "example": "freee銀行", "nullable": true }, "bank_name_kana": { "type": "string", "description": "銀行名（カナ）", "example": "フリーギンコウ", "nullable": true }, "bank_code": { "type": "string", "description": "銀行コード", "example": "0001", "nullable": true }, "branch_name": { "type": "string", "description": "支店名", "example": "銀座支店", "nullable": true }, "branch_kana": { "type": "string", "description": "支店名（カナ）", "example": "ギンザシテン", "nullable": true }, "branch_code": { "type": "string", "description": "支店番号", "example": "999", "nullable": true }, "account_type": { "type": "string", "description": "口座種別(ordinary:普通、checking:当座、earmarked:納税準備預金、savings:貯蓄、other:その他)", "example": "ordinary", "enum": [ "ordinary", "checking", "earmarked", "savings", "other" ], "nullable": true }, "account_number": { "type": "string", "description": "口座番号", "example": "1010101", "nullable": true }, "account_name": { "type": "string", "description": "受取人名（カナ）", "example": "フリータロウ", "nullable": true }, "long_account_name": { "type": "string", "description": "受取人名", "example": "freee太郎", "nullable": true } } } } } } } }, "partnerResponse": { "required": [ "partner" ], "type": "object", "properties": { "partner": { "type": "object", "required": [ "code", "company_id", "id", "name", "update_date", "available" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 1 }, "code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "description": "取引先名", "example": "ABC商店" }, "update_date": { "type": "string", "description": "更新日 (yyyy-mm-dd)", "example": "2019-12-17" }, "available": { "type": "boolean", "description": "取引先の使用設定（true: 使用する、false: 使用しない）\n
\n" }, "shortcut1": { "type": "string", "maxLength": 255, "description": "ショートカット1 (255文字以内)", "example": "ABC", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 255, "description": "ショートカット2 (255文字以内)", "example": "501", "nullable": true }, "org_code": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2, "description": "事業所種別（null: 未設定、1: 法人、2: 個人）", "example": 1, "nullable": true }, "country_code": { "type": "string", "description": "地域（JP: 国内、ZZ:国外）", "example": "JP" }, "long_name": { "type": "string", "maxLength": 255, "description": "正式名称（255文字以内）", "example": "新しい取引先正式名称", "nullable": true }, "name_kana": { "type": "string", "maxLength": 255, "description": "カナ名称（255文字以内）", "example": "アタラシイトリヒキサキメイショウ", "nullable": true }, "default_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "phone": { "type": "string", "description": "電話番号", "example": "03-1234-xxxx", "nullable": true }, "contact_name": { "type": "string", "description": "担当者 氏名", "example": "営業担当", "nullable": true }, "email": { "type": "string", "description": "担当者 メールアドレス", "example": "contact@example.com", "nullable": true }, "payer_walletable_id": { "type": "integer", "format": "int64", "description": "振込元口座ID（一括振込ファイル用）:（未設定の場合は、nullです。）", "example": 1, "nullable": true }, "transfer_fee_handling_side": { "type": "string", "description": "振込手数料負担（一括振込ファイル用）: (振込元(当方): payer, 振込先(先方): payee)", "example": "payer", "enum": [ "payer", "payee" ] }, "qualified_invoice_issuer": { "type": "boolean", "description": "インボイス制度適格請求書発行事業者（true: 対象事業者、false: 非対象事業者）\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": false }, "invoice_registration_number": { "type": "string", "description": "インボイス制度適格請求書発行事業者登録番号\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001", "nullable": true }, "address_attributes": { "type": "object", "properties": { "zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "street_name1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＹＹ１−１−１", "nullable": true }, "street_name2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル１Ｆ", "nullable": true } } }, "partner_doc_setting_attributes": { "type": "object", "properties": { "sending_method": { "type": "string", "description": "請求書送付方法(email:メール、posting:郵送、email_and_posting:メールと郵送、null:設定しない)", "example": "posting", "enum": [ "email", "posting", "email_and_posting" ], "nullable": true } } }, "partner_bank_account_attributes": { "type": "object", "properties": { "bank_name": { "type": "string", "description": "銀行名", "example": "freee銀行", "nullable": true }, "bank_name_kana": { "type": "string", "description": "銀行名（カナ）", "example": "フリーギンコウ", "nullable": true }, "bank_code": { "type": "string", "description": "銀行コード", "example": "0001", "nullable": true }, "branch_name": { "type": "string", "description": "支店名", "example": "銀座支店", "nullable": true }, "branch_kana": { "type": "string", "description": "支店名（カナ）", "example": "ギンザシテン", "nullable": true }, "branch_code": { "type": "string", "description": "支店番号", "example": "999", "nullable": true }, "account_type": { "type": "string", "description": "口座種別(ordinary:普通、checking:当座、earmarked:納税準備預金、savings:貯蓄、other:その他)", "example": "ordinary", "enum": [ "ordinary", "checking", "earmarked", "savings", "other" ], "nullable": true }, "account_number": { "type": "string", "description": "口座番号", "example": "1010101", "nullable": true }, "account_name": { "type": "string", "description": "受取人名（カナ）", "example": "フリータロウ", "nullable": true }, "long_account_name": { "type": "string", "description": "受取人名", "example": "freee太郎", "nullable": true } } }, "payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32。）", "example": 15, "nullable": true }, "additional_months": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 6, "description": "支払月（当月を指定する場合は、0を指定してください。）", "example": 1, "nullable": true }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "支払日（29, 30, 31日の末日を指定する場合は、32。）", "example": 32, "nullable": true } } }, "invoice_payment_term_attributes": { "type": "object", "properties": { "cutoff_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "締め日（29, 30, 31日の末日を指定する場合は、32。）", "example": 15, "nullable": true }, "additional_months": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 6, "description": "入金月（当月を指定する場合は、0を指定してください。）", "example": 1, "nullable": true }, "fixed_day": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 32, "description": "入金日（29, 30, 31日の末日を指定する場合は、32。）", "example": 32, "nullable": true } } } } } } }, "tax": { "type": "object", "required": [ "code", "name", "name_ja" ], "properties": { "code": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 2147483647, "description": "税区分コード", "example": 21 }, "name": { "type": "string", "description": "税区分名", "example": "sales_with_tax" }, "name_ja": { "type": "string", "description": "税区分名（日本語表示用）", "example": "課税売上" } } }, "taxResponse": { "type": "object", "required": [ "tax" ], "properties": { "tax": { "$ref": "#/components/schemas/tax" } } }, "walletable": { "type": "object", "required": [ "bank_id", "id", "name", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "freee銀行" }, "bank_id": { "type": "integer", "format": "int64", "description": "サービスID", "example": 3, "nullable": true }, "type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "last_balance": { "type": "integer", "format": "int64", "description": "同期残高", "example": 1565583 }, "walletable_balance": { "type": "integer", "format": "int64", "description": "登録残高", "example": 1340261 } } }, "walletableCreateResponse": { "type": "object", "required": [ "walletable" ], "properties": { "walletable": { "type": "object", "required": [ "bank_id", "id", "name", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "name": { "type": "string", "description": "口座名, 最大255文字", "example": "〇〇銀行" }, "bank_id": { "type": "integer", "format": "int64", "description": "連携サービスID（typeにbank_account、credit_cardを指定する場合は必須）", "example": 1 }, "type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] } } } } }, "wallet_txn": { "type": "object", "required": [ "amount", "balance", "company_id", "date", "description", "due_amount", "entry_side", "id", "status", "walletable_id", "walletable_type", "rule_matched" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "明細ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "date": { "type": "string", "description": "取引日(yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額", "example": 5000 }, "due_amount": { "type": "integer", "format": "int64", "description": "未決済金額", "example": 0 }, "balance": { "type": "integer", "format": "int64", "description": "残高(銀行口座等)(Webで残高未設定で登録した場合や口座明細の作成APIでキーを指定しないで登録した場合などはnullとなります)", "example": 10000, "nullable": true }, "entry_side": { "type": "string", "description": "入金／出金 (入金: income, 出金: expense)", "example": "income", "enum": [ "income", "expense" ] }, "walletable_type": { "type": "string", "description": "口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "credit_card", "wallet" ] }, "walletable_id": { "type": "integer", "format": "int64", "description": "口座ID", "example": 1 }, "description": { "type": "string", "description": "取引内容", "example": "振込 カ）ABC" }, "status": { "type": "integer", "format": "int64", "minimum": 1, "maximum": 6, "description": "明細のステータス（消込待ち: 1, 消込済み: 2, 無視: 3, 消込中: 4, 対象外: 6）" }, "rule_matched": { "type": "boolean", "description": "登録時に自動登録ルールの設定が適用され、登録処理が実行された場合、\ntrueになります。〜を推測する、〜の消込をするの条件の場合は一致してもfalseになります。\n", "example": true } } }, "walletTxnResponse": { "type": "object", "required": [ "wallet_txn" ], "properties": { "wallet_txn": { "$ref": "#/components/schemas/wallet_txn" } } }, "transfer": { "type": "object", "required": [ "amount", "company_id", "date", "description", "from_walletable_id", "from_walletable_type", "id", "to_walletable_id", "to_walletable_type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "取引(振替)ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "金額", "example": 5000 }, "date": { "type": "string", "description": "振替日 (yyyy-mm-dd)", "example": "2019-12-17" }, "from_walletable_type": { "type": "string", "description": "振替元口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "credit_card", "enum": [ "bank_account", "wallet", "credit_card" ], "nullable": true }, "from_walletable_id": { "type": "integer", "format": "int64", "description": "振替元口座ID", "example": 101 }, "to_walletable_type": { "type": "string", "description": "振替先口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet)", "example": "bank_account", "enum": [ "bank_account", "wallet", "credit_card" ], "nullable": true }, "to_walletable_id": { "type": "integer", "format": "int64", "description": "振替先口座ID", "example": 201 }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true } } }, "transferResponse": { "type": "object", "required": [ "transfer" ], "properties": { "transfer": { "$ref": "#/components/schemas/transfer" } } }, "userParams": { "type": "object", "properties": { "display_name": { "type": "string", "maxLength": 20, "description": "表示名 (20文字以内)", "example": "山田太郎" }, "first_name": { "type": "string", "maxLength": 20, "description": "氏名（名） (20文字以内)", "example": "太郎" }, "last_name": { "type": "string", "maxLength": 20, "description": "氏名（姓） (20文字以内)", "example": "山田" }, "first_name_kana": { "type": "string", "maxLength": 20, "description": "氏名（カナ・名） (20文字以内)", "example": "タロウ" }, "last_name_kana": { "type": "string", "maxLength": 20, "description": "氏名（カナ・姓） (20文字以内)", "example": "ヤマダ" } } }, "user": { "type": "object", "required": [ "email", "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "email": { "type": "string", "description": "メールアドレス", "example": "example@freee.co.jp" }, "display_name": { "type": "string", "description": "表示名", "example": "山田太郎", "nullable": true }, "first_name": { "type": "string", "description": "氏名（名）", "example": "太郎", "nullable": true }, "last_name": { "type": "string", "description": "氏名（姓）", "example": "山田", "nullable": true }, "first_name_kana": { "type": "string", "description": "氏名（カナ・名）", "example": "タロウ", "nullable": true }, "last_name_kana": { "type": "string", "description": "氏名（カナ・姓）", "example": "ヤマダ", "nullable": true } } }, "userResponse": { "type": "object", "properties": { "user": { "$ref": "#/components/schemas/user" } } }, "meResponse": { "type": "object", "required": [ "user" ], "properties": { "user": { "type": "object", "required": [ "email", "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "email": { "type": "string", "description": "メールアドレス", "example": "contaxt@example.com" }, "display_name": { "type": "string", "description": "表示ユーザー名", "example": "フリー太郎", "nullable": true }, "first_name": { "type": "string", "description": "名", "example": "太郎", "nullable": true }, "last_name": { "type": "string", "description": "姓", "example": "フリー", "nullable": true }, "first_name_kana": { "type": "string", "description": "名（カナ）", "example": "タロウ", "nullable": true }, "last_name_kana": { "type": "string", "description": "姓（カナ）", "example": "フリー", "nullable": true }, "companies": { "type": "array", "items": { "type": "object", "required": [ "display_name", "id", "role", "use_custom_role" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "display_name": { "type": "string", "description": "表示名", "example": "freee株式会社" }, "role": { "type": "string", "description": "ユーザーの権限\n", "example": "admin", "enum": [ "admin", "simple_accounting", "self_only", "read_only", "workflow" ] }, "use_custom_role": { "type": "boolean", "description": "カスタム権限（true: 使用する、false: 使用しない）", "example": false }, "advisor_id": { "type": "integer", "format": "int64", "nullable": true, "description": "アドバイザープロファイルID（アドバイザー事業所で無い場合にnullになります）", "example": 1234 } } } } } } } }, "userCapability": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "create": { "type": "boolean", "description": "作成", "example": true }, "update": { "type": "boolean", "description": "更新", "example": true }, "destroy": { "type": "boolean", "description": "削除", "example": true } } }, "userCapabilityJustCreate": { "type": "object", "properties": { "create": { "type": "boolean", "description": "作成", "example": true } } }, "userCapabilityJustCreateRead": { "type": "object", "properties": { "create": { "type": "boolean", "description": "作成", "example": true }, "read": { "type": "boolean", "description": "閲覧", "example": true } } }, "userCapabilityJustRead": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true } } }, "userCapabilityJustReadUpdate": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "update": { "type": "boolean", "description": "更新", "example": true } } }, "userCapabilityJustReadUpdateDestroy": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "update": { "type": "boolean", "description": "更新", "example": true }, "destroy": { "type": "boolean", "description": "削除", "example": true } } }, "userCapabilityJustReadWrite": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "write": { "type": "boolean", "description": "操作", "example": true } } }, "userCapabilityJustUpdate": { "type": "object", "properties": { "update": { "type": "boolean", "description": "更新", "example": true } } }, "userCapabilityWithSelfOnly": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "create": { "type": "boolean", "description": "作成", "example": true }, "update": { "type": "boolean", "description": "更新", "example": true }, "destroy": { "type": "boolean", "description": "削除", "example": true }, "allowed_target": { "type": "string", "description": "「自分のみ」がonになっている場合はself_only、offになっている場合はallになります。", "enum": [ "self_only", "all" ] } } }, "userCapabilityWithConfirm": { "type": "object", "properties": { "confirm": { "type": "boolean", "description": "「自動で経理」の操作", "example": true }, "read": { "type": "boolean", "description": "「取得した明細」の閲覧", "example": true }, "create": { "type": "boolean", "description": "「取得した明細」の作成", "example": true }, "update": { "type": "boolean", "description": "「取得した明細」の更新", "example": true }, "destroy": { "type": "boolean", "description": "「取得した明細」の削除", "example": true } } }, "userCapabilityWithSync": { "type": "object", "properties": { "read": { "type": "boolean", "description": "「口座」の閲覧", "example": true }, "create": { "type": "boolean", "description": "「口座」の作成", "example": true }, "update": { "type": "boolean", "description": "「口座」の更新", "example": true }, "destroy": { "type": "boolean", "description": "「口座」の削除", "example": true }, "sync": { "type": "boolean", "description": "「口座の同期」の実行（廃止予定）", "example": true, "deprecated": true } } }, "userCapabilityWithWrite": { "type": "object", "properties": { "read": { "type": "boolean", "description": "閲覧", "example": true }, "create": { "type": "boolean", "description": "作成", "example": true }, "update": { "type": "boolean", "description": "更新", "example": true }, "destroy": { "type": "boolean", "description": "削除", "example": true }, "write": { "type": "boolean", "description": "操作", "example": true } } }, "receipt": { "type": "object", "required": [ "created_at", "id", "mime_type", "origin", "status", "user" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 1 }, "status": { "type": "string", "description": "ステータス(confirmed:確認済み、deleted:削除済み、ignored:無視)", "example": "confirmed", "enum": [ "confirmed", "deleted", "ignored" ] }, "description": { "type": "string", "description": "メモ", "example": "タクシー利用" }, "mime_type": { "type": "string", "description": "MIMEタイプ", "example": "image/png" }, "origin": { "type": "string", "description": "アップロード元種別", "example": "public_api", "enum": [ "unknown", "web", "mobile_camera", "mobile_album", "scansnap", "scannable", "dropbox", "mail", "safety_contact_file", "public_api" ] }, "created_at": { "type": "string", "description": "アップロード日時（ISO8601形式）", "example": "2019-12-17T18:30:24+09:00" }, "user": { "type": "object", "required": [ "email", "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "email": { "type": "string", "description": "メールアドレス", "example": "contact@example.com" }, "display_name": { "type": "string", "description": "表示名", "example": "フリー太郎", "nullable": true } } }, "receipt_metadatum": { "type": "object", "properties": { "partner_name": { "type": "string", "maxLength": 255, "nullable": true, "description": "発行元", "example": "freeeパートナー" }, "issue_date": { "type": "string", "nullable": true, "description": "発行日 (yyyy-mm-dd)", "example": "2019-12-17" }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "nullable": true, "description": "金額", "example": 5250 } } }, "qualified_invoice": { "type": "string", "description": "適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択、null: OCR解析結果が保存されている時等）", "enum": [ "qualified", "not_qualified", "unselected" ], "example": "qualified", "nullable": true }, "invoice_registration_number": { "type": "string", "maxLength": 14, "minLength": 14, "pattern": "^T[1-9][0-9]{12}$", "description": "インボイス制度適格請求書発行事業者登録番号（null: OCR解析結果が保存されている時等）\n- 先頭T数字13桁の固定14桁の文字列\n国税庁インボイス制度適格請求書発行事業者公表サイト\n", "example": "T1000000000001", "nullable": true }, "document_type": { "type": "string", "description": "書類の種類（receipt: 領収書、invoice: 請求書、other: その他、null: OCR解析結果が保存されている時等）", "enum": [ "receipt", "invoice", "other" ], "example": "receipt", "nullable": true } } }, "receiptResponse": { "type": "object", "required": [ "receipt" ], "properties": { "receipt": { "$ref": "#/components/schemas/receipt" } } }, "fiscal_years": { "required": [ "depreciation_record_method", "indirect_write_off_method", "return_code", "sales_tax_business_code", "tax_account_method", "tax_fraction", "tax_method", "use_industry_template" ], "type": "object", "properties": { "use_industry_template": { "type": "boolean", "description": "製造業向け機能（true: 使用する、false: 使用しない）", "example": false }, "indirect_write_off_method": { "type": "boolean", "description": "固定資産の控除法（true: 間接控除法、false: 直接控除法）", "example": true }, "start_date": { "type": "string", "description": "期首日", "example": "2019-12-17" }, "end_date": { "type": "string", "description": "期末日", "example": "2019-12-17" }, "depreciation_record_method": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 1, "description": "月次償却（0: しない、1: する）", "example": 0 }, "tax_method": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 4, "description": "課税区分（0: 免税、1: 簡易課税、2: 本則課税（個別対応方式）、3: 本則課税（一括比例配分方式）、4: 本則課税（全額控除））", "example": 0 }, "sales_tax_business_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 5, "description": "簡易課税用事業区分（0: 第一種：卸売業、1: 第二種：小売業、2: 第三種：農林水産業、工業、建設業、製造業など、3: 第四種：飲食店業など、4: 第五種：金融・保険業、運輸通信業、サービス業など、5: 第六種：不動産業など", "example": 0 }, "tax_fraction": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2, "description": "消費税端数処理方法（0: 切り捨て、1: 切り上げ、2: 四捨五入）", "example": 0 }, "tax_account_method": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2, "description": "消費税経理処理方法（0: 税込経理、1: 旧税抜経理、2: 税抜経理）", "example": 0 }, "return_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 3, "description": "不動産所得使用区分（0: 一般、3: 一般/不動産） ※個人事業主のみ設定可能", "example": 0 } } }, "expenseApplicationsIndexResponse": { "type": "object", "required": [ "expense_applications" ], "properties": { "expense_applications": { "type": "array", "items": { "type": "object", "required": [ "applicant_id", "application_number", "company_id", "id", "issue_date", "status", "title", "deal_id", "deal_status" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル", "example": "大阪出張" }, "issue_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "description": { "type": "string", "description": "備考", "example": "◯◯連携先ID: cx12345" }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 30000 }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 101, "nullable": true }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請の申請行ID", "example": 1 }, "transaction_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "receipt_id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 606, "nullable": true }, "sub_receipt_ids": { "type": "array", "description": "補足資料（配列）\n receipt_id（証憑ファイル）を指定してください。", "items": { "type": "integer", "format": "int64", "example": 606 } }, "expense_application_lines": { "type": "array", "description": "明細行一覧（配列）", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "明細行ID", "example": 1 }, "description": { "type": "string", "description": "内容", "example": "交通費：新幹線往復（東京〜大阪）", "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "金額", "example": 30000 }, "expense_application_line_template_id": { "type": "integer", "format": "int64", "description": "経費科目ID", "example": 505, "nullable": true } } } } } } }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:精算済み, unsettled:清算待ち)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true }, "applicant_id": { "type": "integer", "format": "int64", "description": "申請者のユーザーID", "example": 1 }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "current_step_id": { "type": "integer", "format": "int64", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 2, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 3, "nullable": true } } } } } }, "expenseApplicationResponse": { "type": "object", "required": [ "expense_application" ], "properties": { "expense_application": { "type": "object", "required": [ "applicant_id", "application_number", "approvers", "company_id", "id", "issue_date", "status", "title", "deal_id", "deal_status", "approval_flow_route_id", "comments", "approval_flow_logs", "current_step_id", "current_round" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル", "example": "大阪出張" }, "issue_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "description": { "type": "string", "description": "備考", "example": "◯◯連携先ID: cx12345", "nullable": true }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 30000 }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 101, "nullable": true }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費申請の申請行ID", "example": 1 }, "transaction_date": { "type": "string", "description": "発生日(yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "receipt_id": { "type": "integer", "format": "int64", "description": "ファイルボックス（証憑ファイル）ID", "example": 606, "nullable": true }, "sub_receipt_ids": { "type": "array", "description": "補足資料（配列）\n receipt_id（証憑ファイル）を指定してください。", "items": { "type": "integer", "format": "int64", "example": 606 } }, "expense_application_lines": { "type": "array", "description": "明細行一覧（配列）", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "明細行ID", "example": 1 }, "description": { "type": "string", "description": "内容", "example": "交通費：新幹線往復（東京〜大阪）", "nullable": true }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "金額", "example": 30000 }, "expense_application_line_template_id": { "type": "integer", "format": "int64", "description": "経費科目ID", "example": 505, "nullable": true } } } } } } }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:精算済み, unsettled:清算待ち)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true }, "applicant_id": { "type": "integer", "format": "int64", "description": "申請者のユーザーID", "example": 1 }, "approvers": { "type": "array", "description": "承認者（配列）\n 承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。\n しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、\n approversはレスポンスに含まれるようになります。\n その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。", "items": { "type": "object", "required": [ "step_id", "user_id", "status", "is_force_action", "resource_type" ], "properties": { "step_id": { "type": "integer", "format": "int64", "description": "承認ステップID", "example": 1 }, "user_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID\n下記の場合はnullになります。\n", "example": 1, "nullable": true }, "status": { "type": "string", "description": "承認者の承認状態\n* `initial` - 初期状態\n* `approved` - 承認済\n* `rejected` - 却下\n* `feedback` - 差戻し", "example": "initial", "enum": [ "initial", "approved", "rejected", "feedback" ] }, "is_force_action": { "type": "boolean", "description": "代理承認済みかどうか", "example": true }, "resource_type": { "type": "string", "description": "承認ステップの承認方法\n* ` predefined_user` - メンバー指定 (1人),\n* ` selected_user` - 申請時にメンバー指定\n* ` unspecified` - 指定なし\n* ` and_resource` - メンバー指定 (複数、全員の承認),\n* ` or_resource` - メンバー指定 (複数、1人の承認)\n* ` and_position` - 役職指定 (複数、全員の承認)\n* ` or_position` - 役職指定 (複数、1人の承認)", "enum": [ "predefined_user", "selected_user", "unspecified", "and_resource", "or_resource", "and_position", "or_position" ], "example": "predefined_user" } } } }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID", "example": 1 }, "comments": { "type": "array", "description": "経費申請のコメント一覧（配列）", "items": { "type": "object", "required": [ "comment", "user_id", "posted_at" ], "properties": { "comment": { "type": "string", "description": "コメント内容", "example": "訂正をお願いします。" }, "user_id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "posted_at": { "type": "string", "description": "コメント日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "approval_flow_logs": { "type": "array", "description": "経費申請の承認履歴（配列）", "items": { "type": "object", "required": [ "action", "user_id", "updated_at" ], "properties": { "action": { "type": "string", "description": "操作(apply: 申請, approve: 承認, force_approve: 代理承認, cancel: 取消, reject: 却下, feedback: 差戻し)", "enum": [ "apply", "approve", "force_approve", "cancel", "reject", "feedback" ], "example": "approve" }, "user_id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "updated_at": { "type": "string", "description": "更新日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "current_step_id": { "type": "integer", "format": "int64", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "parent_id": { "type": "integer", "format": "int64", "description": "親申請ID。各種申請が使用可能なプランの時のみレスポンスに含まれます。", "example": 2, "nullable": true }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID。セグメント１が使用可能なプランの時のみレスポンスに含まれます。", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID。セグメント２が使用可能なプランの時のみレスポンスに含まれます。", "example": 2, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID。セグメント３が使用可能なプランの時のみレスポンスに含まれます。", "example": 3, "nullable": true } } } } }, "expense_application_line_template": { "type": "object", "required": [ "account_item_name", "id", "name", "tax_name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "経費科目ID", "example": 1 }, "name": { "type": "string", "description": "経費科目名", "example": "交通費" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "旅費交通費" }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "tax_name": { "type": "string", "description": "税区分名", "example": "課対仕入" }, "description": { "type": "string", "description": "経費科目の説明", "example": "電車、バス、飛行機などの交通費" }, "line_description": { "type": "string", "description": "内容の補足", "example": "移動区間" }, "required_receipt": { "type": "boolean", "description": "添付ファイルの必須/任意", "example": true } } }, "expenseApplicationLineTemplateResponse": { "type": "object", "required": [ "expense_application_line_template" ], "properties": { "expense_application_line_template": { "$ref": "#/components/schemas/expense_application_line_template" } } }, "paymentRequestResponse": { "type": "object", "required": [ "payment_request" ], "properties": { "payment_request": { "type": "object", "required": [ "id", "company_id", "title", "application_date", "description", "total_amount", "status", "payment_request_lines", "deal_id", "deal_status", "applicant_id", "approvers", "application_number", "approval_flow_route_id", "comments", "approval_flow_logs", "current_step_id", "current_round", "document_code", "receipt_ids", "issue_date", "payment_date", "payment_method", "partner_id", "partner_name", "bank_name", "bank_name_kana", "bank_code", "branch_name", "branch_kana", "branch_code", "account_type", "account_number", "account_name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "支払依頼ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル", "example": "仕入代金支払い" }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "description": { "type": "string", "description": "備考", "example": "◯◯連携先ID: cx12345" }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 30000 }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "payment_request_lines": { "type": "array", "description": "支払依頼の項目行一覧（配列）", "items": { "type": "object", "required": [ "id", "line_type", "description", "amount", "account_item_id", "tax_code", "item_id", "section_id", "tag_ids" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "支払依頼の項目行ID", "example": 1 }, "line_type": { "type": "string", "description": "'行の種類 (deal_line: 支払依頼の通常取引行, negative_line: 支払依頼の控除・マイナス行, withholding_tax: 源泉所得税行)'\n", "example": "deal_line", "enum": [ "deal_line", "negative_line", "withholding_tax" ] }, "description": { "type": "string", "description": "内容", "example": "原稿料" }, "amount": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 99999999999, "description": "金額", "example": 30000 }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1, "nullable": true }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID。セグメント１が使用可能なプランの時のみレスポンスに含まれます。", "example": 1, "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID。セグメント２が使用可能なプランの時のみレスポンスに含まれます。", "example": 1, "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID。セグメント３が使用可能なプランの時のみレスポンスに含まれます。", "example": 1, "nullable": true } } } }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:支払済み, unsettled:支払待ち)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true }, "applicant_id": { "type": "integer", "format": "int64", "description": "申請者のユーザーID", "example": 1 }, "approvers": { "type": "array", "description": "承認者（配列）\n 承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。\n しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、\n approversはレスポンスに含まれるようになります。\n その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。", "items": { "type": "object", "required": [ "step_id", "user_id", "status", "is_force_action", "resource_type" ], "properties": { "step_id": { "type": "integer", "format": "int64", "description": "承認ステップID", "example": 1 }, "user_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID\n下記の場合はnullになります。\n", "example": 1, "nullable": true }, "status": { "type": "string", "description": "承認者の承認状態\n* `initial` - 初期状態\n* `approved` - 承認済\n* `rejected` - 却下\n* `feedback` - 差戻し", "example": "initial", "enum": [ "initial", "approved", "rejected", "feedback" ] }, "is_force_action": { "type": "boolean", "description": "代理承認済みかどうか", "example": true }, "resource_type": { "type": "string", "description": "承認ステップの承認方法\n* ` predefined_user` - メンバー指定 (1人),\n* ` selected_user` - 申請時にメンバー指定\n* ` unspecified` - 指定なし\n* ` and_resource` - メンバー指定 (複数、全員の承認),\n* ` or_resource` - メンバー指定 (複数、1人の承認)\n* ` and_position` - 役職指定 (複数、全員の承認)\n* ` or_position` - 役職指定 (複数、1人の承認)", "enum": [ "predefined_user", "selected_user", "unspecified", "and_resource", "or_resource", "and_position", "or_position" ], "example": "predefined_user" } } } }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "approval_flow_route_id": { "type": "integer", "format": "int64", "description": "申請経路ID", "example": 1 }, "comments": { "type": "array", "description": "支払依頼のコメント一覧（配列）", "items": { "type": "object", "required": [ "comment", "user_id", "posted_at" ], "properties": { "comment": { "type": "string", "description": "コメント内容", "example": "訂正をお願いします。" }, "user_id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "posted_at": { "type": "string", "description": "コメント日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "approval_flow_logs": { "type": "array", "description": "支払依頼の承認履歴（配列）", "items": { "type": "object", "required": [ "action", "user_id", "updated_at" ], "properties": { "action": { "type": "string", "description": "操作(apply: 申請, approve: 承認, force_approve: 代理承認, cancel: 取消, reject: 却下, feedback: 差戻し)", "enum": [ "apply", "approve", "force_approve", "cancel", "reject", "feedback" ], "example": "approve" }, "user_id": { "type": "integer", "format": "int64", "description": "ユーザーID", "example": 1 }, "updated_at": { "type": "string", "description": "更新日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "current_step_id": { "type": "integer", "format": "int64", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "document_code": { "type": "string", "description": "請求書番号", "example": "2" }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID", "example": [ 1, 2, 3 ], "items": { "type": "integer" }, "format": "int64" }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "payment_date": { "type": "string", "description": "支払期限 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "payment_method": { "type": "string", "description": "支払方法(none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード)", "example": "none", "enum": [ "none", "domestic_bank_transfer", "abroad_bank_transfer", "account_transfer", "credit_card" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "partner_name": { "type": "string", "description": "取引先名", "example": "freee", "nullable": true }, "bank_name": { "type": "string", "description": "銀行名", "example": "freee銀行" }, "bank_name_kana": { "type": "string", "description": "銀行名（カナ）", "example": "フリーギンコウ" }, "bank_code": { "type": "string", "description": "銀行コード", "example": "0001" }, "branch_name": { "type": "string", "description": "支店名", "example": "銀座支店" }, "branch_kana": { "type": "string", "description": "支店名（カナ）", "example": "ギンザシテン" }, "branch_code": { "type": "string", "description": "支店番号", "example": "101" }, "account_type": { "type": "string", "description": "口座種別(ordinary:普通、checking:当座、earmarked:納税準備預金、savings:貯蓄、other:その他)", "example": "ordinary", "enum": [ "ordinary", "checking", "earmarked", "savings", "other" ] }, "account_number": { "type": "string", "description": "口座番号", "example": "1010101" }, "account_name": { "type": "string", "description": "受取人名（カナ）", "example": "フリータロウ" }, "qualified_invoice_status": { "type": "string", "description": "適格請求書発行事業者（qualified: 該当する、not_qualified: 該当しない、unspecified: 未選択）\n- 支払依頼をインボイス要件をみたす申請として扱うかどうかを表します。\n", "enum": [ "qualified", "not_qualified", "unspecified" ], "example": "qualified" } } } } }, "paymentRequestsIndexResponse": { "type": "object", "required": [ "payment_requests" ], "properties": { "payment_requests": { "type": "array", "items": { "type": "object", "required": [ "id", "company_id", "title", "application_date", "total_amount", "status", "applicant_id", "approvers", "application_number", "current_step_id", "current_round", "document_code", "issue_date", "payment_date", "payment_method", "partner_id", "partner_code", "partner_name" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "支払依頼ID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "title": { "type": "string", "description": "申請タイトル", "example": "仕入代金支払い" }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 30000 }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:支払済み, unsettled:支払待ち)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true }, "applicant_id": { "type": "integer", "format": "int64", "description": "申請者のユーザーID", "example": 1 }, "approvers": { "type": "array", "description": "承認者（配列）\n 承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。\n しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、\n approversはレスポンスに含まれるようになります。\n その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。", "items": { "type": "object", "required": [ "step_id", "user_id", "status", "is_force_action", "resource_type" ], "properties": { "step_id": { "type": "integer", "format": "int64", "description": "承認ステップID", "example": 1 }, "user_id": { "type": "integer", "format": "int64", "description": "承認者のユーザーID\n下記の場合はnullになります。\n", "example": 1, "nullable": true }, "status": { "type": "string", "description": "承認者の承認状態\n* `initial` - 初期状態\n* `approved` - 承認済\n* `rejected` - 却下\n* `feedback` - 差戻し", "example": "initial", "enum": [ "initial", "approved", "rejected", "feedback" ] }, "is_force_action": { "type": "boolean", "description": "代理承認済みかどうか", "example": true }, "resource_type": { "type": "string", "description": "承認ステップの承認方法\n* ` predefined_user` - メンバー指定 (1人),\n* ` selected_user` - 申請時にメンバー指定\n* ` unspecified` - 指定なし\n* ` and_resource` - メンバー指定 (複数、全員の承認),\n* ` or_resource` - メンバー指定 (複数、1人の承認)\n* ` and_position` - 役職指定 (複数、全員の承認)\n* ` or_position` - 役職指定 (複数、1人の承認)", "enum": [ "predefined_user", "selected_user", "unspecified", "and_resource", "or_resource", "and_position", "or_position" ], "example": "predefined_user" } } } }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "current_step_id": { "type": "integer", "format": "int64", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "document_code": { "type": "string", "description": "請求書番号", "example": "2" }, "issue_date": { "type": "string", "description": "発生日 (yyyy-mm-dd)", "example": "2019-12-17" }, "payment_date": { "type": "string", "description": "支払期限 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "payment_method": { "type": "string", "description": "支払方法(none: 指定なし, domestic_bank_transfer: 国内振込, abroad_bank_transfer: 国外振込, account_transfer: 口座振替, credit_card: クレジットカード)", "example": "none", "enum": [ "none", "domestic_bank_transfer", "abroad_bank_transfer", "account_transfer", "credit_card" ] }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "partner_name": { "type": "string", "description": "取引先名", "example": "freee", "nullable": true }, "qualified_invoice_status": { "type": "string", "description": "適格請求書発行事業者（qualified: 該当する、not_qualified: 該当しない、unspecified: 未選択）\n- 支払依頼をインボイス要件をみたす申請として扱うかどうかを表します。\n", "enum": [ "qualified", "not_qualified", "unspecified" ], "example": "qualified" }, "input_mode": { "type": "string", "description": "内税/外税（inclusive: 内税、exclusive: 外税）\n外税の支払依頼は他のエンドポイントで利用できないため、Web 画面からご確認ください。", "enum": [ "inclusive", "exclusive" ], "example": "inclusive" } } } } } }, "paymentRequestActionCreateParams": { "type": "object", "required": [ "company_id", "approval_action", "target_step_id", "target_round" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "approval_action": { "type": "string", "description": "操作(approve: 承認する、force_approve: 代理承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す)", "example": "approve", "enum": [ "approve", "force_approve", "cancel", "reject", "feedback", "force_feedback" ] }, "target_step_id": { "type": "integer", "format": "int64", "description": "対象承認ステップID 支払依頼の取得APIレスポンス.current_step_idを送信してください。", "example": 1 }, "target_round": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "対象round。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。支払依頼の取得APIレスポンス.current_roundを送信してください。", "example": 1 }, "next_approver_id": { "type": "integer", "format": "int64", "description": "次ステップの承認者のユーザーID", "example": 1, "nullable": true } } }, "approvalRequestCreateParams": { "type": "object", "required": [ "company_id", "approval_flow_route_id", "form_id", "request_items", "draft" ], "properties": { "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。\n", "example": "2019-12-17" }, "approval_flow_route_id": { "type": "integer", "description": "申請経路ID", "example": 1 }, "form_id": { "type": "integer", "description": "申請フォームID", "example": 1 }, "approver_id": { "type": "integer", "description": "承認者のユーザーID", "example": 1 }, "draft": { "type": "boolean", "description": "各種申請のステータス
\nfalseを指定した時は申請中（in_progress）で各種申請を作成します。
\ntrueを指定した時は下書き（draft）で各種申請を作成します。\n", "example": true }, "parent_id": { "type": "integer", "description": "親申請ID(既存各種申請IDのみ指定可能です。)", "example": 2 }, "request_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "type": { "type": "string", "description": "項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID)", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner" ] }, "value": { "type": "string", "description": "項目の値", "example": "申請理由" } } } } } }, "approvalRequestUpdateParams": { "type": "object", "required": [ "company_id", "approval_flow_route_id", "request_items", "draft" ], "properties": { "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)
\n指定しない場合は当日の日付が登録されます。\n", "example": "2019-12-17" }, "approval_flow_route_id": { "type": "integer", "description": "申請経路ID", "example": 1 }, "approver_id": { "type": "integer", "description": "承認者のユーザーID", "example": 1 }, "draft": { "type": "boolean", "description": "各種申請のステータス
\nfalseを指定した時は申請中（in_progress）で各種申請を更新します。
\ntrueを指定した時は下書き（draft）で各種申請を更新します。\n", "example": true }, "request_items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "type": { "type": "string", "description": "項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID)", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner" ] }, "value": { "type": "string", "description": "項目の値", "example": "申請理由" } } } } } }, "approvalRequestActionCreateParams": { "type": "object", "required": [ "company_id", "approval_action", "target_step_id", "target_round" ], "properties": { "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "approval_action": { "type": "string", "description": "操作(approve: 承認する、force_approve: 代理承認する、cancel: 申請を取り消す、reject: 却下する、feedback: 申請者へ差し戻す、force_feedback: 承認済み・却下済みを取り消す)", "example": "approve", "enum": [ "approve", "force_approve", "cancel", "reject", "feedback", "force_feedback" ] }, "target_step_id": { "type": "integer", "description": "対象承認ステップID 各種申請の取得APIレスポンス.current_step_idを送信してください。", "example": 1 }, "target_round": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "対象round。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。各種申請の取得APIレスポンス.current_roundを送信してください。", "example": 1 }, "next_approver_id": { "type": "integer", "description": "次ステップの承認者のユーザーID", "example": 1, "nullable": true } } }, "renewCreateParams": { "type": "object", "required": [ "company_id", "details", "renew_target_id", "update_date" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "update_date": { "type": "string", "description": "更新日 (yyyy-mm-dd)", "example": "2019-12-17" }, "renew_target_id": { "type": "integer", "format": "int64", "description": "+更新対象行ID (details(取引の明細行), accruals(債権債務行), renewsのdetails(+更新の明細行)のIDを指定) ", "example": 1 }, "details": { "type": "array", "description": "+更新の明細行", "items": { "type": "object", "required": [ "account_item_id", "amount", "tax_code" ], "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1080 }, "vat": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "消費税額（指定しない場合は自動で計算されます）", "example": 80 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } } } } } }, "renewUpdateParams": { "type": "object", "required": [ "company_id", "details", "update_date" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "update_date": { "type": "string", "description": "更新日 (yyyy-mm-dd)", "example": "2019-12-17" }, "details": { "type": "array", "description": "+更新の明細行", "items": { "type": "object", "required": [ "account_item_id", "amount", "tax_code" ], "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "取引金額（税込で指定してください）
\nマイナスの値を指定した場合、控除・マイナス行として登録されます。
\n上記以外の値を指定した場合、通常行として登録されます。\n", "example": 1080 }, "vat": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "消費税額（指定しない場合は自動で計算されます）", "example": 80 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } } } } } }, "expenseApplicationLineTemplateParams": { "type": "object", "required": [ "company_id", "name", "account_item_id", "tax_code" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 1000, "description": "経費科目名 (100文字以内)", "example": "交通費" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード（税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。税区分のdisplay_categoryは /taxes/companies/{:company_id}のAPIから取得可能です。）", "example": 1 }, "description": { "type": "string", "maxLength": 1000, "description": "経費科目の説明 (1000文字以内)", "example": "電車、バス、飛行機などの交通費" }, "line_description": { "type": "string", "maxLength": 1000, "description": "内容の補足 (1000文字以内)", "example": "移動区間" }, "required_receipt": { "type": "boolean", "example": true, "description": "添付ファイルの必須/任意
\nfalseを指定した時は申請時の領収書の添付を任意とします。
\ntrueを指定した時は申請時の領収書の添付を必須とします。
\n未指定の時は申請時の領収書の添付を任意とします。" } } }, "approvalRequestsIndexResponse": { "type": "object", "required": [ "approval_requests" ], "properties": { "approval_requests": { "type": "array", "items": { "type": "object", "required": [ "applicant_id", "application_date", "application_number", "company_id", "id", "request_items", "status", "title", "form_id", "current_step_id", "current_round", "deal_id", "manual_journal_id", "deal_status" ], "properties": { "id": { "type": "integer", "description": "各種申請ID", "example": 1 }, "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "title": { "type": "string", "description": "申請タイトル", "example": "大阪出張" }, "applicant_id": { "type": "integer", "description": "申請者のユーザーID", "example": 1 }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "request_items": { "type": "array", "description": "各種申請の項目一覧（配列）", "items": { "type": "object", "required": [ "id", "type", "value" ], "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "type": { "type": "string", "description": "項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID, ninja_sign_document: 契約書（freeeサイン連携）)", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner", "ninja_sign_document" ], "example": "single_line" }, "value": { "type": "string", "description": "項目の値", "example": "取引先への営業のため" } } } }, "form_id": { "type": "integer", "description": "申請フォームID", "example": 1 }, "current_step_id": { "type": "integer", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "deal_id": { "type": "integer", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "manual_journal_id": { "type": "integer", "description": "振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)\n\n承認された各種申請から支払依頼等を作成する\n", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true } } } } } }, "approvalRequestResponse": { "type": "object", "required": [ "approval_request" ], "properties": { "approval_request": { "type": "object", "required": [ "applicant_id", "application_date", "application_number", "approvers", "company_id", "id", "request_items", "status", "title", "form_id", "approval_flow_route_id", "comments", "approval_flow_logs", "current_step_id", "current_round", "approval_request_form", "deal_id", "manual_journal_id", "deal_status" ], "properties": { "id": { "type": "integer", "description": "各種申請ID", "example": 1 }, "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "application_date": { "type": "string", "description": "申請日 (yyyy-mm-dd)", "example": "2019-12-17" }, "title": { "type": "string", "description": "申請タイトル", "example": "大阪出張" }, "applicant_id": { "type": "integer", "description": "申請者のユーザーID", "example": 1 }, "approvers": { "type": "array", "description": "承認者（配列）\n 承認ステップのresource_typeがunspecified (指定なし)の場合はapproversはレスポンスに含まれません。\n しかし、resource_typeがunspecifiedの承認ステップにおいて誰かが承認・却下・差し戻しのいずれかのアクションを取った後は、\n approversはレスポンスに含まれるようになります。\n その場合approversにはアクションを行ったステップのIDとアクションを行ったユーザーのIDが含まれます。", "items": { "type": "object", "required": [ "step_id", "user_id", "status", "is_force_action", "resource_type" ], "properties": { "step_id": { "type": "integer", "description": "承認ステップID", "example": 1 }, "user_id": { "type": "integer", "description": "承認者のユーザーID\n下記の場合はnullになります。\n", "example": 1, "nullable": true }, "status": { "type": "string", "description": "承認者の承認状態\n* `initial` - 初期状態\n* `approved` - 承認済\n* `rejected` - 却下\n* `feedback` - 差戻し", "example": "initial", "enum": [ "initial", "approved", "rejected", "feedback" ] }, "is_force_action": { "type": "boolean", "description": "代理承認済みかどうか", "example": true }, "resource_type": { "type": "string", "description": "承認ステップの承認方法\n* ` predefined_user` - メンバー指定 (1人),\n* ` selected_user` - 申請時にメンバー指定\n* ` unspecified` - 指定なし\n* ` and_resource` - メンバー指定 (複数、全員の承認),\n* ` or_resource` - メンバー指定 (複数、1人の承認)\n* ` and_position` - 役職指定 (複数、全員の承認)\n* ` or_position` - 役職指定 (複数、1人の承認)", "enum": [ "predefined_user", "selected_user", "unspecified", "and_resource", "or_resource", "and_position", "or_position" ], "example": "predefined_user" } } } }, "application_number": { "type": "string", "description": "申請No.", "example": "2" }, "status": { "type": "string", "description": "申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し)", "example": "draft", "enum": [ "draft", "in_progress", "approved", "rejected", "feedback" ] }, "request_items": { "type": "array", "description": "各種申請の項目一覧（配列）", "items": { "type": "object", "required": [ "id", "type", "value" ], "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "type": { "type": "string", "description": "項目タイプ(title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID, ninja_sign_document: 契約書（freeeサイン連携）)", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner", "ninja_sign_document" ], "example": "single_line" }, "value": { "type": "string", "description": "項目の値", "example": "取引先への営業のため" } } } }, "form_id": { "type": "integer", "description": "申請フォームID", "example": 1 }, "approval_flow_route_id": { "type": "integer", "description": "申請経路ID", "example": 1 }, "comments": { "type": "array", "description": "各種申請のコメント一覧（配列）", "items": { "type": "object", "required": [ "comment", "user_id", "posted_at" ], "properties": { "comment": { "type": "string", "description": "コメント内容", "example": "訂正をお願いします。" }, "user_id": { "type": "integer", "description": "ユーザーID", "example": 1 }, "posted_at": { "type": "string", "description": "コメント日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "approval_flow_logs": { "type": "array", "description": "各種申請の承認履歴（配列）", "items": { "type": "object", "required": [ "action", "user_id", "updated_at" ], "properties": { "action": { "type": "string", "description": "操作(apply: 申請, approve: 承認, force_approve: 代理承認, cancel: 取消, reject: 却下, feedback: 差戻し)", "enum": [ "apply", "approve", "force_approve", "cancel", "reject", "feedback" ], "example": "approve" }, "user_id": { "type": "integer", "description": "ユーザーID", "example": 1 }, "updated_at": { "type": "string", "description": "更新日時(ISO8601形式)", "example": "2019-12-17T18:30:24+09:00" } } } }, "current_step_id": { "type": "integer", "description": "現在承認ステップID", "example": 1, "nullable": true }, "current_round": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "現在のround。差し戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。", "example": 1 }, "approval_request_form": { "type": "object", "required": [ "parts" ], "properties": { "parts": { "type": "array", "description": "申請フォームの項目", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "order": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 1 }, "type": { "type": "string", "description": "項目種別 (title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID, ninja_sign_document: 契約書（freeeサイン連携）)", "example": "single_line", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner", "ninja_sign_document" ] }, "label": { "type": "string", "description": "項目名", "example": "項目名" }, "annotation": { "type": "string", "description": "追加説明", "example": "追加説明", "nullable": true }, "required": { "type": "boolean", "description": "必須かどうか", "example": true, "nullable": true }, "values": { "type": "array", "description": "選択項目", "items": { "type": "object", "required": [ "name", "order" ], "properties": { "name": { "type": "string", "description": "選択項目名", "example": "選択項目名" }, "order": { "type": "integer", "minimum": 1, "maximum": 2147483647, "description": "順序", "example": 1 } } }, "nullable": true }, "max_amount": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "上限金額", "example": 100000, "nullable": true }, "min_amount": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "下限金額", "example": 1000, "nullable": true } } } } } }, "deal_id": { "type": "integer", "description": "取引ID (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_idが表示されます)", "example": 1, "nullable": true }, "manual_journal_id": { "type": "integer", "description": "振替伝票のID (申請ステータス:statusがapprovedで、関連する振替伝票が存在する時のみmanual_journal_idが表示されます)\n\n承認された各種申請から支払依頼等を作成する\n", "example": 1, "nullable": true }, "deal_status": { "type": "string", "description": "取引ステータス (申請ステータス:statusがapprovedで、取引が存在する時のみdeal_statusが表示されます settled:決済済み, unsettled:未決済)", "example": "settled", "enum": [ "settled", "unsettled" ], "nullable": true } } } } }, "approvalRequestFormIndexResponse": { "type": "object", "required": [ "approval_request_forms" ], "properties": { "approval_request_forms": { "type": "array", "items": { "type": "object", "required": [ "id", "company_id", "name", "description", "status", "created_date", "form_order", "route_setting_count" ], "properties": { "id": { "type": "integer", "description": "申請フォームID", "example": 1 }, "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "description": "申請フォームの名前", "example": "申請フォームの名前" }, "description": { "type": "string", "description": "申請フォームの説明", "example": "申請フォームの説明" }, "status": { "type": "string", "description": "ステータス(draft: 申請で使用しない、active: 申請で使用する)", "example": "active", "enum": [ "draft", "active" ] }, "created_date": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "form_order": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "表示順（申請者が選択する申請フォームの表示順を設定できます。小さい数ほど上位に表示されます。（0を除く整数のみ。マイナス不可）未入力の場合、表示順が後ろになります。同じ数字が入力された場合、登録順で表示されます。）", "example": 1, "nullable": true }, "route_setting_count": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "適用された経路数（ユーザーが利用できない経路を除く）", "example": 1 } } } } } }, "approvalRequestFormResponse": { "type": "object", "required": [ "approval_request_form" ], "properties": { "approval_request_form": { "type": "object", "required": [ "id", "company_id", "name", "description", "status", "created_date", "form_order", "route_setting_count" ], "properties": { "id": { "type": "integer", "description": "申請フォームID", "example": 1 }, "company_id": { "type": "integer", "description": "事業所ID", "example": 1 }, "name": { "type": "string", "description": "申請フォームの名前", "example": "申請フォームの名前" }, "description": { "type": "string", "description": "申請フォームの説明", "example": "申請フォームの説明" }, "status": { "type": "string", "description": "ステータス(draft: 申請で使用しない、active: 申請で使用する)", "example": "active", "enum": [ "draft", "active" ] }, "created_date": { "type": "string", "description": "作成日時", "example": "2019-12-17T13:47:24+09:00" }, "form_order": { "type": "integer", "minimum": 1, "maximum": 1000, "description": "表示順（申請者が選択する申請フォームの表示順を設定できます。小さい数ほど上位に表示されます。（0を除く整数のみ。マイナス不可）未入力の場合、表示順が後ろになります。同じ数字が入力された場合、登録順で表示されます。）", "example": 1, "nullable": true }, "parts": { "type": "array", "description": "申請フォームの項目", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "description": "項目ID", "example": 1 }, "order": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 1 }, "type": { "type": "string", "description": "項目種別 (title: 申請タイトル, single_line: 自由記述形式 1行, multi_line: 自由記述形式 複数行, select: プルダウン, date: 日付, amount: 金額, receipt: 添付ファイル, section: 部門ID, partner: 取引先ID, ninja_sign_document: 契約書（freeeサイン連携）)", "example": "single_line", "enum": [ "title", "single_line", "multi_line", "select", "date", "amount", "receipt", "section", "partner", "ninja_sign_document" ] }, "label": { "type": "string", "description": "項目名", "example": "項目名" }, "annotation": { "type": "string", "description": "追加説明", "example": "追加説明", "nullable": true }, "required": { "type": "boolean", "description": "必須かどうか", "example": true, "nullable": true }, "values": { "type": "array", "description": "選択項目", "items": { "type": "object", "required": [ "name", "order" ], "properties": { "name": { "type": "string", "description": "選択項目名", "example": "選択項目名" }, "order": { "type": "integer", "minimum": 1, "maximum": 2147483647, "description": "順序", "example": 1 } } }, "nullable": true }, "max_amount": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "上限金額", "example": 100000, "nullable": true }, "min_amount": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "下限金額", "example": 1000, "nullable": true } } } }, "route_setting_count": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "適用された経路数（ユーザーが利用できない経路を除く）", "example": 1 } } } } }, "approvalFlowRoutesIndexResponse": { "type": "object", "required": [ "approval_flow_routes" ], "properties": { "approval_flow_routes": { "type": "array", "items": { "type": "object", "required": [ "id", "default_route" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "申請経路ID", "example": 1 }, "name": { "type": "string", "description": "申請経路名", "example": "申請経路" }, "description": { "type": "string", "description": "申請経路の説明", "example": "申請経路の説明" }, "user_id": { "type": "integer", "format": "int64", "description": "更新したユーザーのユーザーID", "example": 1, "nullable": true }, "definition_system": { "type": "boolean", "description": "システム作成の申請経路かどうか", "example": true }, "first_step_id": { "type": "integer", "format": "int64", "description": "最初の承認ステップのID", "example": 1 }, "usages": { "type": "array", "description": "申請種別（申請経路を使用できる申請種別を示します。例えば、ApprovalRequest の場合は、各種申請で使用できる申請経路です。）\n* `TxnApproval` - 仕訳承認\n* `ExpenseApplication` - 経費精算\n* `PaymentRequest` - 支払依頼\n* `ApprovalRequest` - 各種申請\n* `DocApproval` - 請求書等 (見積書・納品書・請求書・発注書)", "items": { "type": "string", "enum": [ "TxnApproval", "ExpenseApplication", "PaymentRequest", "ApprovalRequest", "DocApproval" ], "example": "TxnApproval" } }, "request_form_ids": { "type": "array", "description": "申請経路で利用できる申請フォームID配列", "items": { "type": "integer", "format": "int64", "description": "申請フォームID", "example": 1 } }, "default_route": { "type": "boolean", "description": "基本経路として設定されているかどうか

\nリクエストパラメータusageに下記のいずれかが指定され、かつ、基本経路の場合はtrueになります。\n* `TxnApproval` - 仕訳承認\n* `ExpenseApplication` - 経費精算\n* `PaymentRequest` - 支払依頼\n* `ApprovalRequest`(リクエストパラメータrequest_form_idを同時に指定) - 各種申請\n* `DocApproval` - 請求書等 (見積書・納品書・請求書・発注書)\n\n申請フォームの基本経路設定\n", "example": true } } } } } }, "approvalFlowRouteResponse": { "type": "object", "required": [ "approval_flow_route" ], "properties": { "approval_flow_route": { "type": "object", "required": [ "id", "request_form_ids" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "申請経路ID", "example": 1 }, "name": { "type": "string", "description": "申請経路名", "example": "申請経路" }, "description": { "type": "string", "description": "申請経路の説明", "example": "申請経路の説明" }, "user_id": { "type": "integer", "format": "int64", "description": "更新したユーザーのユーザーID", "example": 1, "nullable": true }, "definition_system": { "type": "boolean", "description": "システム作成の申請経路かどうか", "example": true }, "first_step_id": { "type": "integer", "format": "int64", "description": "最初の承認ステップのID", "example": 1 }, "usages": { "type": "array", "description": "申請種別（申請経路を使用できる申請種別を示します。例えば、ApprovalRequest の場合は、各種申請で使用できる申請経路です。）\n* `TxnApproval` - 仕訳承認\n* `ExpenseApplication` - 経費精算\n* `PaymentRequest` - 支払依頼\n* `ApprovalRequest` - 各種申請\n* `DocApproval` - 請求書等 (見積書・納品書・請求書・発注書)", "items": { "type": "string", "enum": [ "TxnApproval", "ExpenseApplication", "PaymentRequest", "ApprovalRequest", "DocApproval" ], "example": "TxnApproval" } }, "request_form_ids": { "type": "array", "description": "申請経路で利用できる申請フォームID配列", "items": { "type": "integer", "format": "int64", "description": "申請フォームID", "example": 1 } }, "steps": { "type": "array", "description": "承認ステップ（配列）", "items": { "type": "object", "required": [ "id", "next_step_id", "resource_type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "承認ステップID", "example": 1 }, "next_step_id": { "type": "integer", "format": "int64", "description": "次の承認ステップID", "nullable": true, "example": 2 }, "resource_type": { "type": "string", "description": "承認方法( predefined_user: メンバー指定 (1人), selected_user: 申請時にメンバー指定,unspecified: 指定なし, and_resource: メンバー指定 (複数、全員の承認), or_resource: メンバー指定 (複数、1人の承認), and_position: 役職指定 (複数、全員の承認), or_position: 役職指定 (複数、1人の承認) ) ", "enum": [ "predefined_user", "selected_user", "unspecified", "and_resource", "or_resource", "and_position", "or_position" ], "example": "predefined_user" }, "user_ids": { "type": "array", "description": "承認者のユーザーID (配列)", "items": { "type": "integer", "format": "int64", "description": "承認者のユーザーID", "example": 3 } } } } } } } } }, "segment_tag": { "type": "object", "required": [ "description", "id", "name", "shortcut1", "shortcut2" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "セグメントタグID", "example": 1 }, "name": { "type": "string", "description": "セグメントタグ名", "example": "プロジェクトA" }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "A", "nullable": true }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "123", "nullable": true } } }, "segmentTagResponse": { "type": "object", "required": [ "segment_tag" ], "properties": { "segment_tag": { "$ref": "#/components/schemas/segment_tag" } } }, "segmentTagParams": { "type": "object", "required": [ "company_id", "name" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "name": { "maxLength": 30, "type": "string", "description": "セグメントタグ名 (30文字以内)", "example": "プロジェクトA" }, "description": { "maxLength": 30, "type": "string", "description": "備考 (30文字以内)", "example": "備考" }, "shortcut1": { "type": "string", "maxLength": 20, "description": "ショートカット１ (20文字以内)", "example": "A" }, "shortcut2": { "type": "string", "maxLength": 20, "description": "ショートカット２ (20文字以内)", "example": "123" } } }, "invoiceIndexResponse": { "type": "object", "required": [ "invoices" ], "properties": { "invoices": { "type": "array", "items": { "type": "object", "required": [ "company_id", "company_name", "id", "invoice_layout", "invoice_number", "invoice_status", "issue_date", "partner_id", "payment_type", "posting_status", "tax_entry_method", "total_amount", "total_amount_per_vat_rate" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "請求書ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "請求日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "invoice_number": { "type": "string", "description": "請求書番号", "example": "A001" }, "title": { "type": "string", "description": "タイトル", "example": "請求書", "nullable": true }, "due_date": { "type": "string", "description": "期日 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 108000 }, "total_vat": { "type": "integer", "format": "int64", "description": "消費税", "example": 8000 }, "sub_total": { "type": "integer", "format": "int64", "description": "小計", "example": 100000 }, "booking_date": { "type": "string", "description": "売上計上日", "example": "2019-12-17", "nullable": true }, "description": { "type": "string", "description": "概要", "example": "８月分請求書", "nullable": true }, "invoice_status": { "type": "string", "description": "請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, submitted: 送付済み, unsubmitted: 請求書の承認フローが無効の場合のみ、unsubmitted（送付待ち）の値をとります)", "enum": [ "draft", "applying", "remanded", "rejected", "approved", "submitted", "unsubmitted" ] }, "payment_status": { "type": "string", "description": "入金ステータス (unsettled: 入金待ち, settled: 入金済み)", "enum": [ "", "unsettled", "settled" ] }, "payment_date": { "type": "string", "description": "入金日", "example": "2019-12-17", "nullable": true }, "web_published_at": { "type": "string", "description": "Web共有日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_downloaded_at": { "type": "string", "description": "Web共有ダウンロード日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_confirmed_at": { "type": "string", "description": "Web共有取引先確認日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "mail_sent_at": { "type": "string", "description": "メール送信日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "posting_status": { "type": "string", "description": "郵送ステータス(unrequested: リクエスト前, preview_registered: プレビュー登録, preview_failed: プレビュー登録失敗, ordered: 注文中, order_failed: 注文失敗, printing: 印刷中, canceled: キャンセル, posted: 投函済み)", "example": "unrequested", "enum": [ "", "unrequested", "preview_registered", "preview_failed", "ordered", "order_failed", "printing", "canceled", "posted" ] }, "partner_name": { "type": "string", "description": "取引先名", "example": "freeeパートナー", "nullable": true }, "partner_display_name": { "type": "string", "description": "請求書に表示する取引先名", "example": "株式会社freeeパートナー", "nullable": true }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "partner_prefecture_name": { "type": "string", "description": "都道府県", "example": "秋田県", "nullable": true }, "partner_address1": { "type": "string", "description": "市区町村・番地", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "Aビル", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "company_name": { "type": "string", "description": "事業所名", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "company_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 12, "nullable": true }, "company_prefecture_name": { "type": "string", "description": "都道府県", "example": "東京都", "nullable": true }, "company_address1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＸＸ１−１−１", "nullable": true }, "company_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル1F", "nullable": true }, "company_contact_info": { "type": "string", "description": "事業所担当者名", "example": "法人営業担当", "nullable": true }, "payment_type": { "type": "string", "description": "支払方法 (振込: transfer, 引き落とし: direct_debit)", "example": "transfer", "enum": [ "", "transfer", "direct_debit" ] }, "payment_bank_info": { "type": "string", "description": "支払口座", "example": "ＸＸ銀行ＹＹ支店1111111", "nullable": true }, "message": { "type": "string", "description": "メッセージ", "example": "下記の通りご請求申し上げます。", "nullable": true }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます", "nullable": true }, "invoice_layout": { "type": "string", "description": "請求書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `carried_forward_standard_classic` - レイアウト３（繰越金額欄あり）/クラシック\n\n* `carried_forward_envelope_classic` - 封筒２（繰越金額欄あり）/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "carried_forward_standard_classic", "carried_forward_envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "請求書の消費税計算方法(inclusive: 内税, exclusive: 外税)", "example": "exclusive", "enum": [ "", "inclusive", "exclusive" ] }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (invoice_statusがsubmitted, unsubmittedの時IDが表示されます)", "nullable": true, "example": 1 }, "invoice_contents": { "type": "array", "description": "請求内容", "items": { "type": "object", "required": [ "account_item_id", "account_item_name", "amount", "description", "id", "item_id", "item_name", "order", "qty", "reduced_vat", "section_id", "section_name", "tag_ids", "tag_names", "tax_code", "type", "unit", "unit_price", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "請求内容ID", "example": 1 }, "order": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 1, "nullable": true }, "type": { "type": "string", "description": "行の種類", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個", "nullable": true }, "unit_price": { "type": "number", "description": "単価", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "内税/外税の判別とamountの税込み、税抜きについて\n\n", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 8000 }, "reduced_vat": { "type": "boolean", "description": "軽減税率税区分（true: 対象、false: 対象外）", "example": true }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "売上", "nullable": true }, "tax_code": { "type": "integer", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1, "nullable": true }, "item_id": { "type": "integer", "description": "品目ID", "example": 1, "nullable": true }, "item_name": { "type": "string", "description": "品目", "example": "freee会計", "nullable": true }, "section_id": { "type": "integer", "description": "部門ID", "example": 1, "nullable": true }, "section_name": { "type": "string", "description": "部門", "example": "開発部", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "tag_names": { "type": "array", "items": { "type": "string", "description": "メモタグ", "example": "メモタグ" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_1_tag_name": { "type": "string", "description": "セグメント１", "example": "セグメント１", "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_2_tag_name": { "type": "string", "description": "セグメント２", "example": "セグメント２", "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "segment_3_tag_name": { "type": "string", "description": "セグメント３", "example": "セグメント３", "nullable": true } } } }, "total_amount_per_vat_rate": { "type": "object", "required": [ "reduced_vat_8", "vat_10", "vat_5", "vat_8" ], "properties": { "vat_5": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率5%の税込み金額合計", "example": 0 }, "vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率8%の税込み金額合計", "example": 108000 }, "reduced_vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "軽減税率8%の税込み金額合計", "example": 0 }, "vat_10": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率10%の税込み金額合計", "example": 0 } } } } } } } }, "invoiceResponse": { "type": "object", "required": [ "invoice" ], "properties": { "invoice": { "type": "object", "required": [ "company_id", "company_name", "id", "invoice_layout", "invoice_number", "invoice_status", "issue_date", "partner_id", "payment_type", "posting_status", "tax_entry_method", "total_amount", "total_amount_per_vat_rate" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "請求書ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "請求日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "invoice_number": { "type": "string", "description": "請求書番号", "example": "A001" }, "title": { "type": "string", "description": "タイトル", "example": "請求書", "nullable": true }, "due_date": { "type": "string", "description": "期日 (yyyy-mm-dd)", "example": "2019-12-17", "nullable": true }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 108000 }, "total_vat": { "type": "integer", "format": "int64", "description": "消費税", "example": 8000 }, "sub_total": { "type": "integer", "format": "int64", "description": "小計", "example": 100000 }, "booking_date": { "type": "string", "description": "売上計上日", "example": "2019-12-17", "nullable": true }, "description": { "type": "string", "description": "概要", "example": "８月分請求書", "nullable": true }, "invoice_status": { "type": "string", "description": "請求書ステータス (draft: 下書き, applying: 申請中, remanded: 差し戻し, rejected: 却下, approved: 承認済み, submitted: 送付済み, unsubmitted: 請求書の承認フローが無効の場合のみ、unsubmitted（送付待ち）の値をとります)", "enum": [ "draft", "applying", "remanded", "rejected", "approved", "submitted", "unsubmitted" ] }, "payment_status": { "type": "string", "description": "入金ステータス (unsettled: 入金待ち, settled: 入金済み)", "enum": [ "", "unsettled", "settled" ] }, "payment_date": { "type": "string", "description": "入金日", "example": "2019-12-17", "nullable": true }, "web_published_at": { "type": "string", "description": "Web共有日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_downloaded_at": { "type": "string", "description": "Web共有ダウンロード日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_confirmed_at": { "type": "string", "description": "Web共有取引先確認日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "mail_sent_at": { "type": "string", "description": "メール送信日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "posting_status": { "type": "string", "description": "郵送ステータス(unrequested: リクエスト前, preview_registered: プレビュー登録, preview_failed: プレビュー登録失敗, ordered: 注文中, order_failed: 注文失敗, printing: 印刷中, canceled: キャンセル, posted: 投函済み)", "example": "unrequested", "enum": [ "", "unrequested", "preview_registered", "preview_failed", "ordered", "order_failed", "printing", "canceled", "posted" ] }, "partner_name": { "type": "string", "description": "取引先名", "example": "freeeパートナー", "nullable": true }, "partner_display_name": { "type": "string", "description": "請求書に表示する取引先名", "example": "株式会社freeeパートナー", "nullable": true }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "partner_prefecture_name": { "type": "string", "description": "都道府県", "example": "秋田県", "nullable": true }, "partner_address1": { "type": "string", "description": "市区町村・番地", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "Aビル", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "company_name": { "type": "string", "description": "事業所名", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "company_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 12, "nullable": true }, "company_prefecture_name": { "type": "string", "description": "都道府県", "example": "東京都", "nullable": true }, "company_address1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＸＸ１−１−１", "nullable": true }, "company_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル1F", "nullable": true }, "company_contact_info": { "type": "string", "description": "事業所担当者名", "example": "法人営業担当", "nullable": true }, "payment_type": { "type": "string", "description": "支払方法 (振込: transfer, 引き落とし: direct_debit)", "example": "transfer", "enum": [ "", "transfer", "direct_debit" ] }, "payment_bank_info": { "type": "string", "description": "支払口座", "example": "ＸＸ銀行ＹＹ支店1111111", "nullable": true }, "message": { "type": "string", "description": "メッセージ", "example": "下記の通りご請求申し上げます。", "nullable": true }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます", "nullable": true }, "invoice_layout": { "type": "string", "description": "請求書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `carried_forward_standard_classic` - レイアウト３（繰越金額欄あり）/クラシック\n\n* `carried_forward_envelope_classic` - 封筒２（繰越金額欄あり）/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "carried_forward_standard_classic", "carried_forward_envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "請求書の消費税計算方法(inclusive: 内税, exclusive: 外税)", "example": "exclusive", "enum": [ "", "inclusive", "exclusive" ] }, "deal_id": { "type": "integer", "format": "int64", "description": "取引ID (invoice_statusがsubmitted, unsubmittedの時IDが表示されます)", "nullable": true, "example": 1 }, "invoice_contents": { "type": "array", "description": "請求内容", "items": { "type": "object", "required": [ "account_item_id", "account_item_name", "amount", "description", "id", "item_id", "item_name", "order", "qty", "reduced_vat", "section_id", "section_name", "tag_ids", "tag_names", "tax_code", "type", "unit", "unit_price", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "請求内容ID", "example": 1 }, "order": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 1, "nullable": true }, "type": { "type": "string", "description": "行の種類", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個", "nullable": true }, "unit_price": { "type": "number", "description": "単価", "example": 1 }, "amount": { "type": "integer", "format": "int64", "minimum": -9223372036854775808, "maximum": 9223372036854775807, "description": "内税/外税の判別とamountの税込み、税抜きについて\n\n", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 8000 }, "reduced_vat": { "type": "boolean", "description": "軽減税率税区分（true: 対象、false: 対象外）", "example": true }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "売上", "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1, "nullable": true }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "item_name": { "type": "string", "description": "品目", "example": "freee会計", "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "section_name": { "type": "string", "description": "部門", "example": "開発部", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "tag_names": { "type": "array", "items": { "type": "string", "description": "メモタグ", "example": "メモタグ" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_1_tag_name": { "type": "string", "description": "セグメント１", "example": "セグメント１", "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_2_tag_name": { "type": "string", "description": "セグメント２", "example": "セグメント２", "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "segment_3_tag_name": { "type": "string", "description": "セグメント３", "example": "セグメント３", "nullable": true } } } }, "total_amount_per_vat_rate": { "type": "object", "required": [ "reduced_vat_8", "vat_10", "vat_5", "vat_8" ], "properties": { "vat_5": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率5%の税込み金額合計", "example": 0 }, "vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率8%の税込み金額合計", "example": 108000 }, "reduced_vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "軽減税率8%の税込み金額合計", "example": 0 }, "vat_10": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率10%の税込み金額合計", "example": 0 } } }, "related_quotation_ids": { "type": "array", "description": "関連する見積書ID(配列)
\n下記で作成したものが該当します。\n\n見積書・納品書を納品書・請求書に変換する
\n複数の見積書・納品書から合算請求書を作成する
\n", "items": { "type": "integer", "format": "int64", "description": "関連する見積書ID", "example": 3 } } } } } }, "invoiceCreateParams": { "type": "object", "required": [ "company_id", "partner_display_name", "partner_title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "請求日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "nullable": true, "description": "取引先ID", "example": 201 }, "partner_code": { "type": "string", "nullable": true, "description": "取引先コード", "example": "code001" }, "invoice_number": { "type": "string", "description": "請求書番号 (デフォルト: 自動採番されます)", "example": "A001" }, "title": { "type": "string", "description": "タイトル (デフォルト: 請求書)", "example": "請求書" }, "due_date": { "type": "string", "description": "期日 (yyyy-mm-dd)", "example": "2019-12-17" }, "booking_date": { "type": "string", "description": "売上計上日", "example": "2019-12-17" }, "description": { "type": "string", "description": "概要", "example": "８月分請求書" }, "invoice_status": { "type": "string", "description": "請求書ステータス
\n\nissue, unsubmitted, submitted は請求書承認ワークフローを利用している場合は指定できません。\n", "enum": [ "draft", "issue", "unsubmitted", "submitted" ] }, "partner_display_name": { "type": "string", "description": "請求書に表示する取引先名", "example": "株式会社freeeパートナー" }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "partner_zipcode": { "type": "string", "description": "取引先郵便番号 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "012-0009", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "取引先都道府県コード（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で指定された取引先設定情報が補完されます)", "example": 4, "nullable": true }, "partner_address1": { "type": "string", "description": "取引先市区町村・番地 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "取引先建物名・部屋番号など (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "Aビル", "nullable": true }, "company_name": { "type": "string", "description": "事業所名 (デフォルトは事業所設定情報が補完されます)", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号 (デフォルトは事業所設定情報が補完されます)", "example": "000-0000" }, "company_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "都道府県コード（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:沖縄) (デフォルトは事業所設定情報が補完されます)", "example": 12 }, "company_address1": { "type": "string", "description": "市区町村・番地 (デフォルトは事業所設定情報が補完されます)", "example": "ＸＸ区ＹＹ１−１−１" }, "company_address2": { "type": "string", "description": "建物名・部屋番号など (デフォルトは事業所設定情報が補完されます)", "example": "ビル 1F" }, "company_contact_info": { "type": "string", "description": "事業所担当者名 (デフォルトは請求書テンプレート情報が補完されます)", "example": "法人営業担当" }, "payment_type": { "type": "string", "description": "支払方法 (振込: transfer, 引き落とし: direct_debit)", "example": "transfer", "enum": [ "transfer", "direct_debit" ] }, "payment_bank_info": { "type": "string", "description": "支払口座", "example": "ＸＸ銀行ＹＹ支店 1111111" }, "use_virtual_transfer_account": { "type": "string", "description": "振込専用口座の利用(利用しない: not_use(デフォルト), 利用する: use)", "example": "use", "enum": [ "not_use", "use" ] }, "message": { "type": "string", "description": "メッセージ (デフォルト: 下記の通りご請求申し上げます。)", "example": "下記の通りご請求申し上げます。" }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます" }, "invoice_layout": { "type": "string", "description": "請求書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `carried_forward_standard_classic` - レイアウト３（繰越金額欄あり）/クラシック\n\n* `carried_forward_envelope_classic` - 封筒２（繰越金額欄あり）/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "carried_forward_standard_classic", "carried_forward_envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "請求書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト))", "example": "exclusive", "enum": [ "inclusive", "exclusive" ] }, "invoice_contents": { "type": "array", "description": "請求内容", "items": { "required": [ "order", "type" ], "type": "object", "properties": { "order": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 0 }, "type": { "type": "string", "description": "行の種類\n", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "minimum": 0, "maximum": 99999999, "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個" }, "unit_price": { "type": "number", "minimum": -999999999999, "maximum": 999999999999, "description": "単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります)", "example": 1 }, "vat": { "type": "integer", "format": "int64", "nullable": true, "description": "消費税額", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 } } } } } }, "invoiceUpdateParams": { "type": "object", "required": [ "company_id", "partner_display_name", "partner_title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "請求日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "nullable": true, "description": "取引先ID", "example": 201 }, "partner_code": { "type": "string", "nullable": true, "description": "取引先コード", "example": "code001" }, "invoice_number": { "type": "string", "description": "請求書番号 (デフォルト: 自動採番されます)", "example": "A001" }, "title": { "type": "string", "description": "タイトル (デフォルト: 請求書)", "example": "請求書" }, "due_date": { "type": "string", "description": "期日 (yyyy-mm-dd)", "example": "2019-12-17" }, "booking_date": { "type": "string", "description": "売上計上日", "example": "2019-12-17" }, "description": { "type": "string", "description": "概要", "example": "８月分請求書" }, "invoice_status": { "type": "string", "description": "請求書ステータス
\n\nissue, unsubmitted は請求書承認ワークフローを利用している場合は、承認済みの請求書にのみ指定できます。
\nsubmitted は請求書承認ワークフローを利用している場合は、送付待ちの請求書にのみ指定できます。\n", "enum": [ "draft", "issue", "unsubmitted", "submitted" ] }, "partner_display_name": { "type": "string", "description": "請求書に表示する取引先名", "example": "株式会社freeeパートナー" }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "partner_zipcode": { "type": "string", "description": "取引先郵便番号 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "012-0009", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "取引先都道府県コード（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で指定された取引先設定情報が補完されます)", "example": 4, "nullable": true }, "partner_address1": { "type": "string", "description": "取引先市区町村・番地 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "取引先建物名・部屋番号など (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "Aビル", "nullable": true }, "company_name": { "type": "string", "description": "事業所名 (デフォルトは事業所設定情報が補完されます)", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号 (デフォルトは事業所設定情報が補完されます)", "example": "000-0000" }, "company_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "都道府県コード（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:沖縄) (デフォルトは事業所設定情報が補完されます)", "example": 12 }, "company_address1": { "type": "string", "description": "市区町村・番地 (デフォルトは事業所設定情報が補完されます)", "example": "ＸＸ区ＹＹ１−１−１" }, "company_address2": { "type": "string", "description": "建物名・部屋番号など (デフォルトは事業所設定情報が補完されます)", "example": "ビル 1F" }, "company_contact_info": { "type": "string", "description": "事業所担当者名 (デフォルトは請求書テンプレート情報が補完されます)", "example": "法人営業担当" }, "payment_type": { "type": "string", "description": "支払方法 (振込: transfer, 引き落とし: direct_debit)", "example": "transfer", "enum": [ "transfer", "direct_debit" ] }, "payment_bank_info": { "type": "string", "description": "支払口座", "example": "ＸＸ銀行ＹＹ支店 1111111" }, "use_virtual_transfer_account": { "type": "string", "description": "振込専用口座の利用(利用しない: not_use(デフォルト), 利用する: use)", "example": "use", "enum": [ "not_use", "use" ] }, "message": { "type": "string", "description": "メッセージ (デフォルト: 下記の通りご請求申し上げます。)", "example": "下記の通りご請求申し上げます。" }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます" }, "invoice_layout": { "type": "string", "description": "請求書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `carried_forward_standard_classic` - レイアウト３（繰越金額欄あり）/クラシック\n\n* `carried_forward_envelope_classic` - 封筒２（繰越金額欄あり）/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "carried_forward_standard_classic", "carried_forward_envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "請求書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト))", "example": "exclusive", "enum": [ "inclusive", "exclusive" ] }, "invoice_contents": { "type": "array", "description": "請求内容", "items": { "type": "object", "required": [ "order", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "請求内容ID", "example": 1 }, "order": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 0 }, "type": { "type": "string", "description": "行の種類\n", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "minimum": 0, "maximum": 99999999, "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個" }, "unit_price": { "type": "number", "minimum": -999999999999, "maximum": 999999999999, "description": "単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります)", "example": 1 }, "vat": { "type": "integer", "format": "int64", "nullable": true, "description": "消費税額", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 } } } } } }, "quotationIndexResponse": { "type": "object", "required": [ "quotations" ], "properties": { "quotations": { "type": "array", "items": { "type": "object", "required": [ "company_id", "company_name", "id", "quotation_layout", "quotation_number", "quotation_status", "issue_date", "partner_id", "partner_title", "tax_entry_method", "total_amount", "total_amount_per_vat_rate" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "見積書ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "見積日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "quotation_number": { "type": "string", "description": "見積書番号", "example": "A001" }, "title": { "type": "string", "description": "タイトル", "example": "見積書", "nullable": true }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 108000 }, "total_vat": { "type": "integer", "format": "int64", "description": "消費税", "example": 8000 }, "sub_total": { "type": "integer", "format": "int64", "description": "小計", "example": 100000 }, "description": { "type": "string", "description": "概要", "example": "８月分見積書", "nullable": true }, "quotation_status": { "type": "string", "description": "見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て)", "enum": [ "unsubmitted", "submitted", "all" ] }, "web_published_at": { "type": "string", "description": "Web共有日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_downloaded_at": { "type": "string", "description": "Web共有ダウンロード日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_confirmed_at": { "type": "string", "description": "Web共有取引先確認日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "mail_sent_at": { "type": "string", "description": "メール送信日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "partner_name": { "type": "string", "description": "取引先名", "example": "freeeパートナー", "nullable": true }, "partner_display_name": { "type": "string", "description": "見積書に表示する取引先名", "example": "株式会社freeeパートナー", "nullable": true }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "partner_prefecture_name": { "type": "string", "description": "都道府県", "example": "秋田県", "nullable": true }, "partner_address1": { "type": "string", "description": "市区町村・番地", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "Aビル", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "company_name": { "type": "string", "description": "事業所名", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "company_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 12, "nullable": true }, "company_prefecture_name": { "type": "string", "description": "都道府県", "example": "東京都", "nullable": true }, "company_address1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＸＸ１−１−１", "nullable": true }, "company_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル1F", "nullable": true }, "company_contact_info": { "type": "string", "description": "事業所担当者名", "example": "法人営業担当", "nullable": true }, "message": { "type": "string", "description": "メッセージ", "example": "下記の通り御見積もり申し上げます。", "nullable": true }, "notes": { "type": "string", "description": "備考", "example": "毎度お世話になっております。", "nullable": true }, "quotation_layout": { "type": "string", "description": "見積書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "見積書の消費税計算方法(inclusive: 内税, exclusive: 外税)", "example": "exclusive", "enum": [ "", "inclusive", "exclusive" ] }, "quotation_contents": { "type": "array", "description": "見積内容", "items": { "type": "object", "required": [ "account_item_id", "account_item_name", "amount", "description", "id", "item_id", "item_name", "order", "qty", "reduced_vat", "section_id", "section_name", "tag_ids", "tag_names", "tax_code", "type", "unit", "unit_price", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "見積内容ID", "example": 1 }, "order": { "type": "integer", "format": "int64", "description": "順序", "example": 1 }, "type": { "type": "string", "description": "行の種類", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個", "nullable": true }, "unit_price": { "type": "number", "description": "単価", "example": 1 }, "amount": { "type": "integer", "format": "int64", "description": "内税/外税の判別とamountの税込み、税抜きについて\n\n", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 8000 }, "reduced_vat": { "type": "boolean", "description": "軽減税率税区分（true: 対象、false: 対象外）", "example": true }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "売上", "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "description": "税区分コード", "example": 1, "nullable": true }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "item_name": { "type": "string", "description": "品目", "example": "freee会計", "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "section_name": { "type": "string", "description": "部門", "example": "開発部", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "description": "メモタグID", "example": 1 } }, "tag_names": { "type": "array", "items": { "type": "string", "description": "メモタグ", "example": "メモタグ" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_1_tag_name": { "type": "string", "description": "セグメント１", "example": "セグメント１", "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_2_tag_name": { "type": "string", "description": "セグメント２", "example": "セグメント２", "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "segment_3_tag_name": { "type": "string", "description": "セグメント３", "example": "セグメント３", "nullable": true } } } }, "total_amount_per_vat_rate": { "type": "object", "required": [ "reduced_vat_8", "vat_10", "vat_5", "vat_8" ], "properties": { "vat_5": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率5%の税込み金額合計", "example": 0 }, "vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率8%の税込み金額合計", "example": 108000 }, "reduced_vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "軽減税率8%の税込み金額合計", "example": 0 }, "vat_10": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率10%の税込み金額合計", "example": 0 } } } } } } } }, "quotationResponse": { "type": "object", "required": [ "quotation" ], "properties": { "quotation": { "type": "object", "required": [ "company_id", "company_name", "id", "quotation_layout", "quotation_number", "quotation_status", "issue_date", "partner_id", "partner_title", "tax_entry_method", "total_amount", "total_amount_per_vat_rate" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "見積書ID", "example": 101 }, "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "見積日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "description": "取引先ID", "example": 201, "nullable": true }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001", "nullable": true }, "quotation_number": { "type": "string", "description": "見積書番号", "example": "A001" }, "title": { "type": "string", "description": "タイトル", "example": "見積書", "nullable": true }, "total_amount": { "type": "integer", "format": "int64", "description": "合計金額", "example": 108000 }, "total_vat": { "type": "integer", "format": "int64", "description": "消費税", "example": 8000 }, "sub_total": { "type": "integer", "format": "int64", "description": "小計", "example": 100000 }, "description": { "type": "string", "description": "概要", "example": "８月分見積書", "nullable": true }, "quotation_status": { "type": "string", "description": "見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み, all: 全て)", "enum": [ "unsubmitted", "submitted", "all" ] }, "web_published_at": { "type": "string", "description": "Web共有日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_downloaded_at": { "type": "string", "description": "Web共有ダウンロード日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "web_confirmed_at": { "type": "string", "description": "Web共有取引先確認日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "mail_sent_at": { "type": "string", "description": "メール送信日時(最新)", "example": "2019-12-17T19:00:00+09:00", "nullable": true }, "partner_name": { "type": "string", "description": "取引先名", "example": "freeeパートナー", "nullable": true }, "partner_display_name": { "type": "string", "description": "見積書に表示する取引先名", "example": "株式会社freeeパートナー", "nullable": true }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中", "nullable": true }, "partner_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "partner_prefecture_name": { "type": "string", "description": "都道府県", "example": "秋田県", "nullable": true }, "partner_address1": { "type": "string", "description": "市区町村・番地", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "Aビル", "nullable": true }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "company_name": { "type": "string", "description": "事業所名", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号", "example": "000-0000", "nullable": true }, "company_prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 12, "nullable": true }, "company_prefecture_name": { "type": "string", "description": "都道府県", "example": "東京都", "nullable": true }, "company_address1": { "type": "string", "description": "市区町村・番地", "example": "ＸＸ区ＸＸ１−１−１", "nullable": true }, "company_address2": { "type": "string", "description": "建物名・部屋番号など", "example": "ビル1F", "nullable": true }, "company_contact_info": { "type": "string", "description": "事業所担当者名", "example": "法人営業担当", "nullable": true }, "message": { "type": "string", "description": "メッセージ", "example": "下記の通り御見積もり申し上げます。", "nullable": true }, "notes": { "type": "string", "description": "備考", "example": "毎度お世話になっております。", "nullable": true }, "quotation_layout": { "type": "string", "description": "見積書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "見積書の消費税計算方法(inclusive: 内税, exclusive: 外税)", "example": "exclusive", "enum": [ "", "inclusive", "exclusive" ] }, "quotation_contents": { "type": "array", "description": "見積内容", "items": { "type": "object", "required": [ "account_item_id", "account_item_name", "amount", "description", "id", "item_id", "item_name", "order", "qty", "reduced_vat", "section_id", "section_name", "tag_ids", "tag_names", "tax_code", "type", "unit", "unit_price", "vat" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "見積内容ID", "example": 1 }, "order": { "type": "integer", "format": "int64", "description": "順序", "example": 1 }, "type": { "type": "string", "description": "行の種類", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個", "nullable": true }, "unit_price": { "type": "number", "description": "単価", "example": 1 }, "amount": { "type": "integer", "format": "int64", "description": "内税/外税の判別とamountの税込み、税抜きについて\n\n", "example": 108000 }, "vat": { "type": "integer", "format": "int64", "description": "消費税額", "example": 8000 }, "reduced_vat": { "type": "boolean", "description": "軽減税率税区分（true: 対象、false: 対象外）", "example": true }, "description": { "type": "string", "description": "備考", "example": "備考", "nullable": true }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1, "nullable": true }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "売上", "nullable": true }, "tax_code": { "type": "integer", "format": "int64", "description": "税区分コード", "example": 1, "nullable": true }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1, "nullable": true }, "item_name": { "type": "string", "description": "品目", "example": "freee会計", "nullable": true }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1, "nullable": true }, "section_name": { "type": "string", "description": "部門", "example": "開発部", "nullable": true }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "tag_names": { "type": "array", "items": { "type": "string", "description": "メモタグ", "example": "メモタグ" } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1, "nullable": true }, "segment_1_tag_name": { "type": "string", "description": "セグメント１", "example": "セグメント１", "nullable": true }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1, "nullable": true }, "segment_2_tag_name": { "type": "string", "description": "セグメント２", "example": "セグメント２", "nullable": true }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1, "nullable": true }, "segment_3_tag_name": { "type": "string", "description": "セグメント３", "example": "セグメント３", "nullable": true } } } }, "total_amount_per_vat_rate": { "type": "object", "required": [ "reduced_vat_8", "vat_10", "vat_5", "vat_8" ], "properties": { "vat_5": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率5%の税込み金額合計", "example": 0 }, "vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率8%の税込み金額合計", "example": 108000 }, "reduced_vat_8": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "軽減税率8%の税込み金額合計", "example": 0 }, "vat_10": { "type": "integer", "format": "int64", "maximum": 9223372036854775807, "description": "税率10%の税込み金額合計", "example": 0 } } }, "related_invoice_id": { "type": "integer", "format": "int64", "description": "関連する請求書ID
\n下記で作成したものが該当します。\n\n見積書・納品書を納品書・請求書に変換する
\n複数の見積書・納品書から合算請求書を作成する
\n", "example": 1, "nullable": true }, "related_quotation_ids": { "type": "array", "description": "関連する見積書ID(配列)
\n下記で作成したものが該当します。\n\n見積書・納品書を納品書・請求書に変換する
\n複数の見積書・納品書から合算請求書を作成する
\n", "example": 1, "items": { "type": "integer", "format": "int64", "description": "関連する見積書ID", "example": 3 } } } } } }, "quotationCreateParams": { "type": "object", "required": [ "company_id", "partner_display_name", "partner_title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "見積日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "nullable": true, "description": "取引先ID", "example": 201 }, "partner_code": { "type": "string", "nullable": true, "description": "取引先コード", "example": "code001" }, "quotation_number": { "type": "string", "description": "見積書番号 (デフォルト: 自動採番されます)", "example": "A001" }, "title": { "type": "string", "description": "タイトル (デフォルト: 見積書)", "example": "見積書" }, "description": { "type": "string", "description": "概要", "example": "８月分見積書" }, "quotation_status": { "type": "string", "description": "見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み) (請求書承認ワークフローを利用している場合、unsubmitted を指定すると、下書きの見積書が作成されます)", "enum": [ "unsubmitted", "submitted" ] }, "partner_display_name": { "type": "string", "description": "見積書に表示する取引先名", "example": "freeeパートナー株式会社" }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中" }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "partner_zipcode": { "type": "string", "description": "取引先郵便番号 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "012-0009", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "取引先都道府県コード（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で指定された取引先設定情報が補完されます)", "example": 4, "nullable": true }, "partner_address1": { "type": "string", "description": "取引先市区町村・番地 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "取引先建物名・部屋番号など (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "Aビル", "nullable": true }, "company_name": { "type": "string", "description": "事業所名 (デフォルトは事業所設定情報が補完されます)", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号 (デフォルトは事業所設定情報が補完されます)", "example": "000-0000" }, "company_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "都道府県コード（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:沖縄) (デフォルトは事業所設定情報が補完されます)", "example": 12 }, "company_address1": { "type": "string", "description": "市区町村・番地 (デフォルトは事業所設定情報が補完されます)", "example": "ＸＸ区ＹＹ１−１−１" }, "company_address2": { "type": "string", "description": "建物名・部屋番号など (デフォルトは事業所設定情報が補完されます)", "example": "ビル1F" }, "company_contact_info": { "type": "string", "description": "事業所担当者名 (デフォルトは見積書テンプレート情報が補完されます)", "example": "法人営業担当" }, "message": { "type": "string", "description": "メッセージ (デフォルト: 下記の通り御見積申し上げます。)", "example": "下記の通り御見積申し上げます。" }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます" }, "quotation_layout": { "type": "string", "description": "見積書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "見積書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト))", "example": "exclusive", "enum": [ "inclusive", "exclusive" ] }, "quotation_contents": { "type": "array", "description": "見積内容", "items": { "type": "object", "required": [ "order", "type" ], "properties": { "order": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 0 }, "type": { "type": "string", "description": "行の種類\n", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "minimum": 0, "maximum": 99999999, "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個" }, "unit_price": { "type": "number", "minimum": -999999999999, "maximum": 999999999999, "description": "単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります)", "example": 1 }, "vat": { "type": "integer", "format": "int64", "nullable": true, "description": "消費税額", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 } } } } } }, "quotationUpdateParams": { "type": "object", "required": [ "company_id", "partner_display_name", "partner_title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "issue_date": { "type": "string", "description": "見積日 (yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "nullable": true, "description": "取引先ID", "example": 201 }, "partner_code": { "type": "string", "nullable": true, "description": "取引先コード", "example": "code001" }, "quotation_number": { "type": "string", "description": "見積書番号 (デフォルト: 自動採番されます)", "example": "A001" }, "title": { "type": "string", "description": "タイトル (デフォルト: 見積書)", "example": "見積書" }, "description": { "type": "string", "description": "概要", "example": "８月分見積書" }, "quotation_status": { "type": "string", "description": "見積書ステータス (unsubmitted: 送付待ち, submitted: 送付済み) (請求書承認ワークフローを利用している場合、unsubmitted を指定すると、下書きの見積書が作成されます)", "enum": [ "unsubmitted", "submitted" ] }, "partner_display_name": { "type": "string", "description": "見積書に表示する取引先名", "example": "freeeパートナー株式会社" }, "partner_title": { "type": "string", "description": "敬称（御中、様、(空白)の3つから選択）", "example": "御中" }, "partner_contact_info": { "type": "string", "description": "取引先担当者名", "example": "営業担当", "nullable": true }, "partner_zipcode": { "type": "string", "description": "取引先郵便番号 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "012-0009", "nullable": true }, "partner_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "取引先都道府県コード（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で指定された取引先設定情報が補完されます)", "example": 4, "nullable": true }, "partner_address1": { "type": "string", "description": "取引先市区町村・番地 (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "湯沢市", "nullable": true }, "partner_address2": { "type": "string", "description": "取引先建物名・部屋番号など (デフォルトはpartner_idもしくはpartner_codeで指定された取引先設定情報が補完されます)", "example": "Aビル", "nullable": true }, "company_name": { "type": "string", "description": "事業所名 (デフォルトは事業所設定情報が補完されます)", "example": "freee株式会社" }, "company_zipcode": { "type": "string", "description": "郵便番号 (デフォルトは事業所設定情報が補完されます)", "example": "000-0000" }, "company_prefecture_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 46, "description": "都道府県コード（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:沖縄) (デフォルトは事業所設定情報が補完されます)", "example": 12 }, "company_address1": { "type": "string", "description": "市区町村・番地 (デフォルトは事業所設定情報が補完されます)", "example": "ＸＸ区ＹＹ１−１−１" }, "company_address2": { "type": "string", "description": "建物名・部屋番号など (デフォルトは事業所設定情報が補完されます)", "example": "ビル1F" }, "company_contact_info": { "type": "string", "description": "事業所担当者名 (デフォルトは見積書テンプレート情報が補完されます)", "example": "法人営業担当" }, "message": { "type": "string", "description": "メッセージ (デフォルト: 下記の通り御見積申し上げます。)", "example": "下記の通り御見積申し上げます。" }, "notes": { "type": "string", "description": "備考", "example": "毎度ありがとうございます" }, "quotation_layout": { "type": "string", "description": "見積書レイアウト\n* `default_classic` - レイアウト１/クラシック (デフォルト)\n\n* `standard_classic` - レイアウト２/クラシック\n\n* `envelope_classic` - 封筒１/クラシック\n\n* `default_modern` - レイアウト１/モダン\n\n* `standard_modern` - レイアウト２/モダン\n\n* `envelope_modern` - 封筒/モダン", "example": "default_classic", "enum": [ "default_classic", "standard_classic", "envelope_classic", "default_modern", "standard_modern", "envelope_modern" ] }, "tax_entry_method": { "type": "string", "description": "見積書の消費税計算方法(inclusive: 内税表示, exclusive: 外税表示 (デフォルト))", "example": "exclusive", "enum": [ "inclusive", "exclusive" ] }, "quotation_contents": { "type": "array", "description": "見積内容", "items": { "type": "object", "required": [ "order", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "description": "見積内容ID", "example": 1 }, "order": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "順序", "example": 0 }, "type": { "type": "string", "description": "行の種類\n", "example": "normal", "enum": [ "normal", "discount", "text" ] }, "qty": { "type": "number", "minimum": 0, "maximum": 99999999, "description": "数量", "example": 1 }, "unit": { "type": "string", "description": "単位", "example": "個" }, "unit_price": { "type": "number", "minimum": -999999999999, "maximum": 999999999999, "description": "単価 (tax_entry_method: inclusiveの場合は税込価格、tax_entry_method: exclusiveの場合は税抜価格となります)", "example": 1 }, "vat": { "type": "integer", "format": "int64", "nullable": true, "description": "消費税額", "example": 8000 }, "description": { "type": "string", "description": "備考", "example": "備考" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "tax_code": { "type": "integer", "format": "int64", "minimum": 0, "maximum": 2147483647, "description": "税区分コード", "example": 1 }, "item_id": { "type": "integer", "format": "int64", "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "items": { "type": "integer", "format": "int64", "description": "メモタグID", "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "description": "セグメント１ID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "description": "セグメント２ID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "description": "セグメント３ID", "example": 1 } } } } } }, "fixedAssetResponse": { "type": "object", "required": [ "fixed_assets", "fiscal_year", "up_to_date", "up_to_date_reasons" ], "properties": { "fixed_assets": { "type": "array", "items": { "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "description": "事業所ID", "example": 1 }, "id": { "type": "integer", "format": "int64", "description": "固定資産ID", "example": 1 }, "name": { "type": "string", "description": "固定資産名", "example": "pc" }, "management_number": { "type": "string", "nullable": true, "description": "管理番号", "example": "pc-0001" }, "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 22 }, "section_id": { "type": "integer", "nullable": true, "format": "int64", "description": "部門ID", "example": 0 }, "item_id": { "type": "integer", "nullable": true, "format": "int64", "description": "品目ID", "example": 0 }, "depreciation_method": { "type": "string", "description": "償却方法:(少額償却: small_sum_method, 一括償却: lump_sum_method, 定額法: straight_line_method, 定率法: multiple_method, 旧定率法: old_multiple_method, 旧定額法: old_straight_line_method, 償却なし: non_depreciate_method, 任意償却: voluntary_method, 即時償却: immediate_method, 均等償却: equal_method)", "enum": [ "small_sum_method", "lump_sum_method", "straight_line_method", "multiple_method", "old_multiple_method", "old_straight_line_method", "non_depreciate_method", "voluntary_method", "immediate_method", "equal_method" ], "example": "straight_line_method" }, "depreciation_account_item_id": { "type": "integer", "format": "int64", "description": "減価償却に使う勘定科目ID", "example": 99 }, "prefecture_code": { "type": "integer", "format": "int64", "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:沖縄", "example": 4, "nullable": true }, "city_name": { "type": "string", "nullable": true, "description": "申告先市区町村", "example": "港区" }, "depreciation_amount": { "type": "integer", "format": "int64", "description": "本年分の償却費合計", "example": "18533" }, "acquisition_cost": { "type": "integer", "format": "int64", "description": "取得価額", "example": "150000" }, "opening_balance": { "type": "integer", "format": "int64", "description": "期首残高（取得日が会計期間に含まれるとき期首残高は0になります。）", "example": "92000" }, "undepreciated_balance": { "type": "integer", "format": "int64", "description": "未償却残高", "example": "46000" }, "opening_accumulated_depreciation": { "type": "integer", "format": "int64", "description": "期首減価償却累計額", "example": "100000" }, "closing_accumulated_depreciation": { "type": "integer", "format": "int64", "description": "期末減価償却累計額", "example": "46000" }, "life_years": { "type": "integer", "format": "int64", "description": "耐用年数", "example": "5" }, "acquisition_date": { "type": "string", "description": "取得日", "format": "date", "example": "2021-07-13" }, "created_at": { "type": "string", "description": "作成日時（ISO8601形式）", "example": "2021-07-15T18:30:24+09:00" }, "depreciation_status": { "type": "string", "description": "売却もしくは除却ステータス: (売却済: sold, 除却済: retired, 償却済: depreciated, 償却中: depreciation, 償却なし: non_depreciation)", "enum": [ "sold", "retired", "depreciated", "depreciation", "non_depreciation" ], "example": "depreciation" }, "retire_date": { "type": "string", "format": "date", "nullable": true, "description": "除却日、もしくは売却日", "example": "2022-03-24" } } } }, "fiscal_year": { "type": "object", "required": [ "start_date", "end_date" ], "properties": { "start_date": { "type": "string", "description": "会計年度開始日 (yyyy-mm-dd)", "example": "2022-01-01" }, "end_date": { "type": "string", "description": "会計年度終了日 (yyyy-mm-dd)", "example": "2022-12-31" } } }, "up_to_date": { "type": "boolean", "description": "集計結果が最新かどうか", "example": true }, "up_to_date_reasons": { "type": "array", "description": "集計が最新でない場合の要因情報", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "コード", "example": "depreciation_creating", "enum": [ "depreciation_creating", "depreciation_create_error" ] }, "message": { "type": "string", "description": "集計が最新でない理由", "example": "当期の固定資産の償却作成が完了していないため、正しい集計結果でない可能性があります。" } } } } } }, "generalLedgersResponse": { "type": "object", "required": [ "general_ledgers" ], "properties": { "general_ledgers": { "type": "array", "items": { "type": "object", "properties": { "account_item_id": { "type": "integer", "format": "int64", "description": "勘定科目ID", "example": 1 }, "account_item_name": { "type": "string", "description": "勘定科目名", "example": "売掛金" }, "total_amount": { "type": "integer", "format": "int64", "description": "発生額累計", "example": 100 }, "final_balance": { "type": "integer", "format": "int64", "description": "残高", "example": 100 }, "debit_amount": { "type": "integer", "format": "int64", "description": "借方発生額累計", "example": 100 }, "credit_amount": { "type": "integer", "format": "int64", "description": "貸方発生額累計", "example": 100 } } } } } } }, "securitySchemes": { "oauth2": { "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": "データの読み取り" } } } } } } }