FireDAC Components for Xero

Build 23.0.8839


Query and insert BatchPayment history and notes for a Xero organization.

Table Specific Information

The HistoryBatchPayments table allows you to read the notes created on a batch payment, and the history of changes to that batch payment. If a BatchPaymentId is not provided, the history of all batch payments will be retrieved.

An BatchPaymentId and Details is required for inserting a note:

INSERT INTO HistoryBatchPayments (BatchPaymentId, Details) VALUES ('...', 'Batch submitted on 3/1/2019')


Name Type ReadOnly Description
Id [KEY] String True

A combination of the position of the history item and when it occurred.

BatchPaymentId String True

The ID of the item the history item belongs to.

Changes String True

What type of change happened on the item

Date Datetime True

When the change occurred

User String True

The name of the user that made the change

Details String False

The change that was made

TenantId String False

The ID of the tenant to query instead of the connection tenant

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8839