メッセージ通知

OpenAPI説明

本APIは、エラーメッセージ通知際に利用します

リクエストURI

/api/openapi/btob/message/notification

リクエスト形式

POST

リクエスト例

{
  "serviceCode": "2",
  "fileId": "000000000001",
  "functionId": "1",
  "errors": [
    {
      "errorCode": "120003",
      "lineNo": "1",
      "fieldName": "XXX",
      "invoiceNo": "XXX"
    },
    {
      "errorCode": "spd.32741.012",
      "lineNo": "2",
      "fieldName": "XXX",
      "invoiceNo": "XXX"
    }
  ]
}

リクエスト項目

メッセージ情報

項目	タイプ	必須	キー	制限	説明
serviceCode	String	○	○	最大2文字	サービスコード 0：BillOne 1：日本ICS請求書管理オプション 2：楽楽精算 3：Bakuraku 4：奉行Edge受領請求書DXクラウド
fileId	String	△		固定12文字	ファイルID ファイル再取込の場合は必須
functionId	String			最大2文字	機能ID 1：ファイル再取込 2：自動取込/随時取込
errors	error[]	○			エラー情報リスト

error

項目	タイプ	必須	キー	制限	説明
errorCode	String	○		最大8文字	エラーコード
lineNo	String			最大6文字	行番号
fieldName	String			最大50文字	項目名
invoiceNo	String			最大10文字	伝票No.

OpenAPIリターン例

成功例

{
  "message": "success",
  "errorCode": "0000"
}

失敗例

{
    "errorCode": "120003",
    "errorMessage": "{0}は指定必須の項目です"
}

項目説明

項目	タイプ	説明
message	String	成功メッセージ内容を返す
errorCode	String	エラーメッセージコードを返す
errorMessage	String	エラーメッセージ内容を返す

エラーコード説明

errorCode	message	説明
120003	{0}は指定必須の項目です
0013	{0}は{1}文字以内で指定してください
spd.32741.012	Saasコードが不正です。
spd.40920.001	ファイルID：{0}が存在しません