HistoryInvoices
Used to query and insert the history of invoices issued within a Xero organization. It records all changes made to invoices over time.
Table Specific Information
The HistoryInvoices table allows you to read the notes created on a invoice, and the history of changes to that invoice. If a InvoiceId is not provided, the history of all Invoices will be retrieved.
An InvoiceId and Details is required for inserting a note:
INSERT INTO HistoryInvoices (InvoiceId, Details) VALUES ('...', 'Payment expected on December 1st'),
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 that each history entry is distinctly identifiable and enables accurate tracking of changes over time. |
| InvoiceId | String | False |
The unique identifier of the invoice to which this history item belongs. This field links the history entry to a specific invoice, providing context for the changes made to that invoice. |
| Changes | String | True |
Describes the type of change that occurred on the invoice. This could include modifications such as updates to the invoice amount, status, payment details, or the items listed on the invoice. |
| Date | Datetime | True |
The timestamp indicating when the change occurred. This field captures the exact time the modification was made, allowing for a chronological history of changes to the invoice. |
| User | String | True |
The name of the user who made the change. This field identifies the individual responsible for altering the invoice, ensuring accountability and transparency for the updates. |
| Details | String | False |
A detailed description of the specific change made to the invoice. This provides additional context on what was altered, such as the updated amount, new items, or payment terms. |
| TenantId | String | False |
The unique identifier for the tenant. This ensures that the query retrieves data specific to a particular tenant in multi-tenant environments, ensuring proper data isolation for different organizations. |