APIドキュメント

デジタルインボイス一覧 API

送受信したインボイスの一覧を取得します。送受の区分や日付で検索することが可能です。送受信の日から一定期間保持され期間が過ぎると削除されます。

URL

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

HTTPメソッド

GET

特記事項

保持している全体の件数は契約プランで決められた保存期間よって決まります。

リクエストパラメータ

パラメータ必須内容
process送受信種別 　delivery：送信　receive：受信
document_typeドキュメントタイプ
・JP_PINT_invoice：適格請求書
start_date処理日検索（開始）
end_date処理日検索（終了）
supplier_endpoint_id送信エンドポイントID
customer_endpoint_id受信エンドポイントID
page_per_count１ページあたりの件数（デフォルト：２０）
page_numberページ番号（デフォルト：１）
unread_only未取得インボイスのみ対象（”true“文字列を指定）
order“desc”：処理日の降順（デフォルト） “asc”：処理日の昇順

リクエストサンプル

https://api.bondance.digital/api/v1/invoice/list?process=receive&start_date=2023-01-01&end_date=2023-01-31

レスポンスデータ

キー1キー２内容
Result処理結果　OK：正常
TotalCount対象総件数
PagePerCount１ページあたりの件数
PageNumberページ番号
Invoices【配列】インボイス一覧
MessageId送信メッセージID
Process送受信種別 　delivery：送信　receive：受信
DateTime処理日時
SupplierEndpointId送信エンドポイントID
CustomerEndpointId受信エンドポイントID

レスポンスサンプル

{
  "Result": "OK",
  "TotalCount: 50,
  "PagePerCount: 2,
  "PageNumbe: 1,
  "Invoices": [
    {
      "MessageId": "cb8469b5-81fc-45d8-b475-579a6eed485a@bondance1",
      "Process": "delivery",
      "DateTime": "2023-02-13T16:53:45.966+09:00",
      "SupplierEndpointId": "0188:2011001016148",
      "CustomerEndpointId": "0188:2011001016148"
    },
    {
      "MessageId": "c2e4ac82-e16a-458e-af28-2728f33a0af9@bondance1",
      "Process": "delivery",
      "DateTime": "2023-02-13T16:52:43.752+09:00",
      "SupplierEndpointId": "0188:2011001016148",
      "CustomerEndpointId": "0188:2011001016148"
    }
  ]
}
TOP