Files
freee__freee-mcp/openapi/partner-management-api-schema.json
T
2026-08-25 02:18:10 +00:00

1284 lines
48 KiB
JSON
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
{
"openapi": "3.0.0",
"info": {
"title": "freee 業務委託管理 API",
"termsOfService": "https://app.secure.freee.co.jp/terms-freee-api.html",
"license": {
"name": "© Since 2013 freee K.K."
},
"description": "<h2 id=\"start_guide\">スタートガイド</h2>\n<p>freee API開発がはじめての方は<a href=\"https://developer.freee.co.jp/getting-started\">freee APIスタートガイド</a>を参照してください。</p>\n<hr />\n<h2 id=\"specification\">仕様</h2>\n<h3 id=\"api_endpoint\">APIエンドポイント</h3>\n<p>https://api.freee.co.jp/hub/</p>\n<h3 id=\"about_authorize\">認証について</h3>\n<p>OAuth2.0を利用します。詳細は<a href=\"https://developer.freee.co.jp/reference/#%e8%aa%8d%e8%a8%bc\" target=\"_blank\">リファレンスの認証に関する記載</a>を参照してください。</p>\n<h3 id=\"data_format\">データフォーマット</h3>\n<p>リクエスト、レスポンスともにJSON形式をサポートしていますが、詳細は、API毎の説明欄(application/jsonなど)を確認してください。</p>\n<h3 id=\"compatibility\">後方互換性ありの変更</h3>\n<p>freeeでは、APIを改善していくために以下のような変更は後方互換性ありとして通知なく変更を入れることがあります。アプリケーション実装者は以下を踏まえて開発を行ってください。</p>\n<ul>\n<li>新しいAPIリソース・エンドポイントの追加</li>\n<li>既存のAPIに対して必須ではない新しいリクエストパラメータの追加</li>\n<li>既存のAPIレスポンスに対する新しいプロパティの追加</li>\n<li>既存のAPIレスポンスに対するプロパティの順番の入れ変え</li>\n<li>keyとなっているidやcodeの長さの変更(長くする)</li>\n<li>エラーメッセージの変更</li>\n</ul>\n<h3 id=\"common_response_header\">共通レスポンスヘッダー</h3>\n<p>すべてのAPIのレスポンスには以下のHTTPヘッダーが含まれます。</p>\n<ul>\n<li>\n<p>Freee-Request-Id</p>\n<ul>\n<li>各リクエスト毎に発行されるID</li>\n</ul>\n</li>\n</ul>\n<h3 id=\"common_error_response\">共通エラーレスポンス</h3>\n<p>APIリクエストでエラーが発生した場合は、エラー原因に応じたステータスコードおよびメッセージを返します。</p>\n<table border=\"1\">\n<tbody>\n<tr>\n<th style=\"padding: 10px\"><strong>ステータスコード</strong></th>\n<th style=\"padding: 10px\"><strong>原因</strong></th>\n</tr>\n<tr><td style=\"padding: 10px\">400</td><td style=\"padding: 10px\">リクエストパラメータが不正</td></tr>\n<tr><td style=\"padding: 10px\">401</td><td style=\"padding: 10px\">アクセストークンが無効</td></tr>\n<tr><td style=\"padding: 10px\">403</td><td style=\"padding: 10px\">アクセス権限がない</td></tr>\n<tr><td style=\"padding: 10px\">404</td><td style=\"padding: 10px\">リソースが存在しない</td></tr>\n<tr><td style=\"padding: 10px\">429</td><td style=\"padding: 10px\">リクエスト回数制限を超えた</td></tr>\n<tr><td style=\"padding: 10px\">500</td><td style=\"padding: 10px\">システム内で予期しないエラーが発生</td></tr>\n</tbody>\n</table>\n<p>エラーレスポンスは以下の形式で返されます。</p>\n<pre><code>{\n&nbsp;&nbsp;\"code\": \"AHB-3003-0002\",\n&nbsp;&nbsp;\"message\": \"リクエストの形式が正しくありません。\",\n&nbsp;&nbsp;\"fields\": [\n&nbsp;&nbsp;&nbsp;&nbsp;{\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\"name\": \"company_id\",\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\"message\": \"事業所IDは必須です。\"\n&nbsp;&nbsp;&nbsp;&nbsp;}\n&nbsp;&nbsp;]\n}</code></pre>\n<h3 id=\"api_rate_limit\">API使用制限</h3>\n<p>APIリクエストは1分あたり60回、1時間あたり1500回、1日あたり3000回を上限としています。<br>\nAPI使用ステータスはRFC準拠のレスポンスヘッダに付与されます。各ヘッダの意味は次のとおりです。</p>\n<table>\n<thead>\n<tr>\n<th>ヘッダ名</th>\n<th>説明</th>\n<th>例</th>\n</tr>\n</thead>\n<tbody>\n<tr><td>RateLimit-Policy</td><td>ポリシー情報(上限と期間)</td><td><code>\"base_rate_limit_minute\";q=60;w=60</code></td></tr>\n<tr><td>RateLimit</td><td>残り回数とリセットまでの秒数</td><td><code>\"base_rate_limit_minute\";r=59;t=45</code></td></tr>\n</tbody>\n</table>\n<p>この上限を超えた場合APIアクセスは制限され、http status codeは429となります。</p>\n<p>また、上記に加えfreeeは一定期間に過度のアクセスを検知した場合、APIアクセスをコントロールする場合があります。<br>\nその際のhttp status codeは403となります。制限がかかってから10分程度が過ぎると再度使用することができるようになります。</p>\n<h3 id=\"open_beta\">オープンベータ版のご利用について</h3> <p>本リファレンスには、現在オープンベータ版として提供されているAPIエンドポイントが含まれています。これらのエンドポイントには、タイトルや説明に「(β版)」の表記があります。</p> <p>オープンベータ版APIのご利用にあたっては、通常の一般公開APIとは異なり、事前の予告なく後方互換性のない変更などが起こりえます。詳しい制約および免責事項は <a href=\"https://developer.freee.co.jp/reference/open-beta\">オープンベータ版の仕様</a> をご覧ください。</p> <h4>現状の方針</h4> <p>日常業務で利用される操作のAPIを順次追加し、対応完了後に正式リリースする予定です。</p>",
"version": "0.0.0"
},
"tags": [
{
"name": "partner_management_orderer_company_users",
"description": "partner_management_orderer_company_users",
"x-displayName": "企業ユーザー"
},
{
"name": "partner_management_orderer_sections",
"description": "partner_management_orderer_sections",
"x-displayName": "部門"
},
{
"name": "partner_management_orderer_partners",
"description": "partner_management_orderer_partners",
"x-displayName": "パートナー"
}
],
"paths": {
"/hub/partner_management/orderer/company_users": {
"get": {
"operationId": "list_partner_management_orderer_company_users",
"summary": "企業ユーザー一覧取得(β版)",
"description": "企業ユーザーの一覧を取得する",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.name_contains"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.email"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.role_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.section_code"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.status"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.freee_account_integrated"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.two_factor_authentication_setting_type"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.ListRequest.saml_sso_enabled"
}
],
"responses": {
"200": {
"description": "企業ユーザー一覧レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.CompanyUser"
},
"description": "企業ユーザーのリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次ページのカーソルトークン。最終ページは null",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"partner_management_orderer_company_users"
]
}
},
"/hub/partner_management/orderer/company_users/{id}": {
"get": {
"operationId": "get_partner_management_orderer_company_user",
"summary": "企業ユーザー詳細取得(β版)",
"description": "企業ユーザー情報を取得する",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.GetRequest.company_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.CompanyUsers.GetRequest.id"
}
],
"responses": {
"200": {
"description": "企業ユーザー詳細レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.CompanyUser"
}
}
}
}
},
"tags": [
"partner_management_orderer_company_users"
]
}
},
"/hub/partner_management/orderer/sections": {
"get": {
"operationId": "list_partner_management_orderer_sections",
"summary": "部門一覧取得(β版)",
"description": "部門一覧を取得する",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Sections.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Sections.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Sections.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Sections.ListRequest.code"
}
],
"responses": {
"200": {
"description": "部門一覧レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Sections.Section"
},
"description": "部門のリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次ページのカーソルトークン。最終ページは null",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"partner_management_orderer_sections"
]
}
},
"/hub/partner_management/orderer/partners": {
"get": {
"operationId": "list_partner_management_orderer_partners",
"summary": "パートナー一覧取得(β版)",
"description": "パートナー一覧を取得する",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.company_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.page_size"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.page_token"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.status"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.name_contains"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.invoice_name_contains"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.email"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.custom_code"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.evaluation_rate_average_min"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.evaluation_rate_average_max"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.task_estimate_unit_price_min"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.task_estimate_unit_price_max"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.business_classification"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.has_invoice_number"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.tax_chargeable"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.withholding_tax_required"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.expense_withholding_tax_required"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.ListRequest.two_factor_authentication_setting_type"
}
],
"responses": {
"200": {
"description": "パートナー一覧レスポンス",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.Partner"
},
"description": "パートナーのリスト"
},
"next_page_token": {
"type": "string",
"nullable": true,
"description": "次ページのカーソルトークン。最終ページは null",
"example": "eyJvcmRlciI6W10sImlkIjoiYWJjIn0"
}
},
"required": [
"data",
"next_page_token"
],
"additionalProperties": false
}
}
}
}
},
"tags": [
"partner_management_orderer_partners"
]
}
},
"/hub/partner_management/orderer/partners/{id}": {
"get": {
"operationId": "get_partner_management_orderer_partner",
"summary": "パートナー詳細取得(β版)",
"description": "指定したパートナー1件のプロフィール・請求情報・源泉徴収設定・招待状態を取得する",
"parameters": [
{
"$ref": "#/components/parameters/FreeeUsingBetaHeader"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.GetRequest.company_id"
},
{
"$ref": "#/components/parameters/PartnerManagement.Orderer.Partners.GetRequest.id"
}
],
"responses": {
"200": {
"description": "パートナー詳細レスポンス",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.Partner"
}
}
}
}
},
"tags": [
"partner_management_orderer_partners"
]
}
}
},
"security": [
{
"OAuth2Auth": [
"write",
"read"
]
}
],
"components": {
"parameters": {
"FreeeUsingBetaHeader": {
"name": "freee-using-beta",
"in": "header",
"required": true,
"description": "オープンベータのエンドポイントのため `true` を指定(必須)",
"schema": {
"type": "string",
"enum": [
"true"
]
}
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "freee事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト20、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 20
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "カーソルトークン。前回レスポンスの next_page_token を指定する",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.name_contains": {
"name": "name_contains",
"in": "query",
"required": false,
"description": "氏名の部分一致で絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.email": {
"name": "email",
"in": "query",
"required": false,
"description": "メールアドレスの完全一致で絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.role_id": {
"name": "role_id",
"in": "query",
"required": false,
"description": "ロールIDで絞り込む",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.section_code": {
"name": "section_code",
"in": "query",
"required": false,
"description": "部門コードで絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.status": {
"name": "status",
"in": "query",
"required": false,
"description": "アカウント状態で絞り込む",
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.CompanyUserStatus"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.freee_account_integrated": {
"name": "freee_account_integrated",
"in": "query",
"required": false,
"description": "freeeアカウント連携済みかで絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.two_factor_authentication_setting_type": {
"name": "two_factor_authentication_setting_type",
"in": "query",
"required": false,
"description": "2FA設定タイプで絞り込む",
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.TwoFactorAuthenticationSettingType"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.ListRequest.saml_sso_enabled": {
"name": "saml_sso_enabled",
"in": "query",
"required": false,
"description": "SAML SSO設定済みかで絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.GetRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "freee事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.CompanyUsers.GetRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "取得対象の企業ユーザーID",
"schema": {
"type": "integer",
"format": "int32"
}
},
"PartnerManagement.Orderer.Sections.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "freee事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.Sections.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト20、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 20
},
"explode": false
},
"PartnerManagement.Orderer.Sections.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "カーソルトークン。前回レスポンスの next_page_token を指定する",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Sections.ListRequest.code": {
"name": "code",
"in": "query",
"required": false,
"description": "部門コードによる絞り込み",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "freee事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.page_size": {
"name": "page_size",
"in": "query",
"required": false,
"description": "1ページあたりの取得件数(デフォルト20、最大100)",
"schema": {
"type": "integer",
"format": "int32",
"minimum": 1,
"maximum": 100,
"default": 20
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.page_token": {
"name": "page_token",
"in": "query",
"required": false,
"description": "カーソルトークン。前回レスポンスの next_page_token を指定する",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.status": {
"name": "status",
"in": "query",
"required": false,
"description": "アカウント状態で絞り込む",
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.PartnerStatus"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.name_contains": {
"name": "name_contains",
"in": "query",
"required": false,
"description": "パートナー名の部分一致で絞り込む。招待未承諾時は招待時の名前、承諾済みは名前を対象",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.invoice_name_contains": {
"name": "invoice_name_contains",
"in": "query",
"required": false,
"description": "屋号の部分一致で絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.email": {
"name": "email",
"in": "query",
"required": false,
"description": "メールアドレスの完全一致で絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.custom_code": {
"name": "custom_code",
"in": "query",
"required": false,
"description": "カスタムコードの完全一致で絞り込む",
"schema": {
"type": "string"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.evaluation_rate_average_min": {
"name": "evaluation_rate_average_min",
"in": "query",
"required": false,
"description": "評価 (平均) の下限 (0.0〜5.0)で絞り込む",
"schema": {
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 5
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.evaluation_rate_average_max": {
"name": "evaluation_rate_average_max",
"in": "query",
"required": false,
"description": "評価 (平均) の上限 (0.0〜5.0)で絞り込む",
"schema": {
"type": "number",
"format": "double",
"minimum": 0,
"maximum": 5
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.task_estimate_unit_price_min": {
"name": "task_estimate_unit_price_min",
"in": "query",
"required": false,
"description": "タスク見積単価の下限で絞り込む",
"schema": {
"type": "number",
"format": "double",
"minimum": 0
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.task_estimate_unit_price_max": {
"name": "task_estimate_unit_price_max",
"in": "query",
"required": false,
"description": "タスク見積単価の上限で絞り込む",
"schema": {
"type": "number",
"format": "double",
"minimum": 0
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.business_classification": {
"name": "business_classification",
"in": "query",
"required": false,
"description": "事業者区分で絞り込む",
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.BusinessClassification"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.has_invoice_number": {
"name": "has_invoice_number",
"in": "query",
"required": false,
"description": "インボイス登録番号の有無で絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.tax_chargeable": {
"name": "tax_chargeable",
"in": "query",
"required": false,
"description": "消費税請求可否で絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.withholding_tax_required": {
"name": "withholding_tax_required",
"in": "query",
"required": false,
"description": "源泉所得税 (請求) が有効かで絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.expense_withholding_tax_required": {
"name": "expense_withholding_tax_required",
"in": "query",
"required": false,
"description": "源泉所得税 (経費) が有効かで絞り込む",
"schema": {
"type": "boolean"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.ListRequest.two_factor_authentication_setting_type": {
"name": "two_factor_authentication_setting_type",
"in": "query",
"required": false,
"description": "二要素認証の設定種別で絞り込む",
"schema": {
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.TwoFactorAuthenticationSettingType"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.GetRequest.company_id": {
"name": "company_id",
"in": "query",
"required": true,
"description": "freee事業所ID",
"schema": {
"type": "integer",
"format": "int64"
},
"explode": false
},
"PartnerManagement.Orderer.Partners.GetRequest.id": {
"name": "id",
"in": "path",
"required": true,
"description": "取得対象のパートナーID",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"schemas": {
"PartnerManagement.Orderer.CompanyUsers.CompanyUserStatus": {
"type": "string",
"enum": [
"active",
"invitation_pending"
],
"description": "アカウント状態 (active: 有効, invitation_pending: 招待中)"
},
"PartnerManagement.Orderer.CompanyUsers.TwoFactorAuthenticationSettingType": {
"type": "string",
"enum": [
"unset",
"mail",
"app"
],
"description": "2FA設定タイプ (unset: 未設定, mail: メール, app: アプリ)"
},
"PartnerManagement.Orderer.CompanyUsers.NotificationSettings": {
"type": "object",
"required": [
"mail",
"daily_mail",
"slack",
"line",
"chatwork"
],
"properties": {
"mail": {
"type": "boolean",
"description": "メール通知",
"example": true
},
"daily_mail": {
"type": "boolean",
"description": "デイリーメール通知",
"example": true
},
"slack": {
"type": "boolean",
"description": "Slack通知",
"example": true
},
"line": {
"type": "boolean",
"description": "LINE通知",
"example": true
},
"chatwork": {
"type": "boolean",
"description": "Chatwork通知",
"example": true
}
},
"description": "通知設定",
"additionalProperties": false
},
"PartnerManagement.Orderer.CompanyUsers.CompanyUser": {
"type": "object",
"required": [
"id",
"email",
"name",
"status",
"role_id",
"section_code",
"two_factor_authentication_setting_type",
"freee_account_integrated",
"saml_sso_enabled",
"notification_settings",
"invitation_sent_at",
"invitation_accepted_at",
"created_at"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "CompanyUser ID",
"example": 123
},
"email": {
"type": "string",
"description": "メールアドレス",
"example": "user@example.com"
},
"name": {
"type": "string",
"description": "氏名",
"example": "山田 太郎"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.CompanyUserStatus"
}
],
"description": "アカウント状態 (active: 有効, invitation_pending: 招待中)"
},
"role_id": {
"type": "integer",
"format": "int64",
"description": "ロールID。基本ロールは全企業共通で 1: オーナー, 2: マスター, 3: 経理, 4: メンバー で固定。",
"example": 12
},
"section_code": {
"type": "string",
"nullable": true,
"description": "部門コード。部門未設定の場合は null",
"example": "ABCD"
},
"two_factor_authentication_setting_type": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.TwoFactorAuthenticationSettingType"
}
],
"description": "2FA設定タイプ (unset: 未設定, mail: メール, app: アプリ)"
},
"freee_account_integrated": {
"type": "boolean",
"description": "freeeアカウント連携済みか",
"example": false
},
"saml_sso_enabled": {
"type": "boolean",
"description": "SAML SSO設定済みか",
"example": false
},
"notification_settings": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.CompanyUsers.NotificationSettings"
}
],
"description": "通知設定"
},
"invitation_sent_at": {
"type": "string",
"nullable": true,
"format": "date-time",
"description": "招待送信日時",
"example": "2025-11-20T09:00:00+09:00"
},
"invitation_accepted_at": {
"type": "string",
"nullable": true,
"format": "date-time",
"description": "招待受諾日時。未受諾は null",
"example": "2025-11-21T14:00:00+09:00"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "作成日時",
"example": "2025-11-19T10:00:00+09:00"
}
},
"description": "企業ユーザー",
"additionalProperties": false
},
"PartnerManagement.Orderer.Sections.Section": {
"type": "object",
"required": [
"id",
"name",
"code"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "Section ID",
"example": 34
},
"name": {
"type": "string",
"description": "部門名",
"example": "経理部"
},
"code": {
"type": "string",
"description": "部門コード",
"example": "ABCD"
}
},
"description": "部門",
"additionalProperties": false
},
"PartnerManagement.Orderer.Partners.PartnerStatus": {
"type": "string",
"enum": [
"active",
"invitation_pending"
],
"description": "アカウント状態 (active: 有効, invitation_pending: 招待中)"
},
"PartnerManagement.Orderer.Partners.BusinessClassification": {
"type": "string",
"enum": [
"taxable",
"exempt"
],
"description": "事業者区分 (taxable: 課税事業者, exempt: 免税事業者)"
},
"PartnerManagement.Orderer.Partners.TwoFactorAuthenticationSettingType": {
"type": "string",
"enum": [
"unset",
"mail",
"app"
],
"description": "二要素認証の設定種別 (unset: 未設定, mail: メール, app: アプリ)"
},
"PartnerManagement.Orderer.Partners.WithholdingTaxType": {
"type": "string",
"enum": [
"basic",
"custom"
],
"description": "源泉徴収税率の種別 (basic, custom)。basic は居住者(日本国内)向けの標準税率で、以下の計算式が適用される。\n\n100万円以下の場合\n\n源泉所得税 = 報酬・料金等の額 × 10.21%\n\n100万円を超える場合\n\n源泉所得税 = (報酬・料金等の額 - 1,000,000円) × 20.42% + 102,100円\n\ncustom は「源泉所得税率設定」で登録した税率を適用する"
},
"PartnerManagement.Orderer.Partners.AccountType": {
"type": "string",
"enum": [
"ordinary",
"current",
"savings"
],
"description": "口座種別 (ordinary: 普通, current: 当座, savings: 貯蓄)"
},
"PartnerManagement.Orderer.Partners.BankAccount": {
"type": "object",
"required": [
"bank_code",
"branch_code",
"account_type",
"account_number",
"account_holder",
"freeword_bank_name",
"freeword_branch_name",
"freeword_account_type"
],
"properties": {
"bank_code": {
"type": "string",
"nullable": true,
"description": "銀行コード(国内の金融機関)",
"example": "0034"
},
"branch_code": {
"type": "string",
"nullable": true,
"description": "支店コード(国内の金融機関)",
"example": "101"
},
"account_type": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.AccountType"
}
],
"nullable": true,
"description": "口座種別 (ordinary: 普通, current: 当座, savings: 貯蓄)。海外の金融機関の時は null"
},
"account_number": {
"type": "string",
"description": "口座番号",
"example": "1234567"
},
"account_holder": {
"type": "string",
"description": "口座名義 (半角カナ)",
"example": "ヤマダ タロウ"
},
"freeword_bank_name": {
"type": "string",
"nullable": true,
"description": "銀行名(海外の金融機関)"
},
"freeword_branch_name": {
"type": "string",
"nullable": true,
"description": "支店名(海外の金融機関)"
},
"freeword_account_type": {
"type": "string",
"nullable": true,
"description": "口座種別(海外の金融機関)"
}
},
"description": "銀行口座。国内の金融機関の時は bank_code / branch_code / account_type 系、海外の金融機関の時は freeword_* 系が埋まる",
"additionalProperties": false
},
"PartnerManagement.Orderer.Partners.Partner": {
"type": "object",
"required": [
"id",
"email",
"name",
"status",
"invited_at",
"invitation_accepted_at",
"freee_partner_id",
"custom_code",
"memo",
"task_estimate_unit_price",
"task_quantity_unit",
"task_estimate_quantity",
"taxpayer_number",
"withholding_tax_required",
"withholding_tax_type",
"custom_withholding_tax_rate",
"expense_withholding_tax_required",
"expense_withholding_tax_type",
"custom_expense_withholding_tax_rate",
"order_amount_limit",
"invoice_name",
"postal_code",
"address",
"phone_number",
"business_classification",
"bank_account"
],
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "パートナーID",
"example": 1
},
"email": {
"type": "string",
"description": "メールアドレス。招待未承諾時は招待時に指定したメールアドレスを返す",
"example": "partner@example.com"
},
"name": {
"type": "string",
"description": "氏名。招待未承諾時は招待時に指定した名前を返す",
"example": "山田 太郎"
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.PartnerStatus"
}
],
"description": "アカウント状態 (active: 有効, invitation_pending: 招待中)"
},
"invited_at": {
"type": "string",
"format": "date-time",
"description": "招待送信日時",
"example": "2025-09-09T19:18:00+09:00"
},
"invitation_accepted_at": {
"type": "string",
"nullable": true,
"format": "date-time",
"description": "招待受諾日時",
"example": "2025-09-09T20:00:00+09:00"
},
"freee_partner_id": {
"type": "string",
"nullable": true,
"description": "freee連携の取引先ID",
"example": "123"
},
"custom_code": {
"type": "string",
"nullable": true,
"description": "企業が任意に付与する管理コード (企業内で一意)",
"example": "custom_id_1"
},
"memo": {
"type": "string",
"nullable": true,
"description": "企業がパートナーごとに任意で記録する社内メモ",
"example": "連絡は Slack 優先。請求は月末締め翌月末払い"
},
"task_estimate_unit_price": {
"type": "string",
"nullable": true,
"format": "decimal",
"description": "発注時のデフォルト単価 (税抜)",
"example": "60000.0"
},
"task_quantity_unit": {
"type": "string",
"description": "発注時のデフォルト数量の単位。デフォルト「件」",
"example": "件"
},
"task_estimate_quantity": {
"type": "string",
"nullable": true,
"format": "decimal",
"description": "発注時のデフォルト数量",
"example": "100.0"
},
"taxpayer_number": {
"type": "string",
"nullable": true,
"description": "インボイス登録番号。招待未承諾時は null",
"example": "T1234567890123"
},
"withholding_tax_required": {
"type": "boolean",
"nullable": true,
"description": "請求書の源泉徴収を必須とするか",
"example": true
},
"withholding_tax_type": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.WithholdingTaxType"
}
],
"nullable": true,
"description": "請求書の源泉徴収税率の種別"
},
"custom_withholding_tax_rate": {
"type": "string",
"nullable": true,
"format": "decimal",
"description": "請求書の源泉徴収のカスタム税率。種別が custom の時に設定される"
},
"expense_withholding_tax_required": {
"type": "boolean",
"nullable": true,
"description": "経費の源泉徴収を必須とするか",
"example": false
},
"expense_withholding_tax_type": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.WithholdingTaxType"
}
],
"nullable": true,
"description": "経費の源泉徴収税率の種別"
},
"custom_expense_withholding_tax_rate": {
"type": "string",
"nullable": true,
"format": "decimal",
"description": "経費の源泉徴収のカスタム税率。種別が custom の時に設定される",
"example": "20.24"
},
"order_amount_limit": {
"type": "integer",
"format": "int32",
"nullable": true,
"description": "発注金額の上限 (円)",
"example": 1000000
},
"invoice_name": {
"type": "string",
"nullable": true,
"description": "屋号(請求書宛名)。招待未承諾時は null",
"example": "山田デザイン事務所"
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "郵便番号。招待未承諾時は null",
"example": "123-4567"
},
"address": {
"type": "string",
"nullable": true,
"description": "住所。招待未承諾時は null",
"example": "XX県XX市XXビル204号"
},
"phone_number": {
"type": "string",
"nullable": true,
"description": "電話番号。招待未承諾時は null",
"example": "0312345678"
},
"business_classification": {
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.BusinessClassification"
}
],
"nullable": true,
"description": "事業者区分 (taxable: 課税事業者, exempt: 免税事業者)。招待未承諾時は null"
},
"bank_account": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/PartnerManagement.Orderer.Partners.BankAccount"
}
],
"nullable": true,
"description": "銀行口座。招待未承諾時は null"
}
},
"description": "パートナー",
"additionalProperties": false
}
},
"securitySchemes": {
"OAuth2Auth": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.secure.freee.co.jp/public_api/authorize",
"tokenUrl": "https://accounts.secure.freee.co.jp/public_api/token",
"scopes": {
"write": "",
"read": ""
}
}
}
}
}
},
"servers": [
{
"url": "https://api.freee.co.jp",
"description": "",
"variables": {}
}
]
}