HistoryCreditNotes
Records the history and notes of credit notes issued within Xero. This is used for auditing purposes and tracking past credit note activities.
Table Specific Information
The HistoryCreditNotes table allows you to read the notes created on a
credit note, and the history of changes to that credit note. If a
CreditNoteId is not provided, the history of all CreditNotes will be
retrieved.
SELECT * FROM HistoryCreditNotes WHERE CreditNoteId = '...'
A CreditNoteId and Details is required for inserting a note:
INSERT INTO HistoryCreditNotes (CreditNoteId, Details) VALUES ('...', 'Offered 12% discount'),
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 history entry is distinctly identifiable, enabling accurate tracking of changes to the credit note. |
| CreditNoteId | String | False |
The unique identifier of the credit note to which this history item belongs. This field links the history entry to a specific credit note, making it easy to track changes to that credit note over time. |
| Changes | String | True |
Describes the type of change that happened to the credit note. This could include modifications such as updates to the credit note's amount, status, or details of the items being credited. |
| Date | Datetime | True |
The exact timestamp of when the change occurred. This field records the time at which the modification was made, providing a chronological history of changes for auditing and tracking purposes. |
| User | String | True |
The name of the user who made the change. This field identifies the person responsible for altering the credit note, ensuring accountability for updates made within the system. |
| Details | String | False |
A detailed description of the specific change that was made to the credit note. This provides clarity on what exactly was altered, such as the updated amount, status, or other details that were modified. |
| TenantId | String | False |
The unique identifier of the tenant. This ensures that the query retrieves data specific to a particular tenant, especially in multi-tenant environments where each tenant's data is kept separate and secure. |