Xero Accounting Endpoint: GetHistoryItem

From OdataLink
Jump to navigation Jump to search

Overview

The Xero GetHistoryItem endpoint provides a method to download the history and change logs for a single item.

Two variations of this function exists.

  • GetHistoryItem works for a single data file.
  • GetHistoryItemDataFile is recommended when using the consolidation OData Feed.

This function requires a single call to Xero for a single item. As such, it should only be used for a few items otherwise Xero will quickly impose the 5000 calls daily limit.

It is a function that accepts a series of parameters.


Parameters

The GetHistoryItem is a function that accepts the following parameters.

DataFile (for GetHistoryItemDataFile only)
A text field that accepts the data file id, name or code.
ItemID
A GUID field that accepts the id of the item.


Fields

The following fields are available for the GetHistoryItem endpoint.

DataFileID
A GUID field representing the internal id of the data file within OdataLink. This field can be used to link to the data files endpoints.
DataFileName
A text field used as the data file name.
DataFileCode
A text field used as the data file code.
ItemID
A guid field that provides the id of the item.
Changes
A text field that provides the type of change.
Possible values are:
  • Created
  • Edited
  • Approved
  • Reconciled
  • Deleted
  • Voided
  • (other values also possible)
Details
A text field that provides the details or note of the change.
User
A text field that provides the user name of the person that made the changes.
DateUTC
A date time field that indicates the date and time the changes were made.


Xero API

For a detailed run through of the endpoint, you can see the Xero API.


Related Fields

None


Related Endpoints

Items --- ItemsTable


Related Topics

Xero Accounting Models
Xero Accounting Endpoints