Xero Accounting Endpoint: BankTransactionsExpanded - Revision history

Nic at 22:43, 25 October 2023

2023-10-25T22:43:35Z

← Older revision		Revision as of 17:43, 25 October 2023
Line 125:		Line 125:

	;AccountID		;AccountID
	:A [[Field Type: ~~Text~~\|~~text~~ field]] that provides the [[Xero Accounting Endpoint: Accounts\|account id]] of the line.		:A [[Field Type: GUID\|guid field]] that provides the [[Xero Accounting Endpoint: Accounts\|account id]] of the line.

	;AccountCode		;AccountCode

Nic at 05:12, 22 September 2021

2021-09-22T05:12:25Z

← Older revision		Revision as of 00:12, 22 September 2021
Line 1:		Line 1:
	== Overview ==		== Overview ==

	The Xero '''BankTransactionsExpanded''' [[Endpoints\|endpoint]] provides the bank transactions.		The Xero '''BankTransactionsExpanded''' [[Xero Accounting Endpoints\|endpoint]] provides the bank transactions.

	Bank transactions include:		Bank transactions include:
Line 169:		Line 169:
	:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]		:[[Xero Accounting Endpoint: TaxRates\|TaxRates]]
	:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]		:[[Xero Accounting Endpoint: TrackingCategories\|TrackingCategories]]


			== Related Topics ==

			:[[Xero Accounting Models]]
			:[[Xero Accounting Endpoints]]

Nic at 04:26, 22 September 2021

2021-09-22T04:26:21Z

← Older revision		Revision as of 23:26, 21 September 2021
Line 81:		Line 81:

	;Subtotal		;Subtotal
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax exclusive amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the tax exclusive amount of the transaction.

	;TotalTax		;TotalTax
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the tax amount of the transaction.

	;Total		;Total
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the total amount of the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the total amount of the transaction.

	;CurrencyCode		;CurrencyCode
Line 93:		Line 93:

	;CurrencyRate		;CurrencyRate
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the exchange rate applied to the transaction.		:A [[Field Type: Decimal\|decimal field]] that provides the exchange rate applied to the transaction.

	;Url		;Url
Line 113:		Line 113:

	;UnitAmount		;UnitAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the unit amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the unit amount of the line.

	;TaxType		;TaxType
Line 119:		Line 119:

	;TaxAmount		;TaxAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the tax amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the tax amount of the line.

	;LineAmount		;LineAmount
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the amount of the line.		:A [[Field Type: Decimal\|decimal field]] that provides the amount of the line.

	;AccountID		;AccountID
Line 134:		Line 134:

	;Quantity		;Quantity
	:A [[Field Type: Decimal\|decimal ~~value~~]] that provides the quantity entered on the line.		:A [[Field Type: Decimal\|decimal field]] that provides the quantity entered on the line.

	;LineItemID		;LineItemID

Nic at 05:03, 21 September 2021

2021-09-21T05:03:14Z

← Older revision		Revision as of 00:03, 21 September 2021
Line 58:		Line 58:

	;Contact		;Contact
	:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting Field: ~~ContactsExpanded~~\|contact]] associated with the transaction.		:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting Field: Contacts\|contact]] associated with the transaction.

	;Date		;Date

Nic at 02:37, 21 September 2021

2021-09-21T02:37:20Z

← Older revision		Revision as of 21:37, 20 September 2021
Line 157:		Line 157:

	:[[Xero Accounting Endpoint: Accounts\|Accounts]]		:[[Xero Accounting Endpoint: Accounts\|Accounts]]
			:[[Xero Accounting Endpoint: BankTransactions\|BankTransactions]]
	:[[Xero Accounting Endpoint: BatchPayments\|BatchPayments]]		:[[Xero Accounting Endpoint: BatchPayments\|BatchPayments]]
	:[[Xero Accounting Endpoint: Contacts\|Contacts]]		:[[Xero Accounting Endpoint: Contacts\|Contacts]]

Nic: Created page with "== Overview == The Xero '''BankTransactionsExpanded''' endpoint provides the bank transactions. Bank transactions include: * spend money transactions * recei..."

2021-09-21T02:34:30Z

Created page with "== Overview == The Xero '''BankTransactionsExpanded''' endpoint provides the bank transactions. Bank transactions include: * spend money transactions * recei..."

New page

== Overview ==

The Xero '''BankTransactionsExpanded''' [[Endpoints|endpoint]] provides the bank transactions.

Bank transactions include:
* spend money transactions
* receive money transactions
* overpayments
* prepayments

This endpoints provides access to all fields and details. It is also optimised for larger data files.

In most situations, it is recommended to use this endpoint instead of the [[Xero Accounting Endpoint: BankTransactions|BankTransactions]] endpoint.

== Fields ==

The following fields are available for the BankTransfers endpoint.

;BankTransactionID
:A [[Field Type: GUID|guid field]] that provides the id of the transaction.

;BankAccount
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Accounts|bank account]] affected by the transaction.

;BatchPayment
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: BatchPayments|batch payment]] linked to this transaction if it is part of a batch payment.

;Type
:A [[Field Type: Text|text field]] that indicates the type of bank transaction.
:Possible values are:
:* '''RECEIVE''': Indicates the transaction is a receive money transaction.
:* '''RECEIVE-OVERPAYMENT''': Indicates the transaction is an overpayment on the accounts receivable / customer side.
:* '''RECEIVE-PREPAYMENT''': Indicates the transaction is an prepayment on the accounts receivable / customer side.
:* '''RECEIVE-TRANSFER''': Indicates the transaction is a transfer on the accounts receivable / customer side.
:* '''SPEND''': Indicates the transaction is a spend money transaction.
:* '''SPEND-OVERPAYMENT''': Indicates the transaction is an overpayment on the accounts payable /supplier side.
:* '''SPEND-PREPAYMENT''': Indicates the transaction is an prepayment on the accounts payable /supplier side.
:* '''SPEND-TRANSFER''': Indicates the transaction is transfer on the accounts payable /supplier side.

;Reference
:A [[Field Type: Text|text field]] that indicates the reference of the transaction.
:This field is only available for transactions whose '''Type''' is either '''RECEIVE''' or '''SPEND'''.

;IsReconciled
:A [[Field Type: Boolean|true/false field]] that indicates if the transaction has been reconciled.

;PrepaymentID
:A [[Field Type: GUID|guid field]] that provides the id of of the [[Xero Accounting Endpoint: PrepaymentsExpanded|prepayment]] if applicable.
:This field is only available for transactions whose '''Type''' is either '''RECEIVE-PREPAYMENT''' or '''SPEND-PREPAYMENT'''.

;OverpaymentID
:A [[Field Type: GUID|guid field]] that provides the id of of the [[Xero Accounting Endpoint: OverpaymentsExpanded|overpayment]] if applicable.
:This field is only available for transactions whose '''Type''' is either '''RECEIVE-OVERPAYMENT''' or '''SPEND-OVERPAYMENT'''.

;HasAttachments
:A [[Field Type: Boolean|true/false field]] that indicates if attachments were uploaded against the transaction.

;Contact
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: ContactsExpanded|contact]] associated with the transaction.

;Date
:A [[Field Type: Date|date field]] that provides the date on which the transaction occurred.

;Status
:A [[Field Type: Text|text field]] that indicates the status of the bank transaction.
:Possible values are:
:* '''AUTHORISED''': Indicates the transaction is authorised and has been processed.
:* '''DELETED''': Indicates the transaction has been deleted.

;LineAmountTypes
:A [[Field Type: Text|text field]] that indicates the type of values on the lines.
:Possible values are:
:* '''Exclusive''': Indicates that line items are exclusive of tax.
:* '''Inclusive''': Indicates that line items are inclusive tax.
:* '''NoTax''': Indicates that line items have no tax.

;LineItems
:A [[Field Type: Table|table field]] that provides the lines entered against the transaction.
:See [[#LineItems Fields|LineItems Fields]] for more information.

;Subtotal
:A [[Field Type: Decimal|decimal value]] that provides the tax exclusive amount of the transaction.

;TotalTax
:A [[Field Type: Decimal|decimal value]] that provides the tax amount of the transaction.

;Total
:A [[Field Type: Decimal|decimal value]] that provides the total amount of the transaction.

;CurrencyCode
:A [[Field Type: Text|text field]] that indicates the [[Xero Accounting Endpoint: Currencies|currency]] of the bank transaction.

;CurrencyRate
:A [[Field Type: Decimal|decimal value]] that provides the exchange rate applied to the transaction.

;Url
:A [[Field Type: Text|text field]] that provides the url to the source document.

;UpdatedDateUTC
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this transfer was created and/or updated.

== LineItems Fields ==

The [[#Fields|LineItems Fields]] include the following sub fields.

;ItemCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Items|item]] of the line.

;Description
:A [[Field Type: Text|text field]] that provides the description of the line.

;UnitAmount
:A [[Field Type: Decimal|decimal value]] that provides the unit amount of the line.

;TaxType
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: TaxTypes|tax type]] of the line.

;TaxAmount
:A [[Field Type: Decimal|decimal value]] that provides the tax amount of the line.

;LineAmount
:A [[Field Type: Decimal|decimal value]] that provides the amount of the line.

;AccountID
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account id]] of the line.

;AccountCode
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Endpoint: Accounts|account code]] of the line.

;Tracking
:A [[Field Type: Table|table field]] that provides the [[Xero Accounting Endpoint: TrackingCategories|tracking category options]] assigned to the line.

;Quantity
:A [[Field Type: Decimal|decimal value]] that provides the quantity entered on the line.

;LineItemID
:A [[Field Type: Text|text field]] that provides the internal id of the line.

== Xero API ==

For a detailed run through of the endpoint, you can see the [https://developer.xero.com/documentation/api/accounting/banktransactions Xero API].

== Related Fields ==

:[[Xero Accounting Field: Accounts|Accounts]]
:[[Xero Accounting Field: BatchPayments|BatchPayments]]
:[[Xero Accounting Field: Contacts|Contacts]]
:[[Xero Accounting Field: TaxTypes|TaxTypes]]
:[[Xero Accounting Field: TrackingCategories|TrackingCategories]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: BatchPayments|BatchPayments]]
:[[Xero Accounting Endpoint: Contacts|Contacts]]
:[[Xero Accounting Endpoint: ContactsExpanded|ContactsExpanded]]
:[[Xero Accounting Endpoint: Currencies|Currencies]]
:[[Xero Accounting Endpoint: Items|Items]]
:[[Xero Accounting Endpoint: Overpayments|Overpayments]]
:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
:[[Xero Accounting Endpoint: Prepayments|Prepayments]]
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]
:[[Xero Accounting Endpoint: TaxRates|TaxRates]]
:[[Xero Accounting Endpoint: TrackingCategories|TrackingCategories]]