請求書支払APIの呼び出し例

XMLペイロードの例

そして、これはサポートされ続けているXMLペイロードスキーマの一例です。

<?xml version="1.0" encoding="UTF-8"?>
<invoice-header>
   <paid type="boolean">true</paid>
   <payment-date type="datetime">2009-06-23T00:00:00-08:00</payment-date>
   <payment-notes>CHECK|#1003|USD|989.00|FULLY PAID|</payment-notes>
   <payments type="array">
      <payment>
         <amount-paid>989.00</amount-paid>
         <notes>1003</notes>
         <payment-date>2009-06-23</payment-date>
      </payment>
   </payments>
</invoice-header>

XMLペイロードの別の例を次に示します。

<?xml version="1.0" encoding="UTF-8"?>
<invoice-header>
   <invoice-date type="datetime">"2019-10-22 00:00:00 -0900"</invoice-date>
   <invoice-number>Invoice_Number_1571292051.310760975</invoice-number>
   <payments type="array">
      <payment>
         <amount-paid>5.00</amount-paid>
         <notes>1003</notes>
         <payment-date>2019-10-22</payment-date>
      </payment>
   </payments>
</invoice-header>

そして、以下はXMLを使用した複数の支払の例です：

<?xml version="1.0" encoding="UTF-8"?>
<invoice-header>
   <payments type="array">
      <payment>
         <amount-paid>4.00</amount-paid>
         <notes>1003</notes>
         <payment-date>2009-06-23</payment-date>
      </payment>
      <payment>
         <amount-paid>5.00</amount-paid>
         <notes>1004</notes>
         <payment-date>2009-06-23</payment-date>
      </payment>
   </payments>
</invoice-header>

また、支払メモを使用して複数の小切手番号で既存の請求書を更新する古いXMLペイロード例（まだサポートされています）。これは、支払済み、小切手番号、および支払日というフィールドを使用しています。

<?xml version="1.0" encoding="UTF-8"?>
<invoice-header>
   <paid type="boolean">true</paid>
   <payment-date type="datetime">2009-06-23T00:00:00-08:00</payment-date>
   <payment-notes>CHECK|#1003|USD|989.00|FULLY PAID|</payment-notes>
   <payments type="array">
      <payment>
         <amount-paid type="decimal" nil="true">100.23</amount-paid>
         <notes nil="true">232</notes>
         <payment-date type="datetime" nil="true">2010-09-25T02:22:11Z</payment-date>
      </payment>
      <payment>
         <amount-paid type="decimal" nil="true">9032.32</amount-paid>
         <notes nil="true">233</notes>
         <payment-date type="datetime" nil="true">2010-09-25T02:22:11Z</payment-date>
      </payment>
   </payments>
</invoice-header>

JSONペイロードの例

JSONペイロードを使用するには、次の例の形式のいずれかを適用できます。

データ形式1：

{
  "payments": 
  {
    "payment":
      { "check_number": "1234567", "amount_paid": "199.98", "notes": "String", "payment_date": "9/12/2019" }
  },
  "paid": "false",
  "payment_date": "9/11/2019",
  "payment_notes": "Partial payment with one payment check."
}

データ形式2：

{
  "payments": 
  {
    "payment": [
      { "check_number": "test_check_number", "amount_paid": "510", "notes": "A payment note", "payment_date": "9/12/2019" },
      { "check_number": "test_check_number", "amount_paid": "53", "notes": "A payment note", "payment_date": "9/11/2019" }]
  },
  "paid": "false",
  "payment_date": "9/11/2019",
  "payment_notes": "One partial payment with two checks."
}

データ形式3：

{
  "payments": [
    { "check_number": "test_check_number", "amount_paid": "510", "notes": "payment_note", "payment_date": "9/12/2019" },
    { "check_number": "test_check_number", "amount_paid": "53", "notes": "payment_note", "payment_date": "9/11/2019" }
  ],
  "paid": "false",
  "payment_date": "9/11/2019",
  "payment_notes": "Two payments with two checks."
}

データ形式4：

{
  "paid": "true",
  "payment-date": "2019-08-13T00:00:00Z",
  "payment-notes": "eProc Voucher#TRM-19-0009584-PV/THB",
  "payments": {
     "payment" :  [
       {
         "payable-type": "InvoiceHeader",
         "payable-id": "4835",
         "amount-paid": "49.00",
         "notes": "TRM-19-0009584-PV",
         "payment-date": "2019-08-13T00:00:00Z"
       },
      {
         "payable-type": "InvoiceHeader",
         "payable-id": "4835",
         "amount-paid": "51.00",
         "notes": "TRM-19-0009584-PV",
         "payment-date": "2019-08-13T00:00:00Z"
       }
    ]
  }
}