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

スタートガイド

\n\n

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

\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

認証について

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

\n\n

データフォーマット

\n\n

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

\n\n

後方互換性ありの変更

\n\n

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

\n\n

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

\n\n

共通レスポンスヘッダー

\n\n

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

\n\n

\n
X-Freee-Request-ID
\n
- 各リクエスト毎に発行されるID
\n

\n\n

共通エラーレスポンス

\n\n

\n
ステータスコードはレスポンス内のJSONに含まれる他、HTTPヘッダにも含まれる
\n
\n
一部のエラーレスポンスにはエラーコードが含まれます。
詳細は、HTTPステータスコード400台エラー時のチェックポイントを参照してください
\n

type

status : HTTPステータスコードの説明
validation : エラーの詳細の説明（開発者向け）

\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アクセスをコントロールする場合があります。

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

\n\n

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

\n\n

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

/reports:1秒に10回まで
/receipts/{id}/download:1秒に3回まで

\n\n

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

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 使用制限

\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

\n\n

プランごとの利用可能 API

契約プランごとにご利用可能な freee 会計 API は異なります。 freee 会計の Web 版でご利用いただける機能について、 freee 会計 API でもご利用いただけます。

例えば法人スタータープラン、旧法人ベーシックプランをご契約いただいている場合、 Web 版では経費精算機能をご利用いただけますので、 API でも経費精算 API をご利用可能です。

ただし以下の API は例外です。

総勘定元帳API：旧法人プロフェッショナルプラン、旧法人エンタープライズプラン、法人アドバンスプラン、新法人エンタープライズプランに加入している事業所のみがご利用可能です。
固定資産台帳API：旧法人エンタープライズプラン、新法人エンタープライズプランに加入している事業所のみがご利用可能です。

詳しくは、【個人】freee会計のプランについて並びに【法人】freee会計のプランについてをご確認ください。

\n\n

プランごとの利用可能パラメータ

ご利用可能な freee 会計 API であっても、契約プランごとに利用可能なパラメータは異なります。

\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

パラメータ	説明	利用可能プラン
segment_1_tag	セグメント１タグ	法人アドバンスプラン法人エンタープライズプラン旧法人プロフェッショナルプラン
segment_2_tag	セグメント２タグ	法人アドバンスプラン法人エンタープライズプラン
segment_3_tag	セグメント３タグ	法人アドバンスプラン法人エンタープライズプラン
segment_1_tag_id	セグメント１タグID	法人アドバンスプラン法人エンタープライズプラン旧法人プロフェッショナルプラン
segment_2_tag_id	セグメント２タグID	法人アドバンスプラン法人エンタープライズプラン
segment_3_tag_id	セグメント３タグID	法人アドバンスプラン法人エンタープライズプラン
segment_1_tag_name	セグメント１タグ名	法人アドバンスプラン法人エンタープライズプラン旧法人プロフェッショナルプラン
segment_2_tag_name	セグメント２タグ名	法人アドバンスプラン法人エンタープライズプラン
segment_3_tag_name	セグメント３タグ名	法人アドバンスプラン法人エンタープライズプラン
segment_id	セグメントID（1, 2, 3 のいずれか）	法人アドバンスプラン法人エンタープライズプラン旧法人プロフェッショナルプラン旧法人プロフェッショナルプランにつきましては、 1 のみ指定可能です。

\n\n

Webhookについて

\n\n

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

\n\n

連絡先

\n\n

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

© 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": "

総勘定元帳

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

決算書表示名

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

概要

\n\n

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

振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。

", "operationId": "get_partners", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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

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

取引先名称（name）は重複不可です。
codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
取引先コードの利用を有効にしている場合は、\n
- codeの指定は必須です。
- name、codeそれぞれ重複不可です。
\n
振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）は法人スタータープラン（および旧法人プロフェッショナルプラン）以上で利用可能です。

", "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

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

振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）は法人スタータープラン（および旧法人プロフェッショナルプラン）以上で利用可能です。

", "operationId": "get_partner", "parameters": [ { "name": "id", "in": "path", "description": "取引先ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

取引先名称（name）は重複不可です。
codeを指定、更新することはできません。
振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）は法人スタータープラン（および旧法人プロフェッショナルプラン）以上で利用可能です。
支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）にnull型を入力することにより、期日を未設定に変更可能です。

", "operationId": "update_partner", "parameters": [ { "name": "id", "in": "path", "description": "取引先ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

このAPIを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
コードを日本語に設定している場合は、URLエンコードしてURLに含めるようにしてください。
取引先名称（name）は重複不可です。
振込元口座ID（payer_walletable_id）, 振込手数料負担（transfer_fee_handling_side）, 支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）は法人スタータープラン（および旧法人プロフェッショナルプラン）以上で利用可能です。
支払期日設定（payment_term_attributes）, 請求の入金期日設定（invoice_payment_term_attributes）にnull型を入力することにより、期日を未設定に変更可能です。

", "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", "minimum": 1 } }, { "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

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

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

", "operationId": "get_account_item", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "id", "in": "path", "description": "勘定科目ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

注意点

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

codeを利用するには、事業所の設定で勘定科目コードを使用する設定にする必要があります。

", "operationId": "update_account_item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

注意点

削除できる勘定科目は、追加で作成したカスタム勘定科目のみです。
デフォルトで存在する勘定科目や口座の勘定科目は削除できません。

", "operationId": "destroy_account_item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

default_tax_code : リクエストした日時を基準とした税区分コード

", "operationId": "destroy_tag", "parameters": [ { "name": "id", "in": "path", "description": "タグID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

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

\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", "minimum": 1 } } ], "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

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

codeを利用するには、事業所の設定で部門コードを使用する設定にする必要があります。

\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

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

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

\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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

codeを利用するには、事業所の設定で部門コードを使用する設定にする必要があります。

\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\n

注意点

入金済みの請求書に対する金額関連の変更はできません。
請求書WFを利用している場合、承認済み請求書は承認権限を持たないユーザーでは更新できません。
請求書ステータス(invoice_status)を下書き(draft)以外で更新する場合、請求内容の合計金額が0円以上になる必要があります。
partner_code, partner_idを両方同時に指定することはできません。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
本APIでは請求内容(invoice_contents)は、最大100行までになります。

\n\n

注意点

partner_code, partner_idを両方同時に指定することはできません。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。
本APIでは見積内容(quotation_contents)は、最大100行までになります。

", "operationId": "update_quotation", "parameters": [ { "name": "id", "in": "path", "description": "見積書ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
details : 取引の明細行
\n
\n
accruals : 取引の債権債務行
\n
\n
renews : 取引の+更新行
\n
\n
payments : 取引の支払行
\n
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n
\n
registered_from
\n
- all : すべての取引
- me : 自身が登録した取引
\n

注意点

セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。

", "operationId": "get_deals", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "partner_id", "in": "query", "description": "取引先IDで絞込", "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "account_item_id", "in": "query", "description": "勘定科目IDで絞込", "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
ref_number : 管理番号
\n
\n
details : 取引の明細行(最大40行)
\n
\n
payments : 取引の支払行
\n
\n
receipt_ids : ファイルボックス（証憑ファイル）ID
\n
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n

注意点

本APIでは+更新行(renews)の操作ができません。取引（収入・支出）の+更新の作成APIをご利用ください。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
\n
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。
\n
本APIでは取引の明細行(details)は、最大40行までになります。
\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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
details : 取引の明細行
\n
\n
accruals : 取引の債権債務行
\n
\n
renews : 取引の+更新行
\n
\n
payments : 取引の支払行
\n
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n

注意点

セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。

", "operationId": "get_deal", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
details : 取引の明細行(最大40行)
\n
\n
renews : 取引の+更新行
\n
\n
payments : 取引の支払行
\n
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n
\n
receipt_ids : ファイルボックス（証憑ファイル）ID
\n

注意点

本APIでは支払行(payments)の操作ができません。取引（収入・支出）の支払行の作成・更新・削除APIをご利用ください。
本APIでは+更新行(renews)の操作ができません。取引（収入・支出）の+更新の作成・更新・削除APIをご利用ください。
本APIでは収入／支出の切替えができません。既存の取引を削除後、再度作成してください。
本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。
freee請求書から登録された取引は品目・部門・メモタグ・セグメント1、2、3のみ更新可能です。
\n
本APIでは取引の明細行(details)は、最大40行までになります。
\n

", "operationId": "update_deal", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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", "operationId": "destroy_deal", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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": "

概要

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

定義

issue_date : 発生日
due_date : 支払期日
amount : 金額
due_amount : 支払残額
type
\n
- income : 収入
- expense : 支出
details : 取引の明細行
accruals : 取引の債権債務行
renews : 取引の+更新行
payments : 取引の支払行
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）

注意点

本APIではdetails(取引の明細行)、accruals(債権債務行)、renewsのdetails(+更新の明細行)のみ操作可能です。
本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。

\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": "

概要

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

定義

issue_date : 発生日
due_date : 支払期日
amount : 金額
due_amount : 支払残額
type
\n
- income : 収入
- expense : 支出
details : 取引の明細行
accruals : 取引の債権債務行
renews : 取引の+更新行
payments : 取引の支払行
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）

注意点

本APIでは+更新の更新のみ可能です。取引や支払行に対する更新はできません。
renew_idにはrenewsのid(+更新ID)を指定してください。renewsのdetailsのid(+更新の明細行ID)を指定できません。
月締めされている仕訳に紐づく＋更新行の編集・削除はできません。
承認済み仕訳に紐づく＋更新行の編集・削除は管理者権限のユーザーのみ可能です。
本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。

\n", "operationId": "update_deal_renew", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "renew_id", "in": "path", "description": "+更新ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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": "

概要

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

注意点

本APIでは+更新の削除のみ可能です。取引や支払行に対する削除はできません。
renew_idにはrenewsのid(+更新ID)を指定してください。renewsのdetailsのid(+更新の明細行ID)を指定できません。
月締めされている仕訳に紐づく＋更新行の編集・削除はできません。
承認済み仕訳に紐づく＋更新行の編集・削除は管理者権限のユーザーのみ可能です。
本APIで取引を更新すると、消費税の計算方法は必ず内税方式が選択されます。

\n", "operationId": "delete_deal_renew", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "renew_id", "in": "path", "description": "+更新ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1, "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
details : 取引の明細行
renews : 取引の+更新行
payments : 取引の支払行
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n

", "operationId": "create_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
details : 取引の明細行
\n
\n
renews : 取引の+更新行
\n
\n
payments : 取引の支払行
\n
\n
from_walletable_type
\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : 現金
- private_account_item : プライベート資金（法人の場合は役員借入金もしくは役員借入金、個人の場合は事業主貸もしくは事業主借）
\n

", "operationId": "update_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "payment_id", "in": "path", "description": "決済ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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
issue_date : 発生日
\n
\n
due_date : 支払期日
\n
\n
amount : 金額
\n
\n
due_amount : 支払残額
\n
\n
type
\n
- income : 収入
- expense : 支出
\n
\n
details : 取引の明細行
\n

", "operationId": "destroy_deal_payment", "parameters": [ { "name": "id", "in": "path", "description": "取引ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "payment_id", "in": "path", "description": "決済ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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
issue_date : 発生日
\n
\n
adjustment : 決算整理仕訳フラグ（true: 決算整理仕訳, false: 日常仕訳）
\n
\n
txn_number : 仕訳番号
\n
\n
details : 振替伝票の貸借行
\n
\n
entry_side : 貸借区分
\n\n
- credit : 貸方
- debit : 借方
\n
\n
amount : 金額
\n

\n\n

注意点

\n\n

振替伝票は売掛・買掛レポートには反映されません。債権・債務データの登録は取引(Deals)をお使いください。
事業所の仕訳番号形式が有効な場合のみ、レスポンスで仕訳番号(txn_number)を返します。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。

", "operationId": "get_manual_journals", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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", "minimum": 1 } }, { "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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "segment_1_tag_id", "in": "query", "description": "セグメント１タグIDで絞込（0を指定すると、セグメント１タグが未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "segment_2_tag_id", "in": "query", "description": "セグメント２タグIDで絞込（0を指定すると、セグメント２タグが未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "segment_3_tag_id", "in": "query", "description": "セグメント３タグIDで絞込（0を指定すると、セグメント３タグが未選択の貸借行を絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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
issue_date : 発生日
\n
\n
adjustment : 決算整理仕訳フラグ（true: 決算整理仕訳, false: 日常仕訳）
\n
\n
txn_number : 仕訳番号
\n
\n
details : 振替伝票の貸借行
\n
\n
entry_side : 貸借区分
\n\n
- credit : 貸方
- debit : 借方
\n
\n
amount : 金額
\n

\n\n

注意点

\n\n

振替伝票は売掛・買掛レポートには反映されません。債権・債務データの登録は取引(Deals)をお使いください。
事業所の仕訳番号形式が有効な場合のみ、レスポンスで仕訳番号(txn_number)を返します。
貸借合わせて100行まで仕訳行を登録できます。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。

\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

issue_date : 発生日
adjustment : 決算整理仕訳フラグ（true: 決算整理仕訳, false: 日常仕訳）
txn_number : 仕訳番号
details : 振替伝票の貸借行
entry_side : 貸借区分
\n
- credit : 貸方
- debit : 借方
amount : 金額

\n\n

注意点

\n\n

振替伝票は売掛・買掛レポートには反映されません。債権・債務データの登録は取引(Deals)をお使いください。
事業所の仕訳番号形式が有効な場合のみ、レスポンスで仕訳番号(txn_number)を返します。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンスプラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。

", "operationId": "get_manual_journal", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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
issue_date : 発生日
\n
\n
adjustment : 決算整理仕訳フラグ（true: 決算整理仕訳, false: 日常仕訳）
\n
\n
txn_number : 仕訳番号
\n
\n
details : 振替伝票の貸借行
\n
\n
entry_side : 貸借区分
\n\n
- credit : 貸方
- debit : 借方
\n
\n
amount : 金額
\n

\n\n

注意点

\n\n

振替伝票は売掛・買掛レポートには反映されません。債権・債務データの登録は取引(Deals)をお使いください。
事業所の仕訳番号形式が有効な場合のみ、レスポンスで仕訳番号(txn_number)を返します。
貸借合わせて100行まで仕訳行を登録できます。
detailsに含まれない既存の貸借行は削除されます。更新後も残したい行は、必ず貸借行IDを指定してdetailsに含めてください。
detailsに含まれる貸借行IDの指定がある行は、更新行として扱われ更新されます。
detailsに含まれる貸借行IDの指定がない行は、新規行として扱われ追加されます。
セグメントタグ情報は法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で利用可能です。利用可能なセグメントの数は、法人アドバンプスラン（および旧法人プロフェッショナルプラン）の場合は1つ、法人エンタープライズプランの場合は3つです。
partner_codeを利用するには、事業所の設定から取引先コードの利用を有効にする必要があります。またpartner_codeとpartner_idは同時に指定することはできません。

キー	対応する項目
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_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_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_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

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

", "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

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

", "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

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

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

", "operationId": "get_items", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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

codeを利用するには、事業所の設定で品目コードを使用する設定にする必要があります。

", "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

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

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

", "operationId": "get_item", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "id", "in": "path", "description": "品目ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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\n

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

\n\n

注意点

同期に対応した口座はこのAPIでは作成できません

\n\n

定義

\n\n

\n
type
\n\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n
\n
name : 口座名
\n
\n
bank_id : 連携サービスID
\n
\n
is_asset : type:wallet指定時に口座を資産口座とするか負債口座とするか（true: 資産口座 (デフォルト), false: 負債口座）
\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

type\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n
walletable_balance : 登録残高
last_balance : 同期残高
last_synced_at : 最終同期成功日時
sync_status : 同期ステータス

", "operationId": "get_walletable", "parameters": [ { "name": "id", "in": "path", "description": "口座ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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", "minimum": 1 } }, { "name": "with_last_synced_at", "in": "query", "description": "最終同期成功日時を含める", "example": false, "schema": { "default": false, "type": "boolean" } }, { "name": "with_sync_status", "in": "query", "description": "同期ステータスを含める", "example": false, "schema": { "default": false, "type": "boolean" } } ], "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

注意点

削除を実行するには、当該口座に関連する仕訳データを事前に削除する必要があります。
当該口座に仕訳が残っていないか確認するには、レポートの「仕訳帳」等を参照し、必要に応じて、「取引」や「口座振替」も削除します。

", "operationId": "destroy_walletable", "parameters": [ { "name": "id", "in": "path", "description": "口座ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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", "minimum": 1 } } ], "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

type\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\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

type\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n

", "operationId": "get_bank", "parameters": [ { "name": "id", "in": "path", "description": "連携サービスID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

\n
amount : 振替金額
\n
\n
from_walletable_type, to_walletable_type
\n\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n

", "operationId": "get_transfers", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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

\n
amount : 振替金額
\n
\n
from_walletable_type, to_walletable_type
\n\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\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

\n
amount : 振替金額
\n
\n
from_walletable_type, to_walletable_type
\n\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n

", "operationId": "get_transfer", "parameters": [ { "name": "id", "in": "path", "description": "取引(振替)ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

\n
amount : 振替金額
\n
\n
from_walletable_type, to_walletable_type
\n\n
- bank_account : 銀行口座
- credit_card : クレジットカード
- wallet : その他の決済口座
\n

注意点

同期をして取得したデータが「明細」の場合は、削除および再取得はできません。
詳細はfreeeヘルプセンターをご確認ください。

", "operationId": "destroy_wallet_txn", "parameters": [ { "name": "id", "in": "path", "description": "明細ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

定義

\n\n

download_type\n
- generic (旧CSV)
- generic_v2 (新CSV（freee汎用形式）)
- csv (弥生会計)
- pdf (PDF)
\n
encoding : download_typeがgeneric, generic_v2の場合のみ有効で、指定しない場合はsjisになります。無効なdownload_typeのうちcsvの場合はsjisでファイル出力されるので、レスポンスでsjisがかえります。\n
- sjis
- utf-8
\n
visible_tags : download_typeがgeneric, csv, pdfの場合のみ有効です。指定しない場合は従来の仕様の仕訳帳が出力されます。\n
- partner : 取引先タグ
- item : 品目タグ
- tag : メモタグ
- section : 部門タグ
- description : 備考欄
- wallet_txn_description : 明細の備考欄
- \n segment_1_tag : セグメント１タグ
  \n segment_2_tag : セグメント２タグ
  \n segment_3_tag : セグメント３タグ
  
  \n セグメント（分析用タグ）の設定
  \n
- all : 指定された場合は上記の設定をすべて有効として扱いますが、セグメント１タグ、セグメント２タグ、セグメント３タグは含みません。セグメントが必要な場合はallではなく、segment_1_tag, segment_2_tag, segment_3_tagを指定してください。
\n
visible_ids : download_typeがgenericの場合のみ有効です。\n
- deal_id : 取引ID
- transfer_id : 取引(振替)ID
- manual_journal_id : 振替伝票ID
\n
id : 受け付けID

", "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", "minimum": 1 } }, { "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

定義

\n\n

\n
status
\n\n
- enqueued : 実行待ち
- working : 実行中
- uploaded : 準備完了
\n
\n
id : 受け付けID
\n

", "operationId": "get_journal_status", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "id", "in": "path", "description": "受け付けID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

定義

\n\n

id : 受け付けID

", "operationId": "download_journal", "parameters": [ { "name": "id", "in": "path", "description": "受け付けID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
opening_balance : 期首残高
debit_amount : 借方金額
credit_amount: 貸方金額
closing_balance : 期末残高
composition_ratio : 構成比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
two_years_before_closing_balance: 前々年度期末残高
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
opening_balance : 期首残高
debit_amount : 借方金額
credit_amount: 貸方金額
closing_balance : 期末残高
composition_ratio : 構成比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
two_years_before_closing_balance: 前々年度期末残高
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "損益計算書(セグメント１比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_1_tag_ids", "in": "query", "description": "出力するセグメント１タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "損益計算書(セグメント２比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_2_tag_ids", "in": "query", "description": "出力するセグメント２タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "損益計算書(セグメント３比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_3_tag_ids", "in": "query", "description": "出力するセグメント３タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
opening_balance : 期首残高
debit_amount : 借方金額
credit_amount: 貸方金額
closing_balance : 期末残高
composition_ratio : 構成比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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  "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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
two_years_before_closing_balance: 前々年度期末残高
last_year_closing_balance: 前年度期末残高
closing_balance : 期末残高
year_on_year : 前年比

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
配賦仕訳の絞り込み（cost_allocation）は法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能です。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: 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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "製造原価報告書(セグメント１比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_1_tag_ids", "in": "query", "description": "出力するセグメント１タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "製造原価報告書(セグメント２比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_2_tag_ids", "in": "query", "description": "出力するセグメント２タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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": "製造原価報告書(セグメント３比較)の取得", "description": "\n

概要

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

\n\n

定義

created_at : 作成日時
account_item_name : 勘定科目名
hierarchy_level: 階層レベル
parent_account_category_name: 上位勘定科目カテゴリー名
closing_balance : 期末残高

\n\n

注意点

会計年度が指定されない場合、現在の会計年度がデフォルトとなります。
up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。
partner_codeとpartner_idは同時に指定することはできません。
start_date / end_date を指定した場合、以下を同時に指定することはできません。\n
- fiscal_year
- start_month
- end_month
\n
0を指定すると未選択で絞り込めます\n
- partner_idに0を指定して絞り込んだ場合\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", "minimum": 1 } }, { "name": "segment_3_tag_ids", "in": "query", "description": "出力するセグメント３タグIDの指定（半角数字の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", "minimum": 0 } }, { "name": "partner_code", "in": "query", "description": "取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です）", "schema": { "type": "string" } }, { "name": "item_id", "in": "query", "description": "品目IDで絞込（0を指定すると、品目が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "name": "section_id", "in": "query", "description": "部門IDで絞込（0を指定すると、部門が未選択で絞り込めます）", "schema": { "type": "integer", "format": "int64", "minimum": 0 } }, { "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※このAPIはβ版として提供しています。\n

このAPIは法人アドバンスプラン（および旧法人プロフェッショナルプラン）・法人エンタープライズプランに加入している事業所のみが利用できます。
利用状況によって事前の告知なく提供プラン・コール数の上限を変更する可能性があります。
他エンドポイントと比べてレスポンスタイムが遅い場合があります。

", "operationId": "get_general_ledgers", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 }, "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": "セグメント１タグ名で絞込（未選択を指定すると、セグメント１タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント１タグ" }, { "name": "segment_tag_2_name", "in": "query", "description": "セグメント２タグ名で絞込（未選択を指定すると、セグメント２タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント２タグ" }, { "name": "segment_tag_3_name", "in": "query", "description": "セグメント３タグ名で絞込（未選択を指定すると、セグメント３タグが未選択で絞り込めます）", "schema": { "type": "string" }, "example": "セグメント３タグ" }, { "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", "minimum": 1 } }, { "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", "minimum": 1 } }, { "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

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

注意点

リクエストヘッダーの Content-Type は、multipart/form-dataにのみ対応しています。
インボイス制度適格請求書発行事業者登録番号はOCR解析結果が採用されます。OCR解析結果を確認する場合は、Web画面にてご確認ください。上書きする場合は、ファイルボックス（証憑ファイル）の更新APIをご利用ください。

", "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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

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

注意点

本APIでは、証憑ファイルの再アップロードはできません。

", "operationId": "update_receipt", "parameters": [ { "name": "id", "in": "path", "description": "ファイルボックス（証憑ファイル）ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

本APIでは、経費申請に関連付ける各種申請を更新することができます。
本APIでは、status(申請ステータス): in_progress:申請中, approved:承認済みのみ更新可能です。
parent_idにnullを指定すると、現在設定されている各種申請との関連付けを解除できます。
\n 申請ステータスが申請中の経費申請に対して関連付ける各種申請を更新するためには、以下の全てに当てはまる必要があります。\n
- 現在の承認ステップで承認者として指定されている、または特権承認ができる
- 申請フォームの設定で、承認者による経費申請に関連付ける各種申請の更新が許可されている
\n
\n 申請ステータスが承認済みの経費申請に対して関連付ける各種申請を更新するためには、以下の全てに当てはまる必要があります。\n
- 経費精算に対する閲覧および編集の権限を持ち、自分の経費申請のみに限定する制限がかかっていない
- 申請フォームの設定で、管理者による経費申請に関連付ける各種申請の更新が許可されている
\n
\n 申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している経費申請は本API経由で更新ができません。\n
- 役職指定（申請者の所属部門）
- 役職指定（申請時に部門指定）
- 部門および役職指定
\n
本APIは駅すぱあと連携 (出発駅と到着駅から金額を自動入力する機能)には非対応です。駅すぱあと連携を使用した経費申請は関連付ける各種申請を更新できません。
申請フォームの設定はWeb画面よりご利用ください。

", "operationId": "update_expense_application_parent_approvable_requests", "parameters": [ { "name": "id", "in": "path", "description": "経費申請ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

\n\n

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

\n\n

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

", "operationId": "get_approval_request_form", "parameters": [ { "name": "id", "in": "path", "description": "申請フォームID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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の使い方をご参照ください

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

\n\n

注意点

\n\n

\n
申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。
\n
- 役職指定（申請者の所属部門）
- 役職指定（申請時に部門指定）
- 部門および役職指定
\n

", "operationId": "get_approval_flow_routes", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "included_user_id", "in": "query", "description": "経路に含まれるユーザーのユーザーID", "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "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", "minimum": 1 } } ], "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の使い方をご参照ください

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

\n\n

注意点

\n\n

\n
申請経路、承認者の指定として部門役職データ連携を活用し、以下のいずれかを利用している申請と申請経路はAPI経由で参照は可能ですが、作成と更新、承認ステータスの変更ができません。
\n
- 役職指定（申請者の所属部門）
- 役職指定（申請時に部門指定）
- 部門および役職指定
\n

", "operationId": "get_approval_flow_route", "parameters": [ { "name": "id", "in": "path", "description": "経路申請ID", "required": true, "schema": { "type": "integer", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "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

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

", "operationId": "get_segment_tags", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } }, { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\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

codeを利用するには、事業所の設定でセグメントタグコードを使用する設定にする必要があります。

", "operationId": "create_segment_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\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

codeを利用するには、事業所の設定でセグメントタグコードを使用する設定にする必要があります。

", "operationId": "update_segment_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\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", "minimum": 1 } } ], "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

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

", "operationId": "destroy_segments_tag", "parameters": [ { "name": "segment_id", "in": "path", "description": "セグメントID（1,2,3のいずれか）\n該当プラン以外で参照した場合にはエラーとなります。\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", "minimum": 1 } }, { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1 } } ], "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

定義

このAPIは法人エンタープライズに加入している事業所のみが利用できます。
target_date : 表示したい会計期間の開始年月日。開始年月日以外を指定した場合は、その日付が含まれる会計期間が対象となります。
depreciation_amount : 本年分の償却費合計
depreciation_method : 償却方法
depreciation_account_item_id : 減価償却に使う勘定科目
acquisition_cost : 取得価額
opening_balance : 期首残高
undepreciated_balance : 未償却残高。土地などの償却しない固定資産はnullが返ります。
opening_accumulated_depreciation : 期首減価償却累計額
closing_accumulated_depreciation : 期末減価償却累計額

注意点

up_to_dateがfalseの場合、残高の集計が完了していません。最新の集計結果を確認したい場合は、時間を空けて再度取得する必要があります。

", "operationId": "get_fixed_assets", "parameters": [ { "name": "company_id", "in": "query", "description": "事業所ID", "required": true, "schema": { "type": "integer", "format": "int64", "minimum": 1, "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" } } } } } } }, "/api/1/account_groups": { "post": { "tags": [ "Account groups" ], "summary": "決算書表示名の作成", "description": "\n

概要

指定した事業所の決算書表示名を作成する

", "operationId": "create_account_group", "requestBody": { "description": "決算書表示名の作成", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountGroupCreateParams" } } }, "required": true }, "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/accountGroupCreateResponse" } } } }, "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" } } } } } } } }, "components": { "schemas": { "paymentParams": { "required": [ "amount", "company_id", "date", "from_walletable_id", "from_walletable_type" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "due_date": { "type": "string", "description": "支払期日(yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "due_date": { "type": "string", "description": "支払期日(yyyy-mm-dd)", "example": "2019-12-17" }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "example": 1 } } } }, "manualJournalCreateParams": { "required": [ "company_id", "details", "issue_date" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } }, "description": "貸借行一覧（配列）: 貸借合わせて100行まで登録できます。" } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } } } }, "manualJournalUpdateParams": { "required": [ "company_id", "details", "issue_date" ], "type": "object", "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "取引先ID", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID", "example": 1 }, "description": { "type": "string", "description": "備考", "example": "備考" } }, "description": "貸借行一覧（配列）: 貸借合わせて100行まで登録できます。" } }, "receipt_ids": { "type": "array", "description": "ファイルボックス（証憑ファイル）ID（配列）", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } } } }, "itemParams": { "type": "object", "required": [ "company_id", "name" ], "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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": "品目コード", "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "bank_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 } } }, "walletableUpdateResponse": { "type": "object", "required": [ "bank_id", "id", "name", "type" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "口座ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "口座名 (255文字以内)", "example": "freee銀行" }, "bank_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "部門ID", "example": 101 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "transaction_date" ], "properties": { "receipt_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "経費科目ID", "example": 505 } } } } } } }, "approval_flow_route_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "申請経路ID
\n

経費申請のステータスを申請中として作成する場合は、必ず指定してください。
指定する申請経路IDは、申請経路APIを利用して取得してください。
\n 未指定の場合は、基本経路を設定している事業所では基本経路が、基本経路を設定していない事業所では利用可能な申請経路の中から最初の申請経路が自動的に使用されます。\n
- 意図しない申請経路を持った経費申請の作成を防ぐために、使用する申請経路IDを指定することを推奨します。
\n
\n 法人スタータープラン、法人スタンダードプラン（および旧法人ベーシックプラン）の事業所では以下のデフォルトで用意された申請経路のみ指定できます\n
- 指定なし
- 承認者を指定
\n

\n", "example": 1 }, "approver_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "親申請ID(法人アドバンスプラン（および旧法人プロフェッショナルプラン）, 法人エンタープライズプラン)
\n

承認済みの既存各種申請IDのみ指定可能です。
各種申請一覧APIを利用して取得してください。

\n", "example": 2 }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 2 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 3 } } }, "expenseApplicationUpdateParams": { "type": "object", "required": [ "company_id", "title" ], "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "部門ID", "example": 101 }, "tag_ids": { "type": "array", "description": "メモタグID", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 202 } }, "purchase_lines": { "type": "array", "description": "経費申請の申請行一覧（配列）", "items": { "type": "object", "required": [ "transaction_date" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "ファイルボックス（証憑ファイル）ID", "example": 606 }, "sub_receipt_ids": { "type": "array", "description": "補足資料（配列）\n receipt_id（証憑ファイル）を指定してください。\n receipt_id（証憑ファイル）は5個まで指定できます", "items": { "type": "integer", "format": "int64", "minimum": 1, "example": 606 } }, "expense_application_lines": { "type": "array", "description": "明細行一覧（配列）", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "経費科目ID", "example": 505 } } } } } } }, "approval_flow_route_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "申請経路ID
\n

経費申請のステータスを申請中として作成する場合は、必ず指定してください。
指定する申請経路IDは、申請経路APIを利用して取得してください。
\n 未指定の場合は、基本経路を設定している事業所では基本経路が、基本経路を設定していない事業所では利用可能な申請経路の中から最初の申請経路が自動的に使用されます。\n
- 意図しない申請経路を持った経費申請の作成を防ぐために、使用する申請経路IDを指定することを推奨します。
\n
\n 法人スタータープラン、法人スタンダードプラン（および旧法人ベーシックプラン）の事業所では以下のデフォルトで用意された申請経路のみ指定できます\n
- 指定なし
- 承認者を指定
\n

\n", "example": 1 }, "approver_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "親申請ID(法人アドバンスプラン（および旧法人プロフェッショナルプラン）, 法人エンタープライズプラン)
\n

承認済みの既存各種申請IDのみ指定可能です。
各種申請一覧APIを利用して取得してください。

\n", "example": 2, "nullable": true }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 2 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "次ステップの承認者のユーザーID", "example": 1, "nullable": true } } }, "expenseApplicationParentApprovableRequestUpdateParams": { "type": "object", "required": [ "company_id", "parent_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "事業所ID", "example": 1 }, "parent_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64", "minimum": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 } } } }, "approver_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "承認者のユーザーID
\n「承認者を指定」の経路を申請経路として使用する場合に指定してください。
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "approval_flow_route_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "申請経路ID
\n指定する申請経路IDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "parent_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "親申請ID(法人エンタープライズプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）)
\n

承認済みの既存各種申請IDのみ指定可能です。
各種申請一覧APIを利用して取得してください。

\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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "品目ID", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "部門ID", "example": 1 }, "tag_ids": { "type": "array", "description": "メモタグID", "example": [ 1, 2, 3 ], "items": { "type": "integer", "format": "int64", "minimum": 1 } }, "segment_1_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_2_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 }, "segment_3_tag_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID
\nセグメントタグ一覧の取得APIを利用して取得してください。
\nセグメント（分析用タグ）の設定
\n", "example": 1 } } } }, "approver_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "承認者のユーザーID
\n「承認者を指定」の経路を申請経路として使用する場合に指定してください。
\n指定する承認者のユーザーIDは、申請経路APIを利用して取得してください。\n", "example": 1 }, "approval_flow_route_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "name": { "type": "string", "maxLength": 255, "description": "取引先名 (255文字以内、重複不可)", "example": "新しい取引先" }, "available": { "type": "boolean", "description": "true: 使用可能、false: 使用停止", "example": false }, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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": "勘定科目コード", "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", "minimum": 1, "description": "勘定科目カテゴリーID Selectablesフォーム用選択項目情報エンドポイント(account_groups.account_category_id)で取得可能です", "example": 1 }, "corresponding_income_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "収入取引相手勘定科目ID", "example": 1 }, "corresponding_expense_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "支出取引相手勘定科目ID", "example": 1 }, "accumulated_dep_account_item_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "example": 1 } } } }, "partners": { "type": "array", "description": "取引先", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "口座ID", "example": 1, "nullable": true }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー）", "example": "売掛金", "nullable": true }, "group_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "決算書表示名ID（小カテゴリー）", "example": 1, "nullable": true }, "corresponding_income_name": { "type": "string", "description": "収入取引相手勘定科目名", "example": "売掛金", "nullable": true }, "corresponding_income_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "収入取引相手勘定科目ID", "example": 1, "nullable": true }, "corresponding_expense_name": { "type": "string", "description": "支出取引相手勘定科目名", "example": "買掛金", "nullable": true }, "corresponding_expense_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "勘定科目ID", "example": 1 }, "name": { "type": "string", "maxLength": 30, "description": "勘定科目名 (30文字以内)", "example": "ソフトウェア" }, "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "減価償却累計額勘定科目ID（法人のみ利用可能）", "example": 1, "nullable": true }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID", "example": 1 }, "name": { "type": "string", "description": "品目", "example": "住民税" } } } }, "partners": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID", "example": 1 }, "name": { "type": "string", "description": "取引先", "example": "test" } } } }, "available": { "type": "boolean", "description": "勘定科目の使用設定（true: 使用する、false: 使用しない）", "example": true }, "walletable_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "口座ID", "example": 1, "nullable": true }, "group_name": { "type": "string", "description": "決算書表示名（小カテゴリー）", "example": "売掛金", "nullable": true }, "group_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "決算書表示名ID（小カテゴリー）", "example": 1, "nullable": true }, "corresponding_income_name": { "type": "string", "description": "収入取引相手勘定科目名", "example": "売掛金", "nullable": true }, "corresponding_income_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "収入取引相手勘定科目ID", "example": 1, "nullable": true }, "corresponding_expense_name": { "type": "string", "description": "支出取引相手勘定科目名", "example": "買掛金", "nullable": true }, "corresponding_expense_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "支出取引相手勘定科目ID", "example": 1, "nullable": true } } } } }, "accountItemUpdateParams": { "type": "object", "required": [ "account_item", "company_id" ], "properties": { "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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": "勘定科目コード", "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", "minimum": 1, "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", "minimum": 1, "description": "支出取引相手勘定科目ID", "example": 1 }, "accumulated_dep_account_item_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "example": 1 } } } }, "partners": { "type": "array", "description": "取引先", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "example": 1 } } } } } } } }, "bank": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "受け付けID", "example": 1 }, "messages": { "type": "array", "items": { "type": "string", "description": "受け付けメッセージ", "example": "id でリクエストを受け付けました。" } }, "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "description": "受け付けID", "example": 1 }, "company_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "segment_1_tag_ids": { "type": "string", "description": "セグメント１タグID", "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", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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": "セグメント１タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント１タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント１タグ名", "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "segment_2_tag_ids": { "type": "string", "description": "セグメント２タグID", "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", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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": "セグメント２タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント２タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント２タグ名", "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "description": "事業所ID", "example": 1 }, "segment_3_tag_ids": { "type": "string", "description": "セグメント３タグID", "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", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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": "セグメント３タグ", "items": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer", "format": "int64", "minimum": 1, "description": "セグメント３タグID", "example": 1 }, "name": { "type": "string", "description": "セグメント３タグ名", "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "取引先ID(条件に指定した時のみ含まれる）", "example": 1 }, "partner_code": { "type": "string", "description": "取引先コード(条件に指定した時のみ含まれる）", "example": "code001" }, "item_id": { "type": "integer", "format": "int64", "minimum": 1, "description": "品目ID(条件に指定した時のみ含まれる）", "example": 1 }, "section_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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, セグメント１タグ: segment_1_tag, セグメント２タグ: segment_2_tag, セグメント３タグ: segment_3_tag）(条件に指定した時のみ含まれる）", "enum": [ "partner", "item", "section", "account_item", "segment_1_tag", "segment_2_tag", "segment_3_tag" ] }, "partner_id": { "type": "integer", "format": "int64", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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", "minimum": 1, "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