Xero · Example Payload
Xero Updatebanktransaction Example
AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Updatebanktransaction 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
{
"operationId": "updateBankTransaction",
"method": "POST",
"path": "/BankTransactions/{BankTransactionID}",
"summary": "Xero Updates a single spent or received money transaction",
"requestExamples": [
{
"contentType": "application/json",
"example": {
"BankTransactions": [
{
"Type": "SPEND",
"Contact": {
"ContactID": "00000000-0000-0000-0000-000000000000",
"ContactStatus": "ACTIVE",
"Name": "Buzz Lightyear",
"FirstName": "Buzz",
"LastName": "Lightyear",
"EmailAddress": "buzz.Lightyear@email.com",
"ContactPersons": [],
"BankAccountDetails": "",
"Addresses": [
{
"AddressType": "STREET",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
{
"AddressType": "POBOX",
"AddressLine1": "",
"AddressLine2": "",
"AddressLine3": "",
"AddressLine4": "",
"City": "Palo Alto",
"Region": "CA",
"PostalCode": "94020",
"Country": "United States"
}
],
"Phones": [
{
"PhoneType": "DEFAULT",
"PhoneNumber": "847-1294",
"PhoneAreaCode": "(626)",
"PhoneCountryCode": ""
},
{
"PhoneType": "DDI",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
},
{
"PhoneType": "FAX",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
},
{
"PhoneType": "MOBILE",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
}
],
"UpdatedDateUTC": "2017-08-21T13:49:04.227-07:00",
"ContactGroups": []
},
"Lineitems": [],
"BankAccount": {
"Code": "088",
"Name": "Business Wells Fargo",
"AccountID": "00000000-0000-0000-0000-000000000000"
},
"IsReconciled": false,
"Date": "2019-02-25",
"Reference": "You just updated",
"CurrencyCode": "USD",
"CurrencyRate": 1,
"Status": "AUTHORISED",
"LineAmountTypes": "Inclusive",
"TotalTax": 1.74,
"BankTransactionID": "00000000-0000-0000-0000-000000000000",
"UpdatedDateUTC": "2019-02-26T12:39:27.813-08:00"
}
]
}
}
],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"Id": "f2c7f037-96fc-49bd-8f59-d3c7bfdd4746",
"Status": "OK",
"ProviderName": "Xero API Partner",
"DateTimeUTC": "/Date(1551213568875)/",
"BankTransactions": [
{
"BankTransactionID": "1289c190-e46d-434b-9628-463ffdb52f00",
"BankAccount": {
"AccountID": "6f7594f2-f059-4d56-9e67-47ac9733bfe9",
"Code": "088",
"Name": "Business Wells Fargo"
},
"Type": "SPEND",
"Reference": "You just updated",
"IsReconciled": false,
"CurrencyRate": 1.0,
"HasAttachments": false,
"Attachments": [],
"Contact": {
"ContactID": "5cc8cf28-567e-4d43-b287-687cfcaec47c",
"ContactStatus": "ACTIVE",
"Name": "Katherine Warren",
"FirstName": "Katherine",
"LastName": "Warren",
"EmailAddress": "kat.warren@clampett.com",
"BankAccountDetails": "",
"Addresses": [
{
"AddressType": "STREET",
"City": "",
"Region": "",
"PostalCode": "",
"Country": ""
},
{
"AddressType": "POBOX",
"AddressLine1": "",
"AddressLine2": "",
"AddressLine3": "",
"AddressLine4": "",
"City": "Palo Alto",
"Region": "CA",
"PostalCode": "94020",
"Country": "United States"
}
],
"Phones": [
{
"PhoneType": "DEFAULT",
"PhoneNumber": "847-1294",
"PhoneAreaCode": "(626)",
"PhoneCountryCode": ""
},
{
"PhoneType": "DDI",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
},
{
"PhoneType": "FAX",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
},
{
"PhoneType": "MOBILE",
"PhoneNumber": "",
"PhoneAreaCode": "",
"PhoneCountryCode": ""
}
],
"UpdatedDateUTC": "/Date(1503348544227+0000)/",
"ContactGroups": [],
"ContactPersons": [],
"HasValidationErrors": false
},
"DateString": "2019-02-25 00:00:00",
"Date": "/Date(1551052800000+0000)/",
"Status": "AUTHORISED",
"LineAmountTypes": "Inclusive",
"LineItems": [
{
"Description": "Foobar",
"UnitAmount": 20.0,
"TaxType": "TAX001",
"TaxAmount": 1.74,
"LineAmount": 20.0,
"AccountCode": "400",
"Tracking": [],
"Quantity": 1.0,
"LineItemID": "d2a06879-da49-4d6c-83b5-72a93a523ec6",
"AccountID": "ebd06280-af70-4bed-97c6-7451a454ad85",
"ValidationErrors": []
}
],
"SubTotal": 18.26,
"TotalTax": 1.74,
"Total": 20.0,
"UpdatedDateUTC": "/Date(1551213568733+0000)/",
"CurrencyCode": "USD"
}
]
}
}
]
}