Xero · Example Payload

Xero Createbatchpayment Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Createbatchpayment Example is an example object payload from Xero, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "createBatchPayment",
  "method": "PUT",
  "path": "/BatchPayments",
  "summary": "Xero Creates one or many batch payments for invoices",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "BatchPayments": [
          {
            "Account": {
              "AccountID": "00000000-0000-0000-0000-000000000000"
            },
            "Reference": "ref",
            "Date": "2018-08-01",
            "Payments": [
              {
                "Account": {
                  "Code": "001"
                },
                "Date": "2019-12-31",
                "Amount": 500,
                "Invoice": {
                  "InvoiceID": "00000000-0000-0000-0000-000000000000",
                  "LineItems": [],
                  "Contact": {},
                  "Type": "ACCPAY"
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "424745ed-6356-46ad-87d4-3585f9062fb4",
        "Status": "OK",
        "ProviderName": "Xero API Partner",
        "DateTimeUTC": "/Date(1550865988111)/",
        "BatchPayments": [
          {
            "Account": {
              "AccountID": "5ec2f302-cd60-4f8b-a915-9229dd45e6fa",
              "CurrencyCode": "NZD"
            },
            "Reference": "Foobar123",
            "BatchPaymentID": "d318c343-208e-49fe-b04a-45642349bcf1",
            "DateString": "2019-02-22 00:00:00",
            "Date": "/Date(1550793600000+0000)/",
            "Payments": [
              {
                "Invoice": {
                  "InvoiceID": "3323652c-155e-433b-8a73-4dde7cfbf410",
                  "CurrencyCode": "NZD",
                  "Payments": [],
                  "CreditNotes": [],
                  "Prepayments": [],
                  "Overpayments": [],
                  "HasErrors": false,
                  "IsDiscounted": false,
                  "LineItems": []
                },
                "PaymentID": "c05098fa-ae3c-4f00-80ec-0a9df07dedff",
                "Amount": 1.0,
                "BankAmount": 1.0
              },
              {
                "Invoice": {
                  "InvoiceID": "e4abafb4-1f5b-4d9f-80b3-9a7b815bc302",
                  "CurrencyCode": "NZD",
                  "Payments": [],
                  "CreditNotes": [],
                  "Prepayments": [],
                  "Overpayments": [],
                  "HasErrors": false,
                  "IsDiscounted": false,
                  "LineItems": []
                },
                "PaymentID": "96409489-2f7d-4804-9a6d-6b939b0e038a",
                "Amount": 1.0,
                "BankAmount": 1.0
              },
              {
                "Invoice": {
                  "InvoiceID": "e6039672-b161-40cd-b07b-a0178e7186ad",
                  "CurrencyCode": "NZD",
                  "Payments": [],
                  "CreditNotes": [],
                  "Prepayments": [],
                  "Overpayments": [],
                  "HasErrors": false,
                  "IsDiscounted": false,
                  "LineItems": []
                },
                "PaymentID": "d2796067-bf71-4f06-b386-81f1454fa866",
                "Amount": 1.0,
                "BankAmount": 1.0
              }
            ],
            "Type": "RECBATCH",
            "Status": "AUTHORISED",
            "TotalAmount": 3.0,
            "UpdatedDateUTC": "/Date(1550865987783+0000)/",
            "IsReconciled": false
          }
        ]
      }
    }
  ]
}