Xero · Example Payload

Xero Getbanktransactions Example

AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business

Xero Getbanktransactions 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": "getBankTransactions",
  "method": "GET",
  "path": "/BankTransactions",
  "summary": "Xero Retrieves any spent or received money transactions",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "example": {
        "Id": "18e7e80c-5dca-4a57-974e-8b572cc5efe8",
        "Status": "OK",
        "ProviderName": "Xero API Partner",
        "DateTimeUTC": "/Date(1551212901659)/",
        "pagination": {
          "page": 1,
          "pageSize": 100,
          "pageCount": 1,
          "itemCount": 3
        },
        "BankTransactions": [
          {
            "BankTransactionID": "db54aab0-ad40-4ced-bcff-0940ba20db2c",
            "BankAccount": {
              "AccountID": "6f7594f2-f059-4d56-9e67-47ac9733bfe9",
              "Code": "088",
              "Name": "Business Wells Fargo"
            },
            "BatchPayment": {
              "Account": {
                "AccountID": "6f7594f2-f059-4d56-9e67-47ac9733bfe9"
              },
              "BatchPaymentID": "b54aa50c-794c-461b-89d1-846e1b84d9c0",
              "Date": "/Date(1476316800000+0000)/",
              "Type": "RECBATCH",
              "Status": "AUTHORISED",
              "TotalAmount": "12.00",
              "UpdatedDateUTC": "/Date(1476392487037+0000)/",
              "IsReconciled": "false"
            },
            "Type": "RECEIVE",
            "IsReconciled": false,
            "PrepaymentID": "cb62750f-b49c-464b-a45b-e2e2c514c8a9",
            "HasAttachments": true,
            "Contact": {
              "ContactID": "9c2c64de-12c9-4167-b503-e2c0e1aa1f49",
              "Name": "sam",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2016-10-13 00:00:00",
            "Date": "/Date(1476316800000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "Exclusive",
            "LineItems": [],
            "SubTotal": 10,
            "TotalTax": 0,
            "Total": 10,
            "UpdatedDateUTC": "/Date(1476389616437+0000)/",
            "CurrencyCode": "USD"
          },
          {
            "BankTransactionID": "29a69c45-64ca-4805-a1cc-34990de837b3",
            "BankAccount": {
              "AccountID": "6f7594f2-f059-4d56-9e67-47ac9733bfe9",
              "Code": "088",
              "Name": "Business Wells Fargo"
            },
            "Type": "SPEND-OVERPAYMENT",
            "IsReconciled": false,
            "OverpaymentID": "7d457db3-3b0a-47e9-8b79-81252a7bcdcb",
            "HasAttachments": false,
            "Contact": {
              "ContactID": "9c2c64de-12c9-4167-b503-e2c0e1aa1f49",
              "Name": "sam",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2016-10-13 00:00:00",
            "Date": "/Date(1476316800000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "NoTax",
            "LineItems": [],
            "SubTotal": 9,
            "TotalTax": 0,
            "Total": 9,
            "UpdatedDateUTC": "/Date(1476389930500+0000)/",
            "CurrencyCode": "USD"
          },
          {
            "BankTransactionID": "0b89bf5c-d40b-4514-96be-36a739fb0188",
            "BankAccount": {
              "AccountID": "6f7594f2-f059-4d56-9e67-47ac9733bfe9",
              "Code": "088",
              "Name": "Business Wells Fargo"
            },
            "Type": "SPEND-OVERPAYMENT",
            "IsReconciled": false,
            "OverpaymentID": "bf9b5f33-c0d6-4182-84a2-40848023e5a1",
            "HasAttachments": false,
            "Contact": {
              "ContactID": "9c2c64de-12c9-4167-b503-e2c0e1aa1f49",
              "Name": "sam",
              "Addresses": [],
              "Phones": [],
              "ContactGroups": [],
              "ContactPersons": [],
              "HasValidationErrors": false
            },
            "DateString": "2016-10-13 00:00:00",
            "Date": "/Date(1476316800000+0000)/",
            "Status": "AUTHORISED",
            "LineAmountTypes": "NoTax",
            "LineItems": [],
            "SubTotal": 8,
            "TotalTax": 0,
            "Total": 8,
            "UpdatedDateUTC": "/Date(1476392487037+0000)/",
            "CurrencyCode": "USD"
          }
        ]
      }
    }
  ]
}