All skills
freee avatar

/freee-api-skill

@f5d1212
by freeefreee/freee-mcp503 stars
58

freee-mcp / freee-sign-mcp と連携するスキル。会計・人事労務・請求書・工数管理・販売・IT管理・固定資産・業務委託管理・サーベイ・開業・人事評価・申告・サイン(電子契約)の詳細APIリファレンスと使い方ガイドを提供。freee の経費申請・取引登録・勤怠打刻・給与明細・見積書・試算表・仕訳・従業員管理・工数登録・売上管理・SaaSアカウント管理・備品管理・固定資産管理・業務委託先の企業ユーザー/部門管理・サーベイ企画/実施回の取得・開業申請用データの参照/更新・人事評価結果の取得・法人税申告データや帳票の参照・電子契約の文書管理などの操作やAPI仕様を調べたいときに使う。ユーザーが freee のデータ操作、会計処理、人事労務管理、請求・見積、プロジェクト工数管理、販売管理、IT管理、固定資産管理、業務委託管理、サーベイ、開業、人事評価、申告、電子契約について質問や操作を依頼してきた場合は、明示的に freee と言及していなくても、このスキルの利用を検討すること。サインは別途 freee-sign-mcp の設定が必要。

Use this Skill: https://skilld.dev/gh/freee/freee-mcp/freee-api-skill

This session only. Nothing lands on disk.

referencesaccounting-partners.md

≈7.8k tokens on demand. Your agent reads this file only when SKILL.md points to it.

Partners

取引先

GET /api/1/partners — 取引先一覧の取得

概要 指定した事業所に登録されている取引先の一覧を取得します。取引・請求書・支払依頼などの取引先マスタとして参照する用途を想定しています。

注意点 アーカイブされた取引先は含まれません。 keyword は、取引先コード・取引先名・正式名称・カナ名称・ショートカット1・2 のいずれかへの部分一致で絞り込みます。半角スペース・全角スペース・タブで区切ると AND 検索になります。 start_update_date / end_update_date で更新日を範囲指定できます。JST の日付を yyyy-mm-dd で指定してください。 取引先コード(code)は、事業所設定で「取引先コードの利用」が有効な場合のみ実際の値が返り、無効な場合は null が返ります。 振込元口座ID(payer_walletable_id)、振込手数料負担(transfer_fee_handling_side)は法人スタータープラン(および旧法人プロフェッショナルプラン)以上の事業所でのみ返却されます。

パラメータ

  • company_id*: integer(int64) - 事業所ID。取得対象の事業所を指定します。

  • start_update_date: string - 更新日で絞り込む開始日 (yyyy-mm-dd, JST)。指定日以降に更新された取引先を対象にします。

  • end_update_date: string - 更新日で絞り込む終了日 (yyyy-mm-dd, JST)。指定日以前に更新された取引先を対象にします。

  • offset: integer(int64) - 取得レコードのオフセット (デフォルト: 0)。ページング用に、スキップする件数を指定します。

  • limit: integer(int64) - 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)。1 回のリクエストで取得する上限件数を指定します。

  • keyword: string - 検索キーワード。取引先コード・取引先名・正式名称・カナ名称・ショートカットキー1・2 のいずれかに対する部分一致で絞り込みます。 以下のいずれかで区切って複数キーワードを指定した場合は AND 検索になります。

    半角スペース

    全角スペース

    タブ

レスポンス

取引先一覧の取得に成功しました。

  • partners*: array[object] - 取引先の配列。offset / limit / keyword / start_update_date / end_update_date の条件で絞り込まれた結果が id 昇順で返ります。件数がない場合は空配列。

POST /api/1/partners — 取引先の作成

概要 指定した事業所に新しい取引先を作成します。取引や請求書で参照する取引先マスタを新規登録する用途で利用します。

注意点 取引先名称(name)は事業所内で重複できません。すでに同名の取引先が存在するとエラーになります。 code は、事業所設定で「取引先コードの利用」を有効にしている場合のみ利用可能です。 有効時は code の指定が必須で、name・code いずれも重複不可です。 無効時に code を指定するとエラーになります。 作成された取引先の available(使用可能フラグ)は常に true になります。 以下の属性は法人スタータープラン(および旧法人プロフェッショナルプラン)以上の事業所でのみ設定・返却されます。無料プラン等では指定しても無視されます。 振込元口座ID(payer_walletable_id) 振込手数料負担(transfer_fee_handling_side) 支払期日設定(payment_term_attributes) 請求の入金期日設定(invoice_payment_term_attributes)

リクエストボディ*

  • company_id*: integer(int64) - 事業所ID。作成先の事業所を指定します。 例: 1 (最小: 1)

  • name*: string - 取引先名 (255 文字以内、事業所内で重複不可)。取引・請求書で参照される表示名。 例: 新しい取引先

  • code: string - 取引先コード。事業所設定で「取引先コードの利用」を有効にしている場合は必須で、事業所内で重複不可。無効な事業所では指定するとエラーになります。 例: code001

  • shortcut1: string - ショートカット1 (255 文字以内)。取引先検索用の任意キーワード。 例: NEWPARTNER

  • shortcut2: string - ショートカット2 (255 文字以内)。shortcut1 と併用可能な補助キーワード。 例: 502

  • org_code: integer(int64) - 事業所種別。

    null: 未設定(デフォルト)

    1: 法人

    2: 個人 (選択肢: 1, 2) 例: 1

  • country_code: string - 地域。指定しない場合は JP になります。

    JP: 国内

    ZZ: 国外 (選択肢: JP, ZZ) 例: JP

  • long_name: string - 正式名称(255 文字以内)。取引先の正式な法人・屋号名称。請求書などの帳票に印字される名称。 例: 株式会社ABC商店

  • name_kana: string - カナ名称(255 文字以内)。取引先名の全角カナ表記。Web 画面のカナ検索で利用されます。 例: エービーシーショウテン

  • default_title: string - 敬称。請求書などで取引先名の後ろに付与される敬称。御中、様、(空白) の 3 つから選択します。 例: 御中

  • phone: string - 電話番号。取引先の連絡先電話番号。フォーマット制約はありません。 例: 03-1234-5678

  • contact_name: string - 担当者 氏名 (255 文字以内)。取引先窓口の担当者名。 例: freee太郎

  • email: string - 担当者 メールアドレス (255 文字以内)。取引先窓口の担当者メールアドレス。 例: contact@example.com

  • payer_walletable_id: integer(int64) - 振込元口座ID(一括振込ファイル用)。walletable の type が 'bank_account' の口座 ID のみ指定できます。未設定にする場合は null を指定してください。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能で、それ未満の事業所では指定しても無視されます。 例: 1 (最小: 1)

  • transfer_fee_handling_side: string - 振込手数料負担(一括振込ファイル用)。指定しない場合は payer になります。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能で、それ未満の事業所では指定しても無視されます。

    payer: 振込元(当方)負担

    payee: 振込先(先方)負担 (選択肢: payer, payee) 例: payer

  • qualified_invoice_issuer: boolean - インボイス制度適格請求書発行事業者フラグ。デフォルトは false。

    true: 適格請求書発行事業者

    false: 非対象事業者

    国税庁インボイス制度適格請求書発行事業者公表サイト 例: false

  • invoice_registration_number: string - インボイス制度適格請求書発行事業者登録番号。先頭 T + 数字 13 桁の固定 14 文字(先頭 T なしの数字 13 桁も許容)。 国税庁インボイス制度適格請求書発行事業者公表サイト 例: T1000000000001 (パターン: ^T?[1-9][0-9]{12}$)

  • address_attributes: object - 住所情報。省略した場合、address_attributes 自体が未設定になります。country_code を指定していれば address_attributes を省略しても地域は反映されます。

    • zipcode: string - 郵便番号(ハイフン含む可、8 文字以内)。 例: 000-0000
    • prefecture_code: integer(int64) - 都道府県コード(-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:沖縄) 例: 4 (最小: -1, 最大: 46)
    • street_name1: string - 市区町村・番地(255 文字以内)。 例: 千代田区丸の内1-1-1
    • street_name2: string - 建物名・部屋番号など(255 文字以内)。 例: freeeビル 10F
  • partner_doc_setting_attributes: object - 請求書送付方法の設定。

    • sending_method: string - 請求書送付方法。null を指定すると未設定になります。

      email: メール

      posting: 郵送

      email_and_posting: メールと郵送

      pdf_delivery: メール(PDFファイル添付)

      pdf_delivery_and_posting: メール(PDFファイル添付)と郵送 (選択肢: email, posting, email_and_posting, pdf_delivery, pdf_delivery_and_posting) 例: posting

  • partner_bank_account_attributes: object - 銀行口座情報(この取引先の受取口座)。

    • bank_name: string - 銀行名。 例: freee銀行

    • bank_name_kana: string - 銀行名(カナ)。 例: フリーギンコウ

    • bank_code: string - 銀行コード(4 桁の統一金融機関コード)。 例: 0001

    • branch_name: string - 支店名。 例: 銀座支店

    • branch_kana: string - 支店名(カナ)。 例: ギンザシテン

    • branch_code: string - 支店番号(3 桁)。 例: 101

    • account_type: string - 口座種別。指定しない場合は ordinary になります。

      ordinary: 普通

      checking: 当座

      earmarked: 納税準備預金

      savings: 貯蓄

      other: その他 例: ordinary

    • account_number: string - 口座番号。 例: 1010101

    • long_account_name: string - 受取人名。 例: freee太郎

    • account_name: string - 受取人名(カナ)。全銀フォーマットで送信する際に使用されます。 例: フリータロウ

  • payment_term_attributes: object - 支払期日設定。この取引先への支払日を締め日基準で計算するための設定。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。cutoff_day / additional_months / fixed_day を組み合わせて指定します。

    • cutoff_day: integer(int64) - 締め日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 15 (最小: 1, 最大: 32)
    • additional_months: integer(int64) - 支払月。締め日から数えて何ヶ月後に支払うか。当月を指定する場合は 0 を指定してください。 例: 1 (最小: 0, 最大: 6)
    • fixed_day: integer(int64) - 支払日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 32 (最小: 1, 最大: 32)
  • invoice_payment_term_attributes: object - 請求の入金期日設定。この取引先からの入金日を締め日基準で計算するための設定。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。

    • cutoff_day: integer(int64) - 締め日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 15 (最小: 1, 最大: 32)
    • additional_months: integer - 入金月。締め日から数えて何ヶ月後に入金されるか。当月を指定する場合は 0 を指定してください。 例: 1 (最小: 0, 最大: 6)
    • fixed_day: integer(int64) - 入金日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 32 (最小: 1, 最大: 32)

レスポンス

取引先の作成に成功しました。作成された取引先が返ります。

  • partner*: object

GET /api/1/partners/{id} — 取引先の取得

概要 指定した事業所の取引先 1 件を ID を指定して取得します。取引先の詳細確認や、更新前の現在値取得に利用します。

注意点 取引先コード(code)は、事業所設定で「取引先コードの利用」が有効な場合のみ実際の値が返り、無効な場合は null が返ります。 アーカイブ済みの取引先は取得対象になり得ますが、更新・削除はできません。 以下の属性は法人スタータープラン(および旧法人プロフェッショナルプラン)以上の事業所でのみ返却されます。 振込元口座ID(payer_walletable_id) 振込手数料負担(transfer_fee_handling_side) 支払期日設定(payment_term_attributes) 請求の入金期日設定(invoice_payment_term_attributes)

パラメータ

  • id* (path): integer(int64) - 取引先ID。取得対象の取引先を指定します。
  • company_id*: integer(int64) - 事業所ID。取引先が属する事業所を指定します。

レスポンス

取引先の取得に成功しました。

  • partner*: object

PUT /api/1/partners/{id} — 取引先の更新

概要 指定した取引先の情報を更新します。id で更新対象を特定します。取引先コード(code)をキーに更新したい場合は PUT /api/1/partners/code/{code} を利用してください。

注意点 取引先名称(name)は事業所内で重複できません。 取引先コード(code)は本 API では指定・更新できません(指定するとエラーになります)。code をキーに更新したい場合は PUT /api/1/partners/code/{code} を、code 自体を新しい値に変更する用途は本 API ではサポートしていません。 本 API は PATCH 相当の挙動をします。リクエストに含まれていない属性は更新されず、既存値が保持されます。属性を「未設定に戻したい」場合は、payment_term_attributes / invoice_payment_term_attributes のみ null を指定できます(他の属性は未設定化の指定不可)。 以下の属性は法人スタータープラン(および旧法人プロフェッショナルプラン)以上の事業所でのみ設定できます。無料プラン等では指定し...

パラメータ

  • id* (path): integer(int64) - 取引先ID。更新対象の取引先を指定します。

リクエストボディ*

  • company_id*: integer(int64) - 事業所ID。取引先が属する事業所を指定します。 例: 1 (最小: 1)

  • name*: string - 取引先名 (255 文字以内、事業所内で重複不可)。 例: 新しい取引先

  • available: boolean - 使用可能フラグ。false を指定すると Web 画面の入力候補として表示されなくなります(取引先自体は削除されません)。

    true: 使用可能

    false: 使用停止 例: false

  • shortcut1: string - ショートカット1 (255 文字以内)。取引先検索用の任意キーワード。 例: NEWPARTNER

  • shortcut2: string - ショートカット2 (255 文字以内)。shortcut1 と併用可能な補助キーワード。 例: 502

  • org_code: integer(int64) - 事業所種別。null を指定すると未設定に戻ります。

    null: 未設定

    1: 法人

    2: 個人 (選択肢: 1, 2) 例: 1

  • country_code: string - 地域。指定しない場合は JP になります。

    JP: 国内

    ZZ: 国外 (選択肢: JP, ZZ) 例: JP

  • long_name: string - 正式名称(255 文字以内)。取引先の正式な法人・屋号名称。 例: 株式会社ABC商店

  • name_kana: string - カナ名称(255 文字以内)。取引先名の全角カナ表記。 例: エービーシーショウテン

  • default_title: string - 敬称。御中、様、(空白) の 3 つから選択します。 例: 御中

  • phone: string - 電話番号。フォーマット制約はありません。 例: 03-1234-5678

  • contact_name: string - 担当者 氏名 (255 文字以内)。 例: freee太郎

  • email: string - 担当者 メールアドレス (255 文字以内)。 例: contact@example.com

  • payer_walletable_id: integer(int64) - 振込元口座ID(一括振込ファイル用)。walletable の type が 'bank_account' の口座 ID のみ指定できます。未設定にする場合は null。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。 例: 1 (最小: 1)

  • transfer_fee_handling_side: string - 振込手数料負担(一括振込ファイル用)。指定しない場合は payer になります。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。

    payer: 振込元(当方)負担

    payee: 振込先(先方)負担 (選択肢: payer, payee) 例: payer

  • qualified_invoice_issuer: boolean - インボイス制度適格請求書発行事業者フラグ。

    true: 適格請求書発行事業者

    false: 非対象事業者

    国税庁インボイス制度適格請求書発行事業者公表サイト 例: false

  • invoice_registration_number: string - インボイス制度適格請求書発行事業者登録番号。先頭 T + 数字 13 桁の固定 14 文字(先頭 T なしの数字 13 桁も許容)。 国税庁インボイス制度適格請求書発行事業者公表サイト 例: T1000000000001 (パターン: ^T?[1-9][0-9]{12}$)

  • address_attributes: object - 住所情報。指定した属性のみ更新されます(省略した属性は既存値を維持)。

    • zipcode: string - 郵便番号(ハイフン含む可、8 文字以内)。 例: 000-0000
    • prefecture_code: integer(int64) - 都道府県コード(-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:沖縄) 例: 4 (最小: -1, 最大: 46)
    • street_name1: string - 市区町村・番地(255 文字以内)。 例: 千代田区丸の内1-1-1
    • street_name2: string - 建物名・部屋番号など(255 文字以内)。 例: freeeビル 10F
  • partner_doc_setting_attributes: object - 請求書送付方法の設定。

    • sending_method: string - 請求書送付方法。null を指定すると未設定になります。

      email: メール

      posting: 郵送

      email_and_posting: メールと郵送

      pdf_delivery: メール(PDFファイル添付)

      pdf_delivery_and_posting: メール(PDFファイル添付)と郵送 (選択肢: email, posting, email_and_posting, pdf_delivery, pdf_delivery_and_posting) 例: posting

  • partner_bank_account_attributes: object - 銀行口座情報(この取引先の受取口座)。指定した属性のみ更新されます。account_type に空文字を指定した場合は ordinary で置き換わる点に注意してください。

    • bank_name: string - 銀行名。 例: freee銀行

    • bank_name_kana: string - 銀行名(カナ)。 例: フリーギンコウ

    • bank_code: string - 銀行コード(4 桁の統一金融機関コード)。 例: 0001

    • branch_name: string - 支店名。 例: 銀座支店

    • branch_kana: string - 支店名(カナ)。 例: ギンザシテン

    • branch_code: string - 支店番号(3 桁)。 例: 101

    • account_type: string - 口座種別。指定しない場合は既存値を維持します(空文字は ordinary で置き換わります)。

      ordinary: 普通

      checking: 当座

      earmarked: 納税準備預金

      savings: 貯蓄

      other: その他 例: ordinary

    • account_number: string - 口座番号。 例: 1010101

    • long_account_name: string - 受取人名。 例: freee太郎

    • account_name: string - 受取人名(カナ)。全銀フォーマットで送信する際に使用されます。 例: フリータロウ

  • payment_term_attributes: object - 支払期日設定。null を指定すると期日設定を未設定に戻します。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。cutoff_day / additional_months / fixed_day はまとめて指定する必要があります(一部だけの更新はできません)。

    • cutoff_day: integer(int64) - 締め日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 15 (最小: 1, 最大: 32)
    • additional_months: integer(int64) - 支払月。締め日から数えて何ヶ月後に支払うか。当月を指定する場合は 0 を指定してください。 例: 1 (最小: 0, 最大: 6)
    • fixed_day: integer(int64) - 支払日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 32 (最小: 1, 最大: 32)
  • invoice_payment_term_attributes: object - 請求の入金期日設定。null を指定すると期日設定を未設定に戻します。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。cutoff_day / additional_months / fixed_day はまとめて指定する必要があります。

    • cutoff_day: integer(int64) - 締め日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 15 (最小: 1, 最大: 32)
    • additional_months: integer(int64) - 入金月。締め日から数えて何ヶ月後に入金されるか。当月を指定する場合は 0 を指定してください。 例: 1 (最小: 0, 最大: 6)
    • fixed_day: integer(int64) - 入金日。1〜31 の日付を指定します。29, 30, 31 日の末日を指定する場合は 32 を指定してください。 例: 32 (最小: 1, 最大: 32)

レスポンス

取引先の更新に成功しました。更新後の取引先が返ります。

  • partner*: object

DELETE /api/1/partners/{id} — 取引先の削除

概要 指定した事業所の取引先を削除します。取引で参照されている取引先は削除できないため、削除に失敗した場合は該当取引先の参照を先に解消してください。

注意点 削除された取引先は復元できません。使用停止のみ行いたい場合は、代わりに PUT で available を false に更新することを検討してください。 アーカイブ済みの取引先は削除できません。Web 画面からアーカイブを解除してから再度お試しください。

パラメータ

  • id* (path): integer(int64) - 取引先ID。削除対象の取引先を指定します。
  • company_id*: integer(int64) - 事業所ID。取引先が属する事業所を指定します。

レスポンス

取引先の削除に成功しました。レスポンスボディはありません。

PUT /api/1/partners/code/{code} — 取引先コードでの取引先の更新

概要 取引先コード(code)をキーに、指定した取引先の情報を更新します。取引先 ID を持たず取引先コードで運用しているシステムからの更新用途を想定しています。

注意点 本 API を利用するには、事業所設定で「取引先コードの利用」を有効にしている必要があります。無効な事業所への呼び出しはエラーになります。 code に日本語や記号を含む場合は、URL エンコードして URL に含めてください。 取引先名称(name)は事業所内で重複できません。 本 API では id の指定はできません(指定するとエラーになります)。 本 API は PATCH 相当の挙動をします。リクエストに含まれていない属性は更新されず、既存値が保持されます。payment_term_attributes / invoice_payment_term_attributes に null を指定すると期日設定を未設定に戻せます。 以下の属性は法人スタータープラン(および旧法人プロフェッショナルプラン)以上の事業所でのみ設定できます。 振込元口座ID(payer_walletable_id) 振込手数料負担(tr...

パラメータ

  • code* (path): string - 取引先コード。更新対象の取引先を特定するキー。日本語・記号を含む場合は URL エンコードして指定してください。

リクエストボディ*

PUT /api/1/partners/{id} と同じ

レスポンス

PUT /api/1/partners/{id} と同じ

PUT /api/1/partners/upsert_by_code — 取引先の更新(存在しない場合は作成)

概要 取引先コード(code)をキーに、指定した取引先の情報を更新します。該当する取引先が存在しない場合は新規作成します(upsert)。同期処理を伴う外部システムとの連携で、取引先マスタを一括で登録・更新する用途を想定しています。

注意点 本 API を利用するには、事業所設定で「取引先コードの利用」を有効にしている必要があります。無効な事業所への呼び出しはエラーになります。 取引先名称(name)は事業所内で重複できません。 partner オブジェクト内で code を指定することはできません(変更不可)。URL パスの code のみが有効です。 更新レスポンスは 200 OK、新規作成レスポンスは 201 Created で返ります。作成・更新のどちらが行われたかは HTTP ステータスコードで判別してください。 更新時は PATCH 相当の挙動をします。リクエストに含まれていない属性は既存値が保持されます。payment_term_attributes / invoice_payment_term_attributes に null を指定すると期日設定を未設定に戻せます。...

リクエストボディ*

  • code*: string - 取引先コード。upsert のキーになります。事業所内で重複不可。事業所設定で「取引先コードの利用」が有効になっている必要があります。 例: code001
  • company_id*: integer(int64) - 事業所ID。upsert 先の事業所を指定します。 例: 1 (最小: 1)
  • partner*: object - 取引先の属性。更新経路では PATCH 相当の挙動で、指定した属性のみ既存値を上書きします(payment_term_attributes / invoice_payment_term_attributes のみ null 指定で未設定に戻せます)。作成経路(該当 code が存在しない場合)では、name 以外の属性は省略時にデフォルト値になります。
    • name*: string - 取引先名 (255 文字以内、事業所内で重複不可)。 例: 新しい取引先

    • available: boolean - 使用可能フラグ。更新経路でのみ有効。

      true: 使用可能

      false: 使用停止 例: false

    • shortcut1: string - ショートカット1 (255 文字以内)。取引先検索用の任意キーワード。 例: NEWPARTNER

    • shortcut2: string - ショートカット2 (255 文字以内)。shortcut1 と併用可能な補助キーワード。 例: 502

    • org_code: integer(int64) - 事業所種別。null を指定すると未設定になります。

      null: 未設定

      1: 法人

      2: 個人 (選択肢: 1, 2) 例: 1

    • country_code: string - 地域。指定しない場合は JP になります。

      JP: 国内

      ZZ: 国外 (選択肢: JP, ZZ) 例: JP

    • long_name: string - 正式名称(255 文字以内)。取引先の正式な法人・屋号名称。 例: 株式会社ABC商店

    • name_kana: string - カナ名称(255 文字以内)。取引先名の全角カナ表記。 例: エービーシーショウテン

    • default_title: string - 敬称。御中、様、(空白) の 3 つから選択します。 例: 御中

    • phone: string - 電話番号。フォーマット制約はありません。 例: 03-1234-5678

    • contact_name: string - 担当者 氏名 (255 文字以内)。 例: freee太郎

    • email: string - 担当者 メールアドレス (255 文字以内)。 例: contact@example.com

    • payer_walletable_id: integer(int64) - 振込元口座ID(一括振込ファイル用)。walletable の type が 'bank_account' の口座 ID のみ指定できます。未設定にする場合は null。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。 例: 1 (最小: 1)

    • transfer_fee_handling_side: string - 振込手数料負担(一括振込ファイル用)。指定しない場合は payer になります。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。

      payer: 振込元(当方)負担

      payee: 振込先(先方)負担 (選択肢: payer, payee) 例: payer

    • qualified_invoice_issuer: boolean - インボイス制度適格請求書発行事業者フラグ。

      true: 適格請求書発行事業者

      false: 非対象事業者

      国税庁インボイス制度適格請求書発行事業者公表サイト 例: false

    • invoice_registration_number: string - インボイス制度適格請求書発行事業者登録番号。先頭 T + 数字 13 桁の固定 14 文字(先頭 T なしの数字 13 桁も許容)。 国税庁インボイス制度適格請求書発行事業者公表サイト 例: T1000000000001 (パターン: ^T?[1-9][0-9]{12}$)

    • address_attributes: object - 住所情報。更新経路では指定した属性のみ上書きし、省略した属性は既存値を維持します。

    • partner_doc_setting_attributes: object - 請求書送付方法の設定。

    • partner_bank_account_attributes: object - 銀行口座情報(この取引先の受取口座)。更新経路では指定した属性のみ上書きし、省略した属性は既存値を維持します。account_type に空文字を指定した場合は ordinary で置き換わる点に注意してください。

    • payment_term_attributes: object - 支払期日設定。更新経路では null を指定すると期日設定を未設定に戻せます。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。cutoff_day / additional_months / fixed_day はまとめて指定する必要があります。

    • invoice_payment_term_attributes: object - 請求の入金期日設定。更新経路では null を指定すると期日設定を未設定に戻せます。法人スタータープラン(および旧法人プロフェッショナルプラン)以上でのみ設定可能。cutoff_day / additional_months / fixed_day はまとめて指定する必要があります。

レスポンス

既存の取引先を更新しました。更新後の取引先が返ります。

  • partner*: object

Source: SKILL.md on GitHub

1 warningtoday5 checks · Risk SAFE
  • Gen Agent Trust Hubtoday

    This skill provides a comprehensive interface for AI agents to interact with the freee suite of APIs (Accounting, HR, Invoices, IT Management, etc.) via the Model Context Protocol (MCP). It includes exhaustive documentation, usage recipes, and security-conscious guidelines that instruct the agent to treat all retrieved financial and tax data as information rather than executable commands.

  • Sockettoday

    No alerts

  • Snyktoday

    Risk: MEDIUM · 1 issue

  • Runlayer6mo

    3/83 files flagged

  • ZeroLeaks5mo

    Score: 93/100 · 2 sections analyzed

Signed by skilld at f5d1212. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 2 days ago.

Activeupdated 3 weeks ago
metadata
{
  "author": "freee_jp",
  "homepage": "https://github.com/freee/freee-mcp"
}
  • API
  • MCP
  • freee
  • accounting
  • hr
  • invoicing
  • project-management
  • expense-tracking
  • payroll

README badge

README badge for freee/freee-mcp

Provides detailed API reference and usage guides for freee's accounting, HR, invoicing, project management, sales, and IT management services through the freee-mcp MCP server. Use this skill when you need to query or perform operations on freee data like expense reports, transactions, employee records, timesheets, invoices, or project hours.

Generated from the current SKILL.md.

Does this skill work with both Remote MCP and local setup?
Yes. The skill supports Remote MCP (recommended, auto-authenticated via browser) and local MCP server setup (requires running `npx freee-mcp configure`). Use `freee_server_info` to check which transport mode is active.
Which freee products does this skill cover?
The skill covers accounting, HR/payroll, invoicing, project time tracking, sales management, IT management, and expense applications. Signing (electronic contracts) requires a separate `freee-sign-mcp` setup.
Do I need to specify a company ID for API calls?
Yes. You must first fetch the current company ID using `freee_get_current_company`, and it must match the company you want to operate on. Use `freee_set_current_company` to switch between companies before making API calls.
What should I do if I get an authentication error?
For Remote MCP, the client will prompt for re-authentication; if that fails, remove and re-add the custom connector. For local mode, use `freee_auth_status` to check status, then run `freee_clear_auth` followed by `freee_authenticate`.
Where do I find API details and usage examples?
The skill includes `recipes/` for common workflows (expense applications, deals, payroll, invoicing, etc.) and `references/` with detailed API parameters and response specs. Start with relevant recipes before consulting references.

Generated from the current SKILL.md. These answers refresh after source changes.