APIドキュメント

エンドポイントステータス API

任意の組織IDを指定してエンドポイントの状況を取得します。受信可能かどうかの状況や組織の情報が含まれます。

URL

https://api.bondance.digital/api/v1/status/endpoint

HTTPメソッド

GET

特記事項

  • endpoint_idに法人番号が指定された場合、国税庁の法人番号システム Web-APIを利用して組織情報を取得しています。
  • endpoint_idに法人番号以外が指定された場合はPartyは設定されません。

リクエストパラメータ

パラメータ必須内容
document_type〇ステータスを取得するドキュメントタイプ
・JP_PINT_invoice：適格請求書
endpoint_id〇ステータスを取得するエンドポイントID
・0188：法人番号（国税庁により付番された13桁）
・0221：適格請求書事業者登録番号（T+法人番号）

リクエストサンプル

https://api.bondance.digital/api/v1/status/endpoint?document_type=JP_PINT_invoice&endpoint_id=0188:2011001016148

レスポンスデータ

キー１キー２キー３内容
Delivery指定のエンドポイントが受信可能状態かどうか
・Available：正常（受信可能）
・Undeliverable：異常（受信不可）
DocumentTypeリクエストしたドキュメントタイプ
Party組織情報
EndpointID法人番号または適格請求書事業者登録番号
EndpointID_schemeIDID区分
・0188：法人番号
・0221：適格請求書事業者登録番号
PostalAddress住所
StreetName番地・建物等
CityName市町村
PostalZone郵便番号
CountrySubentity都道府県
PartyLegalEntity組織情報（正式名）
RegistrationName組織名
Endpointエンドポイント情報
ParticipantIdエンドポイントID
ServiceDescriptionエンドポイント説明
TechnicalContactエンドポイント連絡先
AccessPointアクセスポイント情報
ProviderIdサービスプロバイダーID
ProviderNameサービスプロバイダー名
ProviderTypeタイプ（本番・開発）
SmpSMP情報
ProviderIdSMPプロバイダーID
ProviderNameSMPプロバイダー名
ProviderTypeタイプ（本番・開発）

レスポンスサンプル

{
  "Delivery": "Available",
  "DocumentType": "JP_PINT_invoice",
  "Party": {
    "EndpointID": "2011001016148",
    "EndpointID_schemeID": "0188",
    "PostalAddress": {
      "StreetName": "桜丘町２９番３５号",
      "CityName": "渋谷区",
      "PostalZone": "1500031",
      "CountrySubentity": "東京都"
    },
    "PartyLegalEntity": {
      "RegistrationName": "株式会社トラベルデータ"
    }
  },
  "Endpoint": {
    "ParticipantId": "0188:2011001016148",
    "ServiceDescription": "Traveldata via bondance AP",
    "TechnicalContact": "info@bondance.digital"
  },
  "AccessPoint": {
    "ProviderId": "PJP000528",
    "ProviderName": "Traveldata Co., Ltd.",
    "ProviderType": "PEPPOL PRODUCTION AP"
  },
  "Smp": {
    "ProviderId": "PJP000528",
    "ProviderName": "Traveldata Co., Ltd.",
    "ProviderType": "PEPPOL PRODUCTION SMP"
  }
}
TOP