HistoryContacts
Queries and maintains the history and notes of contact records. It helps keep track of all actions and updates related to contacts within the Xero organization.
Table Specific Information
The HistoryContacts table allows you to read the notes created on a contact, and the history of changes to that contact. If a ContactId is not provided, the history of all Contacts will be retrieved.
A ContactId and Details is required for inserting a note:
INSERT INTO HistoryContacts (ContactId, Details) VALUES ('...', 'Reliable customer'),
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, allowing for accurate tracking of changes over time. |
| ContactId | String | False |
The unique identifier of the contact that this history item belongs to. This links the history entry to a specific contact, allowing users to trace changes made to that particular contact record. |
| Changes | String | True |
Describes the type of change that happened on the contact. This could include modifications such as updates to the contact's details (for example, address, email), status (for example, active or archived), or other related information. |
| Date | Datetime | True |
The timestamp of when the change occurred. This field records the exact time the modification was made, providing a chronological record of changes to the contact's information. |
| User | String | True |
The name of the user who made the change. This field identifies the individual responsible for modifying the contact, ensuring accountability and transparency for actions performed in the system. |
| Details | String | False |
A detailed description of the specific change that was made. This provides clarity on what exactly was altered in the contact record, offering transparency and context to the change. |
| TenantId | String | False |
The unique identifier of the tenant. This ensures that the query accesses data specific to a particular tenant, especially in multi-tenant environments where data for different tenants is isolated and needs to be queried separately. |