APIドキュメント

インボイス送信 API

任意の組織へインボイスを送信します。bondance形式またはPeppolのオリジナルXMLで送信する事も可能です。 bondance形式の場合PeppolのXMLへ変換され送信されます。PeppolのオリジナルXMLが指定された場合は、 スキマトロンによる内容の検証が行われ正しいデータの場合のみ送信されます。 受信先の判断はSMPを利用したPeppolのルックアップ方式の他、サーバを指定した直接送信も可能です。

URL

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

HTTPメソッド

POST

特記事項

  • contentTypeに必ず”application/json”を指定してください。
  • 表記のリクエストパラメータはすべて必須です。（EndpointReferenceを除く）
  • 表記のリクエスト(JSON)パラメータ以外のキーについては、PeppolオリジナルXMLの要素名をキーに対応させて指定する事が可能です。要素名とキー名は同一で階層構造も同一構造となります。属性の指定につていは”要素名_属性名”で記述します。Peppolの要素名の詳細
  • InvoiceにPeppolオリジナルXMLを直接指定する事が可能です。この場合ドキュメントタイプはCustomizationIDを参照します。

リクエストパラメータ

bondance形式
キー１キー２キー３キー４キー５内容
DocumentType送信するドキュメントタイプ
・JP_PINT_invoice：適格請求書
Invoice
ID任意の請求書ID
IssueDate請求書発行日
InvoicePeriod請求期間
StartDate開始日
EndDate終了日
Accounting
SupplierParty		販売組織
Party組織情報
EndpointID法人番号または適格請求書事業者登録番号
EndpointID
_schemeID		ID区分
・0188：法人番号
・0221：適格請求書事業者登録番号
PartyLegal
Entity		組織情報（正式名）
Registration
Name		組織名
Accounting
CustomerParty		購入組織
Party組織情報
EndpointID法人番号または適格請求書事業者登録番号
EndpointID
_schemeID		ID区分
・0188：法人番号
・0221：適格請求書事業者登録番号
PartyLegal
Entity		組織情報（正式名）
Registration
Name		組織名
TaxTotal税額合計
TaxAmount税額合計
TaxSubtotal
TaxableAmount課税請求金額
TaxAmount税額合計
LegalMonetary
Total
TaxExclusive
Amount		税抜き請求金額
TaxInclusive
Amount		税込み請求金額
InvoiceLine【配列】商品明細
Invoiced
Quantity		数量
Item商品情報
Name商品名
Price金額情報
PriceAmount単価
Endpoint
Reference		【任意設定】SMPを利用せず明示的にエンドポイントを指定する場合
Address送信先サーバURL
Certificate送信先Peppol証明書
Peppolオリジナル形式
キー1キー２内容
InvoicePeppolXMLを文字列で指定
EndpointReference【任意設定】SMPを利用せず明示的にエンドポイントを指定する場合
Address送信先サーバURL
Certificate送信先Peppol証明書

リクエストサンプル

bondance形式
{
  "DocumentType": "JP_PINT_invoice",
  "Invoice": {
    "ID": "INV1676257397",
    "IssueDate": "2023-02-13",
    "InvoicePeriod": {
      "StartDate": "2023-03-01",
      "EndDate": "2023-03-31"
    },
    "AccountingSupplierParty": {
      "Party": {
        "EndpointID": "2011001016148",
        "EndpointID_schemeID": "0188",
        "PartyLegalEntity": {
          "RegistrationName": "販売企業名"
        }
      }
    },
    "AccountingCustomerParty": {
      "Party": {
        "EndpointID": "2011001016148",
        "EndpointID_schemeID": "0188",
        "PartyLegalEntity": {
          "RegistrationName": "購入企業名"
        }
      }
    },
    "TaxTotal": {
      "TaxAmount": 30000,
      "TaxSubtotal": {
        "TaxableAmount": 300000,
        "TaxAmount": 30000
      }
    },
    "LegalMonetaryTotal": {
      "TaxExclusiveAmount": 300000,
      "TaxInclusiveAmount": 330000
    },
    "InvoiceLine": [
      {
        "InvoicedQuantity": 1,
        "Item": {
          "Name": "商品名１"
        },
        "Price": {
          "PriceAmount": 50000
        }
      },
      {
        "InvoicedQuantity": 5,
        "Item": {
          "Name": "商品名２"
        },
        "Price": {
          "PriceAmount": 50000
        }
      }
    ]
  }
}
Peppolオリジナル形式
{
  "Invoice": "<Invoice ...><cbc:CustomizationID ... </Invoice>"
}

レスポンスデータ

キー１内容
Result処理結果　OK：正常
DateTime処理日時
DeliveryMessageIdリクエストメッセージID
ReceivedMessageIdレスポンスメッセージID
SupplierEndpointId送信エンドポイントID
CustomerEndpointId受信エンドポイントID

レスポンスサンプル

{
  "Result": "OK",
  "DateTime": "2023-02-13T12:03:21.505+09:00",
  "DeliveryMessageId": "9e87065f-5109-40c8-afcd-bacc33672bd4@bondance1",
  "ReceivedMessageId": "683f903c-0801-4efc-a81e-5a8ab330a40f@bondance1",
  "SupplierEndpointId": "0188:2011001016148",
  "CustomerEndpointId": "0188:2011001016148"
}
TOP