Xero Accounting Endpoint: PaymentsTable

Overview

The Xero Payments endpoint provides the list of payment or refund transactions recorded within Xero.

Note this endpoint is an alternate format of the Payments endpoint. It provides a format that can more easily integrate with Tableau, SSIS and Azure Data Factory.

Fields

The following fields are available for the Payments endpoint.

DataFileID: A GUID field representing the internal id of the data file within OdataLink. This field can be used to link to the data files endpoints.

DataFileName: A text field used as the data file name.

DataFileCode: A text field used as the data file code.

PaymentID: A guid field that provides the id of the payment.

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.

AccountID: A GUID field representing the internal id of an account.

AccountCode: A text field provides the account code or number.

InvoiceID: A GUID field representing the internal id of an invoice.; This field can be linked to the Invoices or InvoicesExpanded endpoint.

InvoiceNumber: A text field that provides the invoice number.

InvoiceType

A text field that provides the invoice number.

Possible values are:

ACCPAY: Indicates the invoice is a supplier invoice / purchase.
ACCREC: Indicates the invoice is a customer invoice / sales.

ContactID: A GUID field representing the internal id of a contact.

ContactName: A text field provides the name of the contact

Amount: A decimal field that provides the amount of the payment.

CurrencyCode: A text field that provides currency code of the invoice.

CurrencyRate: A decimal field that provides the exchange rate applicable to the payment.

BatchPaymentID: A GUID field representing the internal id of a batch payment.; This field can be linked to the BatchPayments endpoint.

BatchPaymentDate: A date field that provides the date on which the batch payment occurred.

BatchPaymentType

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.

BatchPaymentStatus

A text field that indicates the status of the batch payment.

Possible values are: