BatchPayments
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True | The batch payment index combined with the Id of the batch payment. |
BatchPaymentId | String | True | The Id of the invoice. This field is assigned by Xero. |
AccountId | String | False | The ID of the account used to make the payment. It must either be a BANK account or have payments enabled. |
Particulars | String | False | (NZ only) The particulars that will appear on the statement. |
Code | String | False | (NZ only) The transaction code that will appear on the statement. |
Reference | String | False | (NZ only) The transaction reference that will appear on the statement. |
Details | String | False | (Non-NZ only) The details sent to the organization's bank as a reference for the bank transaction. |
Narrative | String | False | (UK only) A description that is only visible in the Xero statement line |
Date | Date | False | The date the payment is being made. |
Payment_PaymentId | String | True | The ID of the Payment. This field is assigned by Xero. |
Payment_InvoiceId | String | False | The ID of the Invoice the payment was made against |
Payment_BankAccountNumber | String | False | The account number of the bank the payment is being made to. |
Payment_Particulars | String | False | (NZ only) The particulars that will appear on the statement. |
Payment_Code | String | False | (NZ only) The transaction code that will appear on the supplier's bank account. |
Payment_Reference | String | False | (NZ only) The transaction reference that will appear on the supplier's bank account. |
Payment_Details | String | False | The details sent to the supplier's bank as a reference for the bank transaction. |
Payment_Amount | Decimal | False | The amount being paid. |
PaymentAggregate | String | False | Used to define Payment rows using XML values. Should be provided on INSERT only. |
Type | String | True | Either PAYBATCH for bill payments, or RECBATCH for sales payments. |
Status | String | True | Either AUTHORISED or DELETED |
TotalAmount | Decimal | True | The total of all the payments included in the batch |
IsReconciled | Boolean | True | Whether the batch payment has been reconciled |
UpdatedDateUTC | Datetime | True | The date when the batch payment was last updated. |
TenantId | String | False | The ID of the tenant to query instead of the connection tenant |
Last updated