Xero Accounting Endpoint: BatchPayments - Revision history

Nic at 06:14, 4 June 2025

2025-06-04T06:14:25Z

← Older revision		Revision as of 01:14, 4 June 2025
Line 126:		Line 126:
	:[[Xero Accounting Models]]		:[[Xero Accounting Models]]
	:[[Xero Accounting Endpoints]]		:[[Xero Accounting Endpoints]]


			== Change Logs ==

			:'''2025-06-04''': Updated to include the following fields.
			:: Account.CurrencyCode
			:: Payments.BankAmount
			:: Payments.Invoice.CurrencyCode

Nic at 06:12, 4 June 2025

2025-06-04T06:12:46Z

@@ Line 15: / Line 15: @@
 ;Account
 :A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Accounts|account]] used to post the batch payment.
 ;Reference
@@ Line 52: / Line 53: @@
 ;UpdatedDateUTC
 :A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this batch payment was created and/or updated.
@@ Line 60: / Line 74: @@
 ;Invoice
 :A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Invoices|invoice]] associated with the payment line.
 ;PaymentID
@@ Line 69: / Line 84: @@
 ;BankAmount
 :A [[Field Type: Decimal|decimal field]] that provides the amount of the payment line.

Nic at 06:09, 4 June 2025

2025-06-04T06:09:24Z

← Older revision		Revision as of 01:09, 4 June 2025
Line 59:		Line 59:

	;Invoice		;Invoice
	:A [[Field Type: ~~Text~~\|~~text~~ field]] that provides the [[Xero Accounting Field: Invoices\|invoice]] associated with the payment line.		:A [[Field Type: Record\|record field]] that provides the [[Xero Accounting Field: Invoices\|invoice]] associated with the payment line.

	;PaymentID		;PaymentID
Line 65:		Line 65:

	;Amount		;Amount
			:A [[Field Type: Decimal\|decimal field]] that provides the amount of the payment line.

			;BankAmount
	:A [[Field Type: Decimal\|decimal field]] that provides the amount of the payment line.		:A [[Field Type: Decimal\|decimal field]] that provides the amount of the payment line.

Nic at 05:13, 22 September 2021

2021-09-22T05:13:05Z

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

	The Xero '''BatchPayments''' [[Endpoints\|endpoint]] provides the list of batch payment transactions recorded within Xero.		The Xero '''BatchPayments''' [[Xero Accounting Endpoints\|endpoint]] provides the list of batch payment transactions recorded within Xero.

	Batch payments are used in Xero to group payments that hit the bank account as a single amount in order to make it easy to reconcile the total amount.		Batch payments are used in Xero to group payments that hit the bank account as a single amount in order to make it easy to reconcile the total amount.
Line 89:		Line 89:
	:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]		:[[Xero Accounting Endpoint: Prepayments\|Prepayments]]
	:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]		:[[Xero Accounting Endpoint: PrepaymentsExpanded\|PrepaymentsExpanded]]


			== Related Topics ==

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

Nic at 04:21, 22 September 2021

2021-09-22T04:21:49Z

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

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

	;IsReconciled		;IsReconciled
Line 65:		Line 65:

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

Nic at 03:48, 21 September 2021

2021-09-21T03:48:15Z

← Older revision		Revision as of 22:48, 20 September 2021
Line 4:		Line 4:

	Batch payments are used in Xero to group payments that hit the bank account as a single amount in order to make it easy to reconcile the total amount.		Batch payments are used in Xero to group payments that hit the bank account as a single amount in order to make it easy to reconcile the total amount.


	== Fields ==		== Fields ==

Nic: Created page with "== Overview == The Xero '''BatchPayments''' endpoint provides the list of batch payment transactions recorded within Xero. Batch payments are used in Xero to g..."

2021-09-21T03:38:08Z

Created page with "== Overview == The Xero '''BatchPayments''' endpoint provides the list of batch payment transactions recorded within Xero. Batch payments are used in Xero to g..."

New page

== Overview ==

The Xero '''BatchPayments''' [[Endpoints|endpoint]] provides the list of batch payment transactions recorded within Xero.

Batch payments are used in Xero to group payments that hit the bank account as a single amount in order to make it easy to reconcile the total amount.

== Fields ==

The following fields are available for the BatchPayments endpoint.

;BatchPaymentID
:A [[Field Type: GUID|guid field]] that provides the id of the batch payment.

;Account
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Accounts|account]] used to post the batch payment.

;Reference
:A [[Field Type: Text|text field]] that provides the reference of the transaction (NZ only).

;Particulars
:A [[Field Type: Text|text field]] that provides the particulars of the transaction (NZ only).

;Narrative
:A [[Field Type: Text|text field]] that provides the narrative of the transaction (NZ only).

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

;Payments
:A [[Field Type: Table|table field]] that provides the detailed payments, prepayments, overpayments, spend money and receive money include in the batch payment.
:See [[#Payments Fields|Payments Fields]] for more information.

;Type
:A [[Field Type: Text|text field]] that indicates the type of batch payment.
:Possible values are:
:* '''PAYBATCH ''': Indicates the batch payment is for accounts payable / supplier side.
:* '''RECBATCH ''': Indicates the batch payment is for accounts receivable / customer side.

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

;TotalAmount
:A [[Field Type: Decimal|decimal value]] that provides the total amount of the batch payment.

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

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

== Payments Fields ==

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

;Invoice
:A [[Field Type: Text|text field]] that provides the [[Xero Accounting Field: Invoices|invoice]] associated with the payment line.

;PaymentID
:A [[Field Type: GUID|guid field]] that provides the id of the payment line.

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

== Xero API ==

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

== Related Fields ==

:[[Xero Accounting Field: Accounts|Accounts]]
:[[Xero Accounting Field: Invoices|Invoices]]

== Related Endpoints ==

:[[Xero Accounting Endpoint: Accounts|Accounts]]
:[[Xero Accounting Endpoint: Invoices|Invoices]]
:[[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]]
:[[Xero Accounting Endpoint: Overpayments|Overpayments]]
:[[Xero Accounting Endpoint: OverpaymentsExpanded|OverpaymentsExpanded]]
:[[Xero Accounting Endpoint: Payments|Payments]]
:[[Xero Accounting Endpoint: Prepayments|Prepayments]]
:[[Xero Accounting Endpoint: PrepaymentsExpanded|PrepaymentsExpanded]]