Misoca(ミソカ) API

Misoca API の利用法について解説します。

© 2024. Yayoi Co., Ltd. All rights reserved.

Misoca API について

Misoca を外部アプリケーションから利用するためのAPIです。

使い方

前提

アプリケーションの登録

  1. Misoca にログインした状態で、 https://app.misoca.jp/oauth2/applications にアクセスします。
  2. 新しいアプリケーション ボタンを押下します。これにより「アプリケーションの作成」画面に遷移します。
  3. 次の各項目記入してください。
    • 名称
      • アプリケーションの名称です。任意の名称をつけることが出来ます。利用権限の確認時に表示されます。
    • コールバックURL
      • OAuth2 利用時のコールバックURLです。ここに挙げられたURL以外へはコールバックできません。改行区切りにて複数行記入することが出来ます。
  4. 登録 ボタンを押下します。 これによりアプリケーション詳細画面に遷移します。
  5. アプリケーション詳細画面では下記の項目が提示されます。各項目を用いて OAuth 認証を行うアプリケーションを開発してください。
    • アプリケーションID
    • シークレット
    • コールバックURL

認証

OAuth2

認証のエンドポイント

認証には OAuth2.0 を用います。 WebAPI の利用時に Authorization ヘッダに OAuth パラメータを含めて HTTP リクエストを送出します。 ヘッダ内の OAuth トークンによって、Misoca ユーザを識別します。

また、スコープとして read または writeがあり、それぞれのAPIに権限が設定されています。 スコープは read < write の関係にあり、write 権限があれば、読み込みを行うことは出来ます。

トークンの有効期間は1日となっています。必要に応じてリフレッシュを行ってください。

API の利用について

ドキュメント

アップデート・更新履歴

2024年01月30日

API v3 で品目に関するAPIを追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2024年01月23日

API v3 で納品書に関するAPIを追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2023年12月13日

API v3 の取引先の作成・送り先の作成にて、tax_optionパラメータの値に「NONENTRY」を追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2023年10月24日

API v3 でPeppol IDに対応しました。この対応にはいくつかのパラメータ変更が含まれます。詳細につきましては v3 変更履歴 よりご確認ください。

2022年12月14日

API v3 で納品日に対応しました。この対応にはいくつかのパラメータ変更が含まれます。詳細につきましては v3 変更履歴 よりご確認ください。

2021年09月14日

API v3 で事業者登録番号に対応しました。この対応にはいくつかのパラメータ変更が含まれます。詳細につきましては v3 変更履歴 よりご確認ください。

2021年04月01日

API v1 の提供を終了しました。

2020年10月13日

API v3 の請求書一覧に、更新日絞り込みパラメータを追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年10月05日

API v3 の請求書一覧、見積書一覧にて、typeパラメータの値に「untrashed」を追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年09月30日

API v3 の請求書明細、見積書明細にて、「金額」を追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年09月23日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年08月18日

チームメンバーが作成したアプリケーションはチームオーナーに属する形に変更しました。

2020年07月28日

チームメンバーが作成したアプリケーションはチームメンバーに属していましたが、これをチームオーナーに属する形に変更します。 これにより、チームオーナーがチームメンバーの作成したアプリケーションを管理できるようになり、またチームメンバーの退会によってアプリケーションが削除されないようになります。

2020年07月08日

API v3 ドキュメント でのモデルの名前がRFC3986準拠になるように修正しました。

これまでは、ApiEntity::ContactGroup でしたが、、 ApiEntity_ContactGroup のようになりました。この変更に伴い、変更前にクライアントを生成している場合に新たにクライアントを生成するとモデルのクラス名が変わることがあります。

2020年07月03日

API v3 ドキュメント でのモデルの名前に ApiEntity のような名前空間が付与されるようになりました。

ContactGroup の場合、ApiEntity::ContactGroup となります。APIの動作には影響ありません。変更前に OpenAPI Document を利用して、クライアントを生成している場合に新たにクライアントを生成するとモデルのクラス名が変わることがあります。

2020年06月17日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年06月03日

API v3の請求書の入金ステータスを更新するAPIで、入金日を登録するためのパラメータを追加しました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年04月20日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年04月06日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年03月23日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2020年03月03日

2019年12月25日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2019年12月23日

API v3 に機能の追加とドキュメントの更新を行いました。詳細につきましては v3 変更履歴 よりご確認ください。

2019年11月26日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2019年11月25日

API v3 に次の機能が追加されました。詳細につきましては v3 変更履歴 よりご確認ください。

2019年09月18日

API v3 の消費税改正に伴う軽減税率制度への対応を実施いたしました。この対応にはいくつかのパラメータ変更が含まれます。詳細につきましては v3 変更履歴 よりご確認ください。

2019年09月10日

API v3 の取引先（contact）パラメータ群の説明について最新の画面に合うように修正しました。

2019年08月07日

消費税法改正に伴う軽減税率制度への対応として、API v3 に対していくつかの追加・変更を予定しています。変更の詳細は v3 変更履歴 よりご確認ください。 この変更の正式なリリース時期については後日お知らせしますが、HTTPリクエストヘッダ X-Misoca-Feature を有効にすることで先行してお試しいただけます。ご利用のアプリケーション改修などにご活用ください。

追記（2019年08月28日）

変更時期は 2019年09月18日 午前9時頃 を予定しています。

2019年06月18日

一部のAPIについて、軽減税率8％の入力、および区分記載請求書の形式に対応いたしました。

これに伴い、HTTPリクエストヘッダ X-Misoca-Feature の機能は無効にいたしました。

2019年06月17日

OAuth トークンの有効期間を変更します。

有効期間を経過したトークンについては必要に応じてリフレッシュを行うようお願いいたします。

変更時期は 2019年6月18日 午前6時頃 を予定しています。

2019年05月14日

消費税法改正にともなう軽減税率制度への対応として、以下のAPIにつきましてレスポンス内容の変更を予定しております。パラメータの削除・追加といった破壊的な変更が加わりますので、ご注意ください。変更時期につきましては、後日詳細をお伝えいたします。また、消費税法改正にともなう軽減税率制度への対応後のレスポンスを先行して受け取る機能として、HTTPリクエストヘッダ X-Misoca-Feature をご用意いたしました。ご利用のアプリケーションの改修などにご活用ください。

追記（2019年6月11日）

変更時期はWeb版と同じ 2019年6月18日 午前6時頃 を予定しています。

軽減税率8％の入力、および区分記載請求書の形式に対応します | 請求書作成サービス「Misoca(ミソカ)」

2019年3月19日

アプリケーションの登録についての説明を最新の画面に合うように修正いたしました。

2018年12月13日

消費税率10%に対応いたしました。

2018年10月31日

旧プランからの移行は終了いたしました。

2017年8月1日

2017年9月1日より旧プランではご利用いただけなくなります。新プランへの移行をお願いいたします。