Overview
Bank transactions in Xero refer to individual records of money flowing in and out of your connected bank accounts.
Forecasting with Bank Transactions
To simplify forecasting and budgeting, Connectorly automatically creates additional Bank Transaction entries (which can be filtered by Bank Transaction Status).
Forecast Invoice value created and added to the Actual Bank Transactions that come from Xero. The Bank Transaction Status field is used to distinguish them as follows:
Bank Transaction Status | Notes |
AUTHORISED | Actual Bank Transaction |
FORECAST INVOICE | These are calculated so that the effect of future REPEATING Invoices on forecasts and budgets can be seen. |
Multi-Currency Xero Support
As well as providing the Amount values of the original Bank Transaction, values for your chosen Reporting Currency are calculated. These are signified by (RC) after their name.
If you are working with Xero Bank Transaction data from multiple organisations, use the Reporting Currency (RC) values for any calculations, to avoid adding amounts that are in different currencies.
Data Dictionary
Field | Type | Notes |
Amount | Number | The amount of the bank transaction in the currency that Xero reports in. For example, if the Xero Organisation reports in USD, even if this was a EUR bank account, this would be in USD. Amounts are signed, so that credits are positive; and debits are negative. If you have grouped multiple Xero Organisations which report in different currencies, it doesn't make sense to sum this field. |
Amount (Currency) | Number | The amount of the bank transaction in the currency that it was transacted in. For example for a EUR bank account, this would be in EUR and for a USD it would be in USD. Amounts are signed, so that credits are positive; and debits are negative. If there are multiple bank accounts with different currencies it doesn't make sense to sum this field as these would be summing different currencies. |
Amount (RC) | Number | The amount of the bank transaction in the reporting currency set for Connectorly(s). For example, if the Xero Organisation reports in USD and you have set your reporting currency to be GBP, for a EUR bank account, this would be in GBP. Amounts are signed, so that credits are positive; and debits are negative. You can safely sum this field as the transactions are converted to the same reporting currency, even if there are multiple bank accounts with different currencies, across multiple, grouped Xero Organisations. |
Bank Account Code | Text | Bank account code in Xero |
Bank Account ID | Text | Bank Account ID. This is unique within a Xero Organisation. |
Bank Account Name | Text | Bank account name in Xero |
Bank Currency Code | Text | The Bank Transaction currency |
Bank Transaction ID | Text |
|
Bank Transaction Status | Text | {'AUTHORISED', 'DELETED', 'FORECAST INVOICE'} |
Connection Name | Text | The name of the Connection. Typically the name of the Xero Organisation. |
Contact ID | Text | The unique identifier for the Contact. This is guaranteed to be unique within a Xero Organisation. |
Contact Name | Text | The name of the Contact (Supplier or Customer). |
Credit Amount | Number | The amount credited (received or paid in) in the currency that Xero reports in. For example, if the Xero Organisation reports in USD, even if this was a EUR bank account, this would be in USD. If the bank was debited, then no value will be given here. Amounts are positive. If you have grouped multiple Xero Organisations which report in different currencies, it doesn't make sense to sum this field. |
Credit Amount (Currency) | Number | The amount credited (received or paid in) in the currency that it was transacted in. For example for a EUR bank account, this would be in EUR and for a USD it would be in USD. If the bank was credited, then no value will be given here. Amounts are positive. If there are multiple bank accounts with different currencies it doesn't make sense to sum this field. |
Credit Amount (RC) | Number | The amount credited (received or paid in) in the reporting currency set for Connectorly(s). For example, if your Organisation reports in USD and you have set your reporting currency to be GBP, for a EUR bank account, this would be in GBP (not EUR). For USD transactions they would also be in GBP. If the bank was debited, then no value will be given here. Amounts are positive. You can safely sum this field as the transactions are converted to the same reporting currency, even if there are multiple bank accounts with different currencies, across multiple, grouped Xero Organisations. |
Currency Code | Text | The Reporting Currency Code |
Data current as of | Datetime | When the Data was taken from Xero. |
Debit Amount | Number | The amount debited (spent or withdrawn) in the currency that Xero reports in. For example, if the Xero Organisation reports in USD, even if this was a EUR bank account, this would be in USD. If the bank account was credited, no value will be given here. Amounts are positive. If you have grouped multiple Xero Organisations, and are multiple bank accounts with different currencies it doesn't make sense to sum this field. |
Debit Amount (Currency) | Text | The amount debited (spent or withdrawn) in the currency that it was transacted in. For example for a EUR bank account, this would be in EUR and for a USD it would be in USD. If the bank was credited, then no value will be given here. Amounts are positive. If there are multiple bank accounts with different currencies it doesn't make sense to sum this field. |
Debit Amount (RC) | Number | The amount debited (spent or withdrawn) in the reporting currency set for Connectorly(s). For example, if your Organisation reports in USD and you have set your reporting currency to be GBP, for a EUR bank account, this would be in GBP (not EUR). For USD transactions they would also be in GBP. If the bank was credited, then no value will be given here. Amounts are positive. You can safely sum this field as the transactions are converted to the same reporting currency, even if there are multiple bank accounts with different currencies, across multiple, grouped Xero Organisations. |
Description | Text |
|
Reference | Text | The Reference (if any) from the Invoice that created the Bank Transaction. For a forecast bank transaction, the invoice the bank transaction forecast is based on. |
Reporting Currency Rate | Number |
|
Source Type | Text | {'ACCPAY', 'ACCPAYCREDIT', 'ACCPAYPAYMENT', 'ACCREC', 'ACCRECCREDIT', 'ACCRECPAYMENT', 'APCREDITPAYMENT', 'APOVERPAYMENT', 'APPREPAYMENT', 'ARCREDITPAYMENT', 'AROVERPAYMENT', 'CASHPAID', 'CASHREC', 'TRANSFER'} |
Transaction Date | Datetime | The date of the Bank Transaction |