APIドキュメント

インボイス検証 API

XMLで記述されたPeppolドキュメント(インボイス)をスキマトロンを利用してルール検証します。

URL

https://api.bondance.digital/api/v1/invoice/verify

HTTPメソッド

POST

特記事項

  • contentTypeに必ず”application/json”を指定してください。
  • 利用するスキマトロンはCustomizationIDを参照して決定します。

リクエストパラメータ

キー1内容
InvoicePeppolXMLを文字列で指定

リクエストサンプル

Peppolオリジナル形式
{
  "Invoice": "<Invoice ...><cbc:CustomizationID ... </Invoice>"
}

レスポンスデータ

キー1キー2キー3内容
Result処理結果 OK:正常
Test検証結果 true:エラーなし false:エラーあり
Rules
Name検証ルール名称
Messages【配列】エラーメッセージ
IdエラーID
Messageエラーメッセージ
Pathエラー箇所

レスポンスサンプル

{
  "Result": "OK",
  "Test": false,
  "Rules": [
    {
      "Name": "Shared PINT rules",
      "Messages": [
        {
          "Id": "ibr-113",
          "Message": "[ibr-113]-Belgian enterprise number MUST be stated in the correct format.",
          "Path": "/Invoice/cac:AccountingSupplierParty/cac:Party/cbc:EndpointID"
        }
      ]
    },
    {
      "Name": "Japanse jurisdiction specific PINT rules",
      "Messages": []
    }
  ]
}
TOP