Xero Accounting Endpoint: BatchPayments: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 15: | Line 15: | ||
;Account | ;Account | ||
:A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Accounts|account]] used to post the batch payment. | :A [[Field Type: Record|record field]] that provides the [[Xero Accounting Field: Accounts|account]] used to post the batch payment. | ||
:See [[#Account Fields|Account Fields]] for more information. | |||
;Reference | ;Reference | ||
| Line 52: | Line 53: | ||
;UpdatedDateUTC | ;UpdatedDateUTC | ||
:A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this batch payment was created and/or updated. | :A [[Field Type: DateTimeOffset|date time field]] that indicates the date and time this batch payment was created and/or updated. | ||
== Account Fields == | |||
The [[#Fields|Account Fields]] include the following sub fields. | |||
;AccountID | |||
:A [[Field Type: GUID|GUID field]] representing the internal id of an account. | |||
:This field can be linked to the [[Xero Accounting Endpoint: Accounts|Accounts]] endpoint. | |||
;CurrencyCode | |||
:A [[Field Type: Text|text field]] provides the ISO currency code. | |||
:This field can be linked to the [[Xero Accounting Endpoint: Currencies|Currencies]] endpoint. | |||
| Line 60: | Line 74: | ||
;Invoice | ;Invoice | ||
:A [[Field Type: Record|record 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. | ||
:See [[#Invoice Fields|Invoice Fields]] for more information. | |||
;PaymentID | ;PaymentID | ||
| Line 69: | Line 84: | ||
;BankAmount | ;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. | ||
== Invoice Fields == | |||
The [[#Fields|Invoice Fields]] include the following sub fields. | |||
;InvoiceID | |||
:A [[Field Type: GUID|GUID field]] representing the internal id of an invoice. | |||
:This field can be linked to the [[Xero Accounting Endpoint: Invoices|Invoices]] or [[Xero Accounting Endpoint: InvoicesExpanded|InvoicesExpanded]] endpoint. | |||
;CurrencyCode | |||
:A [[Field Type: Text|text field]] provides the ISO currency code. | |||
:This field can be linked to the [[Xero Accounting Endpoint: Currencies|Currencies]] endpoint. | |||
| Line 98: | 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 | |||
Latest revision as of 01:14, 4 June 2025
Overview
The Xero BatchPayments 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 guid field that provides the id of the batch payment.
- Account
- A record field that provides the account used to post the batch payment.
- See Account Fields for more information.
- Reference
- A text field that provides the reference of the transaction (NZ only).
- Particulars
- A text field that provides the particulars of the transaction (NZ only).
- Narrative
- A text field that provides the narrative of the transaction (NZ only).
- Date
- A date field that provides the date on which the transaction occurred.
- Payments
- A table field that provides the detailed payments, prepayments, overpayments, spend money and receive money include in the batch payment.
- See Payments Fields for more information.
- Type
- A 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 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 decimal field that provides the total amount of the batch payment.
- IsReconciled
- A true/false field that indicates if the batch payment has been reconciled.
- UpdatedDateUTC
- A date time field that indicates the date and time this batch payment was created and/or updated.
Account Fields
The Account Fields include the following sub fields.
- AccountID
- A GUID field representing the internal id of an account.
- This field can be linked to the Accounts endpoint.
- CurrencyCode
- A text field provides the ISO currency code.
- This field can be linked to the Currencies endpoint.
Payments Fields
The Payments Fields include the following sub fields.
- Invoice
- A record field that provides the invoice associated with the payment line.
- See Invoice Fields for more information.
- PaymentID
- A guid field that provides the id of the payment line.
- Amount
- A decimal field that provides the amount of the payment line.
- BankAmount
- A decimal field that provides the amount of the payment line.
Invoice Fields
The Invoice Fields include the following sub fields.
- InvoiceID
- A GUID field representing the internal id of an invoice.
- This field can be linked to the Invoices or InvoicesExpanded endpoint.
- CurrencyCode
- A text field provides the ISO currency code.
- This field can be linked to the Currencies endpoint.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- Invoices
- InvoicesExpanded
- Overpayments
- OverpaymentsExpanded
- Payments
- Prepayments
- PrepaymentsExpanded
Related Topics
Change Logs
- 2025-06-04: Updated to include the following fields.
- Account.CurrencyCode
- Payments.BankAmount
- Payments.Invoice.CurrencyCode