Payments
Query, insert and delete payments for a Xero organisation.
Table Specific Information
The Payments table allows you to SELECT and INSERT payments for a Xero organization.
Note that this tables does not include payments on expense claims - to retrieve those, you will need to read from the ExpenseClaimPayments view.
SELECT
The Xero API allows extensive filtering and ordering. You can define WHERE and ORDER BY clauses in a query to filter and order the results using any non-line-item column.
Note: The Xero API does not support filtering on line items or journal lines.
INSERT
Inserting a single row is straightforward, even with line item tables. Simply set the required fields and a new table object will be created as a single entry. To insert a new payment record, the InvoiceNumber and AccountCode fields are required.
Columns
| Name | Type | ReadOnly | Description |
| PaymentId [KEY] | String | True |
The Id of the payment. |
| Date | Date | False |
The date the payment is being made. |
| Amount | Decimal | False |
The amount of the payment. This value must be less than or equal to the outstanding amount owing on the invoice. |
| CurrencyRate | Decimal | False |
The exchange rate when the payment is received. This field is only used for non-base-currency invoices and credit notes. |
| Reference | String | False |
A optional description for the payment. |
| PaymentType | String | False |
The payment type. |
| Status | String | False |
The status of the payment. |
| UpdatedDateUTC | Datetime | False |
The date when the payment was last updated. |
| IsReconciled | Boolean | False |
This field indicates whether the payment has been reconciled. Only available when querying for one payment at a time. |
| BatchPaymentId | String | True |
If the payment was submitted through BatchPayments, this is the ID of the batch it was provided with. |
| InvoiceId | String | False |
The Id of the invoice. When applying a payment, specify either the InvoiceId or the InvoiceNumber. |
| InvoiceNumber | String | False |
The invoice number of the invoice or credit note. When applying a payment, specify either the InvoiceId or the InvoiceNumber. |
| CreditNoteId | String | False |
The Id of the credit note. When applying a payment, specify either the CreditNoteId or the CreditNoteNumber. |
| CreditNoteNumber | String | False |
The credit note number. When applying a payment, specify either the CreditNoteId or the CreditNoteNumber. |
| AccountId | String | False |
The Id of the account used to make the payment. The account type must be BANK or payments to the account must be enabled. |
| AccountCode | String | False |
The account code of the account used to make the payment. |
| TenantId | String | False |
The ID of the tenant to query instead of the connection tenant |