Misoca API v3

Misoca の外部API v3を定義します。

Service URL (リクエスト先URL)

• エンドポイント
  • https://app.misoca.jp/api/v3/

各種APIの詳細

• API v3ドキュメント

Swagger API spec(JSON形式)は https://app.misoca.jp/api/v3/swagger_docにて公開しています。

共通仕様

ページング仕様

ページングはRFC5988に準拠し、必要な情報は、Linkヘッダ経由で提供されます。

例えば、 GET /api/v3/estimates で請求書一覧を取得した場合、以下のようなLinkヘッダが含まれます。

Link: <https://app.misoca.jp/v3/estimates?page=31>; rel="last", <https://app.misoca.jp/api/v3/estimates?page=2>; rel="next"

ここでは rel="next" は次のページが page=2 であることを示しています。 rel="last" は、最後のページが page=31 であることを示しています。

ページ移動

page パラメータを渡すことでページを辿ることができます。 指定しない場合、 page=1 が指定されている場合と、同様の動作をします。

GET /api/v3/estimates?page=8

ページあたりの表示数

per_page パラメータを指定することで1ページあたりに返却する件数を制御できます。 指定しない場合、 per_page=25 が指定されている場合と、同様の動作をします。

GET /api/v3/estimates?per_page=100

アップデート・更新履歴

2024年11月11日

• 取引先の作成にて、メールの件名:領収書パラメータを追加しました。

• 取引先に関連しているAPIのレスポンスにメールの件名:領収書（mail_settings[subjects][simplified_invoice]）を追加しました。

  追加対象は次のとおりです。

  • 取引先一覧の取得 GET /contact_groups
  • 取引先詳細の取得 GET /contact_group/{id}

2024年1月30日

• API v3 に品目に関するAPIを追加しました。
  • 品目一覧の取得 GET /dealing_items
  • 品目の取得 GET /dealing_item/{id}
  • 品目の作成 POST /dealing_item

2024年1月23日

• API v3 に納品書に関するAPIを追加しました。
  • 納品書一覧の取得 GET /delivery_slips
  • 納品書の取得 GET /delivery_slip/{id}
  • 納品書PDFの取得 GET /delivery_slip/{id}/pdf
  • 納品書の作成 POST /delivery_slip

2023年12月13日

• API v3 の取引先の作成・送り先の作成において、tax_optionパラメータの値に「税別表示（納品書のみ請求時に計算）（NONENTRY）」を追加しました。
  • NONENTRYを設定した場合、対象の取引先・送り先が設定されている納品書の消費税設定の初期設定が「税別表示（請求時に計算）」となります。
  • 納品書以外の文書（納品書・請求書）では消費税設定の初期設定が「税別表示」となります。

2023年10月24日

• API v3 の取引先の作成・取得・一覧取得において、「Peppol ID（peppol_id）」を追加しました。
  • 証憑管理・会計連携「デジタルインボイス送信設定」が有効な場合にのみ、Peppol IDが設定されます。

2022年12月14日

• API v3 の請求書明細にて、「納品日（transaction_date）」を追加しました。
  • 追加機能「請求書の品番・品名ごとの納品日表示」が有効な場合にのみ、納品日が設定されます。
  • 追加機能が有効で納品日の指定がない場合は、作成当日の日付が設定されます。

2021年09月14日

• 事業者登録番号への対応として、請求書・見積書の作成・取得・一覧取得において、 body 内に事業者登録番号を表す sender_registration_number を追加しました。

2020年10月13日

• API v3 の請求書一覧に、更新日による絞り込みパラメータ（updated_at_from, updated_at_to）を追加しました。

2020年10月05日

• API v3 の請求書一覧、見積書一覧にて、typeパラメータの値に「未処理と処理済（untrashed）」を追加しました。

2020年09月30日

• API v3 の請求書明細、見積書明細にて、「金額（price）」を追加しました。

2020年09月23日

• API v3 の請求書を返すAPIにおいて、源泉徴収税種別(withholding_tax_type)と源泉徴収税(amount_of_withholding_tax)を追加しました。

2020年06月17日

• API v3 の取引先を非表示にするAPIを追加しました。
• API v3 の取引先を表示に戻すAPIを追加しました。

2020年06月03日

• API v3 の請求書関連のレスポンスに入金日を追加しました。
• API v3 の請求書を入金済にするAPIで、入金日を指定するためのパラメータを追加しました。

2020年04月20日

• API v3 の請求書一覧APIにお支払い期限絞り込みパラメータを追加しました。
• API v3 の請求書一覧APIに社内メモ絞り込み機能を追加しました。

2020年04月06日

• 従来「取引先API」と呼ばれていたAPIを「送り先API」に名称変更しました。
  • 既存の「送り先API」は従来通りお使いいただけます。
• 複数の送り先に共通する取引先の情報だけを操作する「取引先API」を追加しました。
  • 取引先一覧の取得 GET /contact_groups
  • 取引先の作成 POST /contact_group
  • 取引先詳細の取得 GET /contact_group/{id}
• 送り先のAPIを追加しました。
  • 送り先の非表示 DELETE /contact/{id}/trashed
  • 送り先の表示 PUT /contact/{id}/trashed
• 送り先一覧の取得APIに、取引先で絞り込むためのパラメータを追加しました。
• 送り先の作成APIで、関連付ける取引先を指定できるようパラメータを追加しました。

2020年03月23日

• API v3 の請求書/見積書一覧APIに取引先絞り込みパラメータを追加しました。

2019年12月25日

• API v3 に請求書の郵送指示と、ユーザー情報の取得のAPIを追加いたしました。

  追加対象は次のとおりです。

  • 請求書の郵送指示 POST /invoice/{id}/send_by_postal_mail
  • ユーザー情報の取得 GET /user/me

2019年12月23日

• API v3 の請求書/見積書一覧APIのドキュメントにページネーションに関わるリクエストパラメータを明記しました。
  • ページあたりの表示数を最大100件まで指定できるようにしました。
• API v3 の請求書一覧APIにソートパラメータを追加しました。
  • 請求書の作成日・更新日・発行日・お支払い期限で並び替えできるようになりました。

2019年11月26日

• API v3 の請求書一覧取得APIに検索パラメータを追加いたしました。
  • 取得する請求書の請求日の開始日・終了日で絞り込みできるようになりました。
  • 入金・請求ステータスに応じた請求書のみを絞り込みできるようになりました。
  • キーワードで検索できるようになりました。

• API v3 に請求書のごみ箱移動・請求ステータス更新・入金ステータス更新用のAPIを追加いたしました。

  追加対象は次のとおりです。

  • ごみ箱への移動 PUT /invoice/{id}/trashed
  • ごみ箱から復元 DELETE /invoice/{id}/trashed
  • 請求ステータスを請求済に更新 PUT /invoice/{id}/submitted
  • 請求ステータスを未請求に更新 DELETE /invoice/{id}/submitted
  • 入金ステータスを入金済に更新 PUT /invoice/{id}/paid
  • 入金ステータスを未入金に更新 DELETE /invoice/{id}/paid

2019年11月25日

• 請求書PDF取得API (GET /api/v3/invoice/{:id}/pdf) を追加いたしました。

• 取引先（送り先）に関連しているAPIのレスポンスに法人番号（corporate_number）を追加いたしました。 取引先作成時のパラメータに法人番号を指定できないことは変わりありませんのでご注意ください。

  追加対象は次のとおりです。

  • 取引先一覧の取得 GET /contacts
  • 取引先詳細の取得 GET /contact/{id}
  • 取引先の作成 POST /contact

2019年10月09日

Swagger API Specification (https://app.misoca.jp/api/v3/swagger_doc) について、下記の修正・変更を実施しました。

• 見積書の Body,Item エンティティが請求書の Body, Item を参照していた問題を修正
• 上記の対応として、Body,Item エンティティの名称を変更

なお、API の動作に変更はありません。

2019年09月18日

08月07日のお知らせ で告知しておりました、消費税法改正に伴う軽減税率制度への対応を実施いたしました。

この対応により、下記のパラメータについては 廃止 となっておりますのでご注意ください。

• 見積書作成 POST v3/estimates
  • body の tax_rate
  • item の tax_exempted
    • 替わりに item の tax_type をご利用ください

その他の追加・変更内容を含め、詳細につきましては 08月07日のお知らせ をご確認ください。 なお、今回変更内容を先行利用する際のHTTPリクエストヘッダ X-Misoca-Feature については機能を無効にしております。

2019年09月10日

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

2019年08月07日

• 消費税法改正にともなう軽減税率制度への対応として、見積書作成APIについてパラメータの変更、請求書操作のAPI提供を予定しております。パラメータの削除・追加といった変更が加わりますので、先行してお試しいただくための機能として、HTTPリクエストヘッダ X-Misoca-Feature をご用意いたしました。 なお X-Misoca-Feature の使い方については本APIドキュメントをご参照ください。
  • 見積書作成のパラメータ変更
    • 対象API
      • POST v3/estimates
    • 変更概要
      • 新規に追加されたパラメータ: tax_type
      • 含まれなくなったパラメータ: body 内の tax_rate、items 内の tax_exempted
  • 請求書一覧取得・取得・作成のAPI追加
    • GET v3/invoices
    • GET v3/invoice/:id
    • POST v3/invoice

追記（2019年08月28日）

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

2019年06月18日

• 一部のAPIについて、軽減税率8％の入力、および区分記載請求書の形式に対応。
• これに伴い、HTTPリクエストヘッダ X-Misoca-Feature の機能は無効にいたしました。
• 見積書の作成API (POST /api/v3/estimates) のレスポンス内容を下記のとおり変更いたしました。
  • 新規に追加されたパラメータ: tax_type
  • 含まれなくなったパラメータ: body 内の tax_rate、items 内の tax_exempted

2019年05月14日

• 消費税法改正にともなう軽減税率制度への対応として、対応後のレスポンスを先行して受け取るためのHTTPリクエストヘッダー X\-Misoca\-Feature を以下のAPIに追加。
  • GET v3/estimates
  • GET v3/estimate/:id

2018年12月13日

• 消費税率10%に対応

2017年6月21日

• 請求書ロゴ画像取得機能の追加
• 請求書印影画像取得機能の追加

2016年12月1日

• API v3 公開