Xero Accounting Endpoint: BatchPayments
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.
- 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.
Payments Fields
The Payments Fields include the following sub fields.
- Invoice
- A text field that provides the invoice associated with the payment line.
- PaymentID
- A guid field that provides the id of the payment line.
- Amount
- A decimal field that provides the amount of the payment line.
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