Xero · Example Payload

Xero Createpayments Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Createpayments 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": "createPayments",
  "method": "PUT",
  "path": "/Payments",
  "summary": "Xero Creates multiple payments for invoices or credit notes",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "Payments": [
          {
            "Invoice": {
              "LineItems": [],
              "InvoiceID": "00000000-0000-0000-0000-000000000000"
            },
            "Account": {
              "Code": "970"
            },
            "Date": "2019-03-12",
            "Amount": 1
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "83b5715a-6a77-4c16-b5b8-2da08b5fde44",
        "Status": "OK",
        "ProviderName": "Provider Name Example",
        "DateTimeUTC": "/Date(1552432238716)/",
        "Payments": [
          {
            "PaymentID": "61ed71fc-01bf-4eb8-8419-8a18789ff45f",
            "Date": "/Date(1552348800000+0000)/",
            "BankAmount": 1.0,
            "Amount": 1.0,
            "CurrencyRate": 1.0,
            "PaymentType": "ACCRECPAYMENT",
            "Status": "AUTHORISED",
            "UpdatedDateUTC": "/Date(1552432238623+0000)/",
            "HasAccount": true,
            "IsReconciled": false,
            "Account": {
              "AccountID": "5690f1e8-1d02-4893-90c2-ee1a69eff942",
              "Code": "970",
              "Name": "Owner A Funds Introduced"
            },
            "Invoice": {
              "Type": "ACCREC",
              "InvoiceID": "c7c37b83-ac95-45ea-88ba-8ad83a5f22fe",
              "InvoiceNumber": "INV-0004",
              "Reference": "",
              "Prepayments": [],
              "Overpayments": [],
              "AmountDue": 229.0,
              "AmountPaid": 1.0,
              "SentToContact": false,
              "CurrencyRate": 1.0,
              "HasErrors": false,
              "IsDiscounted": false,
              "Contact": {
                "ContactID": "a3675fc4-f8dd-4f03-ba5b-f1870566bcd7",
                "Name": "Barney Rubble-83203",
                "ContactPersons": [],
                "HasValidationErrors": false
              },
              "DateString": "2018-10-10 00:00:00",
              "Date": "/Date(1539129600000+0000)/",
              "DueDateString": "2018-10-18 00:00:00",
              "DueDate": "/Date(1539820800000+0000)/",
              "Status": "AUTHORISED",
              "LineAmountTypes": "Exclusive",
              "LineItems": [
                {
                  "Description": "boo",
                  "UnitAmount": 200.0,
                  "TaxType": "OUTPUT2",
                  "TaxAmount": 30.0,
                  "LineAmount": 200.0,
                  "AccountCode": "200",
                  "Tracking": [],
                  "Quantity": 1.0,
                  "LineItemID": "173dfdb9-43b5-4bd2-ae25-9419e662a3a7",
                  "ValidationErrors": []
                }
              ],
              "SubTotal": 200.0,
              "TotalTax": 30.0,
              "Total": 230.0,
              "UpdatedDateUTC": "/Date(1552432238623+0000)/",
              "CurrencyCode": "NZD"
            },
            "HasValidationErrors": true,
            "ValidationErrors": [
              {
                "Message": "Payment amount exceeds the amount outstanding on this document"
              }
            ]
          }
        ]
      }
    }
  ]
}