HistoryBatchPayments
Used to query and insert history and notes of batch payments. This helps track historical data on bulk payments made to vendors or suppliers.
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')
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
A unique identifier for the history item, combining its position in the history log with the timestamp of when the change occurred. This ensures each entry is distinctly identifiable and provides chronological tracking of changes. |
| BatchPaymentId | String | False |
The unique identifier of the item (such as a batch payment) that this history item belongs to. This links the history entry to a specific payment batch, enabling users to track changes made to that batch. |
| Changes | String | True |
Describes the type of change that happened on the item. This could include modifications to the batch payment details, such as changes to the amount, payment status, or accounts involved. |
| Date | Datetime | True |
The timestamp of when the change occurred. This field provides a clear record of when a particular modification was made, allowing for precise tracking of the changes in the system. |
| User | String | True |
The name of the user who made the change. This field identifies the individual who performed the modification, helping to ensure accountability and transparency in the system. |
| Details | String | False |
A detailed description of the specific change that was made. This could include information on which fields were modified and how, providing users with context and clarity on the adjustments made to the item. |
| TenantId | String | False |
The unique identifier of the tenant. This field allows the query to access data specific to a particular tenant in multi-tenant environments, ensuring that changes are isolated to the correct tenant's data. |