Xero Accounting Endpoint: Payments
Jump to navigation
Jump to search
Overview
The Xero Payments endpoint provides the list of payment or refund transactions recorded within Xero.
Fields
The following fields are available for the Payments endpoint.
- DataFile
- A record field that provides the DataFile associated with the asset type.
- PaymentID
- A guid field that provides the id of the payment.
- BatchPayment
- A record field that provides the batch payment if applicable.
- PaymentType
- A text field that indicates the type of batch payment.
- Possible values are:
- ACCRECPAYMENT: Indicates it is a payment that applies to an accounts receivable payment.
- ACCPAYPAYMENT: Indicates it is a refund that applies to an accounts payable payment.
- ARCREDITPAYMENT: Indicates it is a refund that applies to an accounts receivable payment.
- APCREDITPAYMENT: Indicates it is a refund that applies to an accounts payable payment.
- AROVERPAYMENTPAYMENT: Indicates it is a refund that applies to an accounts receivable overpayment.
- ARPREPAYMENTPAYMENT: Indicates it is a refund that applies to an accounts receivable prepayment.
- APPREPAYMENTPAYMENT: Indicates it is a refund that applies to an accounts payable prepayment.
- APOVERPAYMENTPAYMENT: Indicates it is a refund that applies to an accounts payable overpayment.
- Reference
- A text field that provides the reference of the transaction.
- Date
- A date field that provides the date on which the payment occurred.
- Status
- A text field that indicates the status of the payment.
- Possible values are:
- AUTHORISED: Indicates the transaction is authorised and has been processed.
- DELETED: Indicates the transaction has been deleted.
- Account
- A record field that provides the account used to post the payment.
- Invoice
- A text field that provides the invoice associated with the payment.
- Amount
- A decimal field that provides the amount of the payment.
- CurrencyRate
- A decimal field that provides the exchange rate applicable to the payment.
- IsReconciled
- A true/false field that indicates if the payment has been reconciled.
- UpdatedDateUTC
- A date time field that indicates the date and time this payment was created and/or updated.
Xero API
For a detailed run through of the endpoint, you can see the Xero API.
Related Fields
Related Endpoints
- Accounts
- BatchPayments
- Invoices
- InvoicesExpanded
- PaymentsTable
- Overpayments
- OverpaymentsExpanded
- Prepayments
- PrepaymentsExpanded