Xero · Example Payload
Xero Getbankstatementaccounting Example
AccountingBank FeedsFinanceFinancial ServicesInvoicingPayrollSmall Business
Xero Getbankstatementaccounting 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": "getBankStatementAccounting",
"method": "GET",
"path": "/BankStatementsPlus/statements",
"summary": "Xero Get Bank Statement Accounting",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": {
"bankAccountId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"bankAccountName": "ANZ BANK",
"bankAccountCurrencyCode": "NZD",
"statements": [
{
"statementId": "7c29eee9-47f0-4179-bd46-9adb4f21cc7f",
"startDate": "2021-01-01",
"endDate": "2021-01-02",
"importedDateTimeUtc": "2021-01-02T12:00:00Z",
"importSource": "STMTIMPORTSRC/MANUAL",
"startBalance": 10.0,
"endBalance": 200.0,
"indicativeStartBalance": 10.0,
"indicativeEndBalance": 200.0,
"statementLines": [
{
"statementLineId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"postedDate": "2021-01-01",
"payee": "ACME Thneeds ABC1234567890 SYDNEY",
"reference": "Eft",
"notes": "payment to bank",
"chequeNo": "123",
"amount": 100.0,
"transactionDate": "2021-01-01",
"type": "Debit",
"isReconciled": true,
"isDuplicate": false,
"isDeleted": false,
"payments": [
{
"paymentId": "47ec8431-23c2-4ef9-90e5-b440fe55d086",
"batchPaymentId": "ecc83387-ffaa-4023-b111-b3fd9e3e4a8e",
"date": "2021-01-01",
"amount": 80.0,
"bankAmount": 80.0,
"currencyRate": 1.0,
"invoice": {
"invoiceId": "c01dd6ac-8835-4bf2-af8b-841db9534d7f",
"contact": {
"contactId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"contactName": "Bob"
},
"total": 80.0,
"lineItems": [
{
"accountId": "f7fe1049-d1cf-4d10-9df1-67a6e363015f",
"reportingCode": "REV.OTH",
"lineAmount": 80.0,
"accountType": "REVENUE"
}
]
}
},
{
"paymentId": "54e8eee0-91a7-4a4d-bb9b-957302a2760a",
"batchPaymentId": "ecc83387-ffaa-4023-b111-b3fd9e3e4a8e",
"date": "2021-01-01",
"amount": 15.0,
"bankAmount": 15.0,
"currencyRate": 1.0,
"creditNote": {
"creditNoteId": "c346d6a5-f013-4207-bc70-f2dd80a5f37f",
"contact": {
"contactId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"contactName": "Bob"
},
"total": 15.0,
"lineItems": [
{
"accountId": "f7fe1049-d1cf-4d10-9df1-67a6e363015f",
"reportingCode": "REV.OTH",
"lineAmount": 15.0,
"accountType": "REVENUE"
}
]
}
},
{
"paymentId": "f94dad64-658c-491f-b901-05d38e9e8702",
"date": "2021-01-01",
"amount": 5.0,
"bankAmount": 5.0,
"currencyRate": 1.0,
"prepayment": {
"prepaymentId": "995f81ae-0afd-4c84-bbe1-90bc7dfa4372",
"contact": {
"contactId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"contactName": "Bob"
},
"total": 5.0,
"lineItems": [
{
"accountId": "f7fe1049-d1cf-4d10-9df1-67a6e363015f",
"reportingCode": "REV.OTH",
"lineAmount": 5.0,
"accountType": "REVENUE"
}
]
}
},
{
"paymentId": "6ffbe999-04c8-42d2-bf16-13947c5f1036",
"date": "2021-01-01",
"amount": 5.0,
"bankAmount": 5.0,
"currencyRate": 1.0,
"overpayment": {
"overpaymentId": "06575718-5100-4e02-8fbf-c2731a112836",
"contact": {
"contactId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"contactName": "Bob"
},
"total": 5.0,
"lineItems": [
{
"accountId": "f7fe1049-d1cf-4d10-9df1-67a6e363015f",
"reportingCode": "REV.OTH",
"lineAmount": 5.0,
"accountType": "REVENUE"
}
]
}
}
],
"bankTransactions": [
{
"bankTransactionId": "55edf88c-6bf6-459a-bd9b-7f250df62eb2",
"batchPaymentId": "2dce9b39-0427-41af-9739-9510e3b68211",
"contact": {
"contactId": "1234eee9-47f0-4179-bd46-9adb4f21cc7f",
"contactName": "Bob"
},
"date": "2021-01-01",
"amount": 20.0,
"lineItems": [
{
"accountId": "f7fe1049-d1cf-4d10-9df1-67a6e363015f",
"reportingCode": "REV.OTH",
"lineAmount": 20.0,
"accountType": "REVENUE"
}
]
}
]
}
]
}
]
}
},
{
"status": "400",
"contentType": "application/json",
"example": {
"type": "invalid-request",
"title": "InvalidRequest",
"status": 400,
"detail": "AccountId was not supplied"
}
}
]
}