History and Notes

Overview

URL https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/history
Methods Supported GET, PUT, POST
Description Allows you to retrieve the history of changes to a single existing document
Allows you add notes against a single existing document (See supported document types)

GET History

Response elements returned for GET History:

Changes The type of change recorded against the document. See here for a full list of possible changes
DateUTC UTC date that the history record was created
User The user responsible for the change ("System Generated" when the change happens via API)
Details Description of the change event or transaction

Example response retrieving History

GET https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/history

PUT History

Use this method to add notes to a document. Notes are the only type of Change that can be manually created. All other types of Change are created automatically when certain actions occur (e.g. an invoice is paid).

The note will be displayed in history & notes showing the date of creation and "System Generated" as the user that created it.

The following elements are used in a PUT request:

Details The note to be recorded against a single document. Max Length 250 characters.

Example request to add notes

PUT https://api.xero.com/api.xro/2.0/{Endpoint}/{Guid}/history

POST History

In this case a POST is exactly the same as a PUT. It's not possible to update history and notes.

Supported document types for adding notes

  • BankTransactions
  • BankTransfers
  • Contacts
  • Creditnotes
  • ExpenseClaims
  • Invoices
  • Items
  • Overpayments
  • Payments
  • Prepayments
  • Purchase Orders
  • Receipts
  • Repeating Invoices