API docs by Redocly

よくあるご質問

一般

手順

本サービスを利用するには、どうしたらよいですか？
すでにサービスをご使用のお客様も、再度お申し込みをして頂く必要があります。
詳しくは、こちらよりお問い合わせ下さい。
テスト環境のログインIDの提供は可能ですか？
お申し込み後に、弊社からご案内させて頂きます。
API用のクライアントIDやシークレットIDなどの必要情報も同時にご確認することができます。
クライアントIDを指定したい場合どうしたらよいですか？
指定することは可能ですが、文字数などの関係でご希望に添えない場合もございます。
お申込の際にご相談ください。
提供APIに変更があった場合、どこを確認したらいいでしょうか？
アップデートがある場合は、BtoBプラットフォーム各サービスのInfomation及びバージョンアップ情報ページに掲載しております。
（プラットフォームIDとパスワードが必要です）
またリファレンス資料の最新更新日をご確認ください。
API連携パートナーになりたいのですが、どうしたらよいですか？
各種パートナー制度をご用意しています。詳しくは、こちらのページからお問い合わせください。

料金

無料でAPI連携は利用できますか？
いいえ、利用できません。
有料会員で、且つ「APIオプション機能」の申し込みをされると利用することができます。

共通仕様

パッケージ版や基幹システムからAPI連携できますか？
はい、クラウド版でなくても連携はできます。
詳細については別途お問い合わせください。
APIの認証方式はなにを使用していますか？
BtoBプラットフォームをサービスプロバイダとする、OAuth2の仕組みを用いて連携されます。
詳しくはこちらをご参照ください。
APIのテスト環境はありますか？どうすれば使えますか？
テスト環境はご用意しておりますが、使用の際にはお申し込みが必要です。
（APIを使用するにはBtoBプラットフォーム請求書の有料会員である必要があります。）
リダイレクトURL(CallBackURL)はいくつ登録できますか？
最大5個まで登録可能です。また、CallBackURLがない場合は登録の必要がありません。
入金データを取得するAPIはありますか？
入金データを取得するAPIはございません。
アクセストークンとリフレッシュトークンの有効期間はどのくらいでしょうか？
有効期間は下記のようになります。
  • ・アクセストークンの有効期間は 5 分
  • ・リフレッシュトークンの有効期限は 31 日
セキュリティの関係で、同じアクセストークンでは接続し続けることはできず、リフレッシュトークンを利用して、繰り返しアクセストークンの払い出しを行い利用していく形となります。
認証についてはこちらを参照してください。
APIが使えない時間帯はありますか？
月一度の定期メンテナンスを実施しており、その期間はご利用いただけません。
また、例外的に臨時でメンテナンスを実施する場合もございます。
BtoBプラットフォームの障害や、トラブル発生によって停止することが想定される場合は「臨時停止」することがありますが、
基本的に、APIの場合はメンテナンス時とシステムトラブル以外での停止はございません。

環境

固定IP（グローバルIPアドレス）を持っていない場合どうすればいいでしょうか？
テスト環境を使用する場合は、外部からのアクセスを制限しているため、グローバルIPアドレスは必須となります。
本番環境では必要ありません。

請求書

インフォマートのAPIではどのようなことができますか？
BtoBプラットフォーム請求書の発行・受取に関して、APIバージョン2では、それぞれ下記のような機能があります。
【発行側の機能】
  • (1) 作成した請求書の一覧を取得
  • (2) 請求書の発行・更新
  • (3) 発行元マスタ・発行先マスタ・振込口座マスタの取得・登録・更新・削除
  • (4) 請求書書式の取得・登録・更新・削除
  • (5) 発行先の取得・登録・更新・招待
【受取側の機能】
  • (1) 受取った請求書の一覧を取得
  • (2) 受取った請求書の差戻・処理済み処理
  • (3) 受取った請求書の仕訳登録
  • (4) 会計連携に必要な、仕訳関連マスタの取得・登録・更新・削除
  • (5) 宛先マスタ・承認グループマスタの取得・登録・更新・削除
  • (6)支払先の取得・登録・更新・招待
それぞれのAPI機能の詳細に関しては、リファレンスを参照してください。
APIで支払通知書を作成できますか？
APIで支払通知書の作成・発行ができるようになりました。詳細に関しては、リファレンスを参照してください。
請求書を発行せずに、招待だけをAPIで送ることは可能でしょうか？
APIバージョン2では、招待機能のみとなる、発行先招待APIを用意しております。発行先登録APIで登録後に発行先招待APIを実行することで招待ができます。
レスポンスの項目が増えているようですがこれは仕様でしょうか？
仕様の変更によりレスポンス項目の追加や、設定状況などにより項目の順番が変更になることがございます。
そのため、本APIを利用するプログラムを実装する際は、項目の並び順に依存しないように実装をお願いします。
支払先ごとに請求書の書式を変更して発行できますか？
変更可能です。事前に画面上や請求書式登録APIで請求書の書式設定を行っておくことが必要です。
APIで複数件の請求書を1リクエストで登録した場合、請求書は分かれますか？
APIバージョン2の請求書登録APIで複数件の請求書登録は行えません。ご了承ください。
受取側で1回で取得できる請求書数は？

１回のリクエストで取得できる最大の請求書の件数は100件までとなります。
取得を行うと、レスポンスに抽出結果件数「total_count」が返却されますので、取得リクエストを送るときに「start_position」パラメータを使用することで、取得開始位置を指定することができます。
また、「get_count」パラメータを使用すれば、1～99件以内で取得件数を指定することもできます。

【例】
201件目の請求書から100件の請求書取得したい場合： (start_position=201)
101件目の請求書から10件の請求書を取得したい場合 ：(start_position=101, get_count=10)
請求データ取得APIで「税率（tax_rate_sec）」がNULLで返ってきます。なぜでしょうか？
請求書を発行する際、「税率（tax_rate_sec）」をNULLで発行できるため、受取側でNULLを返しています。
弊社のサービスの特性上、請求書の消費税にかかわる情報については、未入力でも作成できてしまいます。
ご質問のように発行側によっては、税率などがNULLでリターンされることを考慮して実装していただくようお願いいたします。
ワークフローの情報(承認の履歴情報)は取得できますか？
APIバージョン2では、請求データ取得APIの「hestory[]」配列内に、履歴情報を出力します。
ワークフローのステータスごとに請求書を取れますか？
APIバージョン2では、以下の通りとなっております。
【発行】
ステータスごとの請求書は取得できません。請求書一覧取得APIの「wf_status」レスポンスで、ワークフローステータスをご確認頂けますので、以下のステータスを元に分別してください。
  • 22:発行済
  • 23:発行済削除
  • 29:発行エラー
【受取】
請求データ取得APIの「wf_status」リクエストにステータスを指定することで、ステータスごとの請求書が取得できます。
バージョン1のAPIリファレンスを確認したいのですが、どこにありますか？
バージョン1については、こちらのページからご確認ください。
インボイス制度に対応済みでしょうか？
はい、APIバージョン2ではインボイス制度に対応した請求書の発行や取得が可能です。

利用開始までの流れ

BtoBプラットフォームのAPI利用開始までの流れは以下の通りです。

１.API利用申込手続き
利用申込の手続き完了後、接続設定させていただきます。
はじめてご利用になられる際は、弊社担当にご連絡ください。

２.API連携設定申込
利用申込手続き後、API連携設定申込：１) 試験環境及び本番環境申込みを送信ください。

３.検証環境にて接続試験

４.本番環境にて接続開始
接続試験が完了しましたら、API連携設定申込：２) 試験完了後の本番環境申込みを送信ください。

※現在ご利用中の環境を接続試験なしで本番環境の設定を依頼される際は、API連携設定申込：３) 試験は行わず本番環境への利用申込みを送信ください。
※申込済の内容を変更する際は、API連携設定申込：４) 変更依頼にて送信ください。変更依頼の際は「申込番号」が必要となります。
「申込番号」は「１) 試験環境及び本番環境申込み」申込時の確認メールに記載させていただいております。