Xero · Example Payload

Xero Deletepayment Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Deletepayment 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": "deletePayment",
  "method": "POST",
  "path": "/Payments/{PaymentID}",
  "summary": "Xero Updates a specific payment for invoices and credit notes",
  "requestExamples": [
    {
      "contentType": "application/json",
      "example": {
        "Payments": [
          {
            "Status": "DELETED"
          }
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "ee23328c-4a8b-4ee7-8fb6-9796ffab9cb0",
        "Status": "OK",
        "ProviderName": "provider-name",
        "DateTimeUTC": "/Date(1583945852489)/",
        "Payments": [
          {
            "PaymentID": "c94c996b-1ab3-4ff3-ad19-1cdc77f30817",
            "Date": "/Date(1567382400000+0000)/",
            "BankAmount": 2.0,
            "Amount": 2.0,
            "Reference": "foobar",
            "CurrencyRate": 1.0,
            "PaymentType": "APCREDITPAYMENT",
            "Status": "DELETED",
            "UpdatedDateUTC": "/Date(1583945852373+0000)/",
            "HasAccount": true,
            "IsReconciled": false,
            "Account": {
              "AccountID": "57f261f0-e32d-4a7f-be82-22cd992c6367",
              "Code": "033",
              "Name": "Checking account"
            },
            "Invoice": {
              "Type": "ACCPAYCREDIT",
              "InvoiceID": "dba68ebc-c05a-4e2d-b97d-964349e5b8d6",
              "InvoiceNumber": "",
              "Reference": "",
              "Prepayments": [],
              "Overpayments": [],
              "AmountDue": 22.0,
              "AmountPaid": 0.0,
              "SentToContact": false,
              "CurrencyRate": 1.0,
              "IsDiscounted": false,
              "HasErrors": false,
              "Contact": {
                "ContactID": "216830cb-9a68-487e-928b-c1a7ccc4fc81",
                "Name": "FooBar73005",
                "ContactPersons": [],
                "HasValidationErrors": false
              },
              "DateString": "2017-01-02 00:00:00",
              "Date": "/Date(1483315200000+0000)/",
              "Status": "AUTHORISED",
              "LineAmountTypes": "Exclusive",
              "LineItems": [
                {
                  "Description": "Sample Item72716",
                  "UnitAmount": 20.0,
                  "TaxType": "INPUT",
                  "TaxAmount": 2.0,
                  "LineAmount": 20.0,
                  "AccountCode": "400",
                  "Tracking": [],
                  "Quantity": 1.0,
                  "ValidationErrors": []
                }
              ],
              "SubTotal": 20.0,
              "TotalTax": 2.0,
              "Total": 22.0,
              "UpdatedDateUTC": "/Date(1583945852363+0000)/",
              "CurrencyCode": "AUD"
            },
            "HasValidationErrors": false
          }
        ]
      }
    }
  ]
}