APIドキュメント

API概要

bondance endpoint-APIはPeppolネットワークでデジタルインボイスを送受信するためのRESTful APIです。 インボイスデータはbondance形式(JSON/XML)とPeppolオリジナルのXML形式を提供しています。 ひとつの接続アカウントで複数の受信エンドポイントを設定することが可能です。

接続方法

すべてのAPIインターフェイスはRESTアーキテクチャスタイルを採用しています。

  • HTTPメソッド：GET / POST / DELETE
  • 接続認証方式：Bearer（アクセストークン認証）
  • リクエスト形式：JSON（POST処理）
  • レスポンス形式：JSON / XML

認証方式

すべての接続にBearer(アクセストークン認証)による認証が必要です。HTTPリクエストヘッダーにアクセストークンを記述します。

Authorization: Bearer {アクセストークン}

アクセストークンは管理サイトで取得することができます。

リクエスト

  • POST時のリクエストはJSON形式のみ可能です。
  • POST時にはcontentTypeに必ず”application/json”を指定してください。
  • パラメータ命名規則はGET時はスネークケース、POST時（JSON)はアッパーキャメルケースで構成されています。

レスポンス

  • JSON形式またはXML形式で取得可能です。
  • エラー時は２００以外のHTTPステータスコードを設定しテキスト値(YAML)をレスポンスします。
  • パラメータ命名規則はアッパーキャメルケースで構成されています。

APIの一覧

送受信を中心に下記のAPIが利用できます。詳細はこちら

  • システムステータス API
  • エンドポイントステータス API
  • インボイス送信 API
  • インボイス一覧 API
  • インボイス取得 API
  • インボイス検証 API
  • インボイス転送 API
  • 受信エンドポイント一覧 API
  • 受信エンドポイント登録 API
  • 受信エンドポイントSML登録 API
  • 受信エンドポイント削除 API
  • ドキュメントタイプSMP登録API
  • ドキュメントタイプ削除API
  • 利用可能ドキュメント一覧 API

インボイスデータ

インボイスのデータ形式にはbondance形式(JSON)とPeppolオリジナル形式(XML)があります。bondance形式は固定設定値や計算項目等をできるだけ省きシンプルな構造で定義されています。（Peppolネットワークへ送受信時にフォーマットを変換します）
送信および受信インボイスのデータ形式はPeppol形式(XML)の要素名と階層構造をそのままJSONに変換したものになっています（属性名は”要素名_属性名”）。そのため項目のリファレンスはPeppol形式を参照する事が可能です。
Peppolの要素名の詳細

変換の例：

Peppol形式(XML)
<Invoice><InvoicePeriod><StartDate Attr="ex.">2023-01-01</StartDate></InvoicePeriod></Invoice>

bondance形式(JSON)
{"Invoice": {"InvoicePeriod": {"StartDate":"2023-01-01", "StartDate_Attr": "ex."}}}

送受信可能なインボイス

bondance形式を利用する場合、下記のインボイスが送信可能です。

  • 適格請求書（日本）
  • 仕入明細書（日本）

※Peppolオリジナル形式を利用した場合は世界中のすべての国のインボイスをどこへでも送受信可能です。

インボイスの受信方法

アクセスポイントとしてのbondance(C3)へ送られてきたデジタルインボイスを指定のサーバ(C4)へプッシュ(POST)します。 受信の通知(GET)のみ受け取り非同期でAPIを利用して取得（プル）する事もできます。プッシュまたは通知するサーバの指定は管理サイトから行います。
受信するデータの形式はbondance形式(JSON)またはPeppolオリジナル形式(XML)を指定する事が可能です。

TOP