HistoryOverpayments
Used to query the history and notes of overpayments in Xero. Overpayments occur when a customer pays more than the amount due.
View Specific Information
The HistoryOverpayments view allows you to read the notes created on a overpayment, and the history of changes to that overpayment. If a OverpaymentId is not provided, the history of all Overpayments will be retrieved.
Columns
| Name | Type | Description |
| Id [KEY] | String | 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, enabling accurate tracking of changes over time. |
| OverpaymentId | String | The unique identifier of the overpayment that this history item belongs to. This field links the history item to a specific overpayment record, ensuring changes to overpayments can be traced and monitored. |
| Changes | String | Describes the type of change that occurred on the overpayment. This could include modifications such as changes to the overpayment amount, status, or related transaction details, providing insight into the nature of the modification. |
| Date | Datetime | The timestamp when the change occurred. This field records the exact time the modification was made, providing a clear timeline of updates to the overpayment. |
| User | String | The name of the user who made the change. This field identifies the individual responsible for altering the overpayment, ensuring accountability for updates in the system. |
| Details | String | A detailed description of the specific change that was made to the overpayment. This provides further context about what was modified, such as updated amounts, statuses, or other relevant changes. |
| TenantId | String | The unique identifier of the tenant. This ensures the query retrieves data specific to a particular tenant in multi-tenant environments, ensuring proper data isolation between tenants. |