Skip to content

partner — 取引先

取引先のCRUD操作を行います。

サブコマンド

サブコマンド説明
list取引先一覧を表示
show <id>取引先の詳細を表示
create取引先を作成
update <id>取引先を更新
delete <id>取引先を削除

partner list

freee partner list [flags]

フラグ

フラグ必須説明
--formatstring任意出力形式: table / json / yaml / csv
--no-headerbool任意ヘッダー行を非表示

partner show

freee partner show <id> [flags]

フラグ

フラグ必須説明
--formatstring任意出力形式: table / json / yaml / csv

partner create

freee partner create [flags]

フラグ

フラグ必須説明
--namestring必須取引先名
--codestring任意取引先コード
--long-namestring任意正式名称
--shortcut1string任意ショートカット1(カナ)
--shortcut2string任意ショートカット2
--country-codestring任意国コード(デフォルト: JP
--dry-runbool任意APIを呼ばずにリクエスト内容を確認
--formatstring任意出力形式: table / json / yaml / csv

partner update

freee partner update <id> [flags]

フラグ

フラグ必須説明
--namestring任意取引先名
--codestring任意取引先コード
--long-namestring任意正式名称
--shortcut1string任意ショートカット1(カナ)
--shortcut2string任意ショートカット2
--country-codestring任意国コード
--dry-runbool任意APIを呼ばずにリクエスト内容を確認

partner delete

freee partner delete <id> [--dry-run]

使用例

bash
# 取引先一覧
freee partner list
ID     NAME          CODE
10001  株式会社ABC   ABC
10002  株式会社XYZ   XYZ
bash
# 取引先の詳細
freee partner show 10001
ID:        10001
Name:      株式会社ABC
Code:      ABC
Long Name: 株式会社エービーシー
Shortcut1: エービーシー
Country:   JP
Available: true
Updated:   2026-04-01
bash
# 取引先を作成
freee partner create \
  --name 株式会社DEF \
  --code DEF \
  --shortcut1 デーイーエフ

# 取引先名を更新
freee partner update 10001 --name "ABC株式会社"

# 取引先を削除
freee partner delete 10001