APIドキュメント

インボイス取得 API

インボイス一覧で取得したメッセージIDを指定してインボイスの詳細を取得します。bondance形式またはPeppolのオリジナルXMLで取得する事が可能です。

URL

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

HTTPメソッド

GET

特記事項

  • invoice_formatにpeppolが指定されていてdataTypeがXMLの場合は、PeppolのオリジナルのXMLをレスポンスします。
  • 表記のレスポンス(JSON)のキーは必須項目によるミニマム構成です。実際のレスポンスは送受信内容により変動します。表記のない項目はPeppolオリジナルXMLの要素名をキーに対応させて参照する事が可能です。要素名とキー名は同一で階層構造も同一構造となります。属性の参照につていは”要素名_属性名”で参照されます。Peppolの要素名の詳細

リクエストパラメータ

パラメータ必須内容
message_id〇送信メッセージID
invoice_format取得するインボイスの形式
bondance：bondance形式
peppol：Peppol形式

リクエストサンプル

https://api.bondance.digital/api/v1/invoice/detail?message_id=cb8469b5-81fc-45d8-b475-579a6eed485a@bondance1&invoice_format=peppol

レスポンスデータ

bondance形式
キー１キー２キー３キー４キー５キー６内容
Result処理結果　OK:正常
DocumentTypeドキュメントタイプ
・JP_PINT_invoice：適格請求書
Invoiceインボイス
ID
IssueDate
InvoicePeriod
StartDate
EndDate
Accounting
SupplierParty
Party
EndpointID
_schemeID
EndpointID
Postal
Address
Country
Identifica
tionCode
PartyTax
Scheme
CompanyID適格請求書発行事業者 登録番号
Tax
Scheme		キー７：ID　VAT（固定）
PartyLegal
Entity
Registration
Name
Peppol形式

レスポンスサンプル

bondance形式
{
  "Result": "OK",
  "DocumentType": "JP_PINT_invoice",
  "Invoice": {
    "ID": "INV1676257397",
    "IssueDate": "2023-02-13",
    "InvoicePeriod": {
      "StartDate": "2023-03-01",
      "EndDate": "2023-03-31"
    },
    "AccountingSupplierParty": {
      "Party": {
        "EndpointID_schemeID": "0188",
        "EndpointID": "2011001016148",
        "PostalAddress": {
          "Country": {
            "IdentificationCode": "JP"
          }
        },
        "PartyTaxScheme": {
          "CompanyID": "T2011001016148",
          "TaxScheme": {
            "ID": "VAT"
          }
        },
        "PartyLegalEntity": {
          "RegistrationName": "販売企業名"
        }
      }
    },
    "AccountingCustomerParty": {
      "Party": {
        "EndpointID_schemeID": "0188",
        "EndpointID": "2011001016148",
        "PostalAddress": {
          "Country": {
            "IdentificationCode": "JP"
          }
        },
        "PartyLegalEntity": {
          "RegistrationName": "購入企業名"
        }
      }
    },
    "TaxTotal": {
      "TaxAmount_currencyID": "JPY",
      "TaxAmount": "30000",
      "TaxSubtotal": {
        "TaxableAmount_currencyID": "JPY",
        "TaxableAmount": "300000",
        "TaxAmount_currencyID": "JPY",
        "TaxAmount": "30000",
        "TaxCategory": {
          "ID": "S",
          "Percent": "10",
          "TaxScheme": {
            "ID": "VAT"
          }
        }
      }
    },
    "LegalMonetaryTotal": {
      "LineExtensionAmount_currencyID": "JPY",
      "LineExtensionAmount": "300000",
      "TaxExclusiveAmount_currencyID": "JPY",
      "TaxExclusiveAmount": "300000",
      "TaxInclusiveAmount_currencyID": "JPY",
      "TaxInclusiveAmount": "330000",
      "PayableAmount_currencyID": "JPY",
      "PayableAmount": "330000"
    },
    "InvoiceLine": [
      {
        "ID": "1",
        "InvoicedQuantity_unitCode": "H87",
        "InvoicedQuantity": "1",
        "LineExtensionAmount_currencyID": "JPY",
        "LineExtensionAmount": "50000.0",
        "Item": {
          "Name": "商品名１",
          "ClassifiedTaxCategory": {
            "ID": "S",
            "Percent": "10",
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        },
        "Price": {
          "PriceAmount_currencyID": "JPY",
          "PriceAmount": "50000"
        }
      },
      {
        "ID": "2",
        "InvoicedQuantity_unitCode": "H87",
        "InvoicedQuantity": "5",
        "LineExtensionAmount_currencyID": "JPY",
        "LineExtensionAmount": "250000.0",
        "Item": {
          "Name": "商品名２",
          "ClassifiedTaxCategory": {
            "ID": "S",
            "Percent": "10",
            "TaxScheme": {
              "ID": "VAT"
            }
          }
        },
        "Price": {
          "PriceAmount_currencyID": "JPY",
          "PriceAmount": "50000"
        }
      }
    ]
  }
}
TOP