View source for Xero Accounting Endpoint: GetHistoryBatchPayment

== Overview ==

The Xero '''GetHistoryBatchPayment''' [[Xero Accounting Endpoints|endpoint]] provides a method to download the history and change logs for a single batch payment.

Two variations of this function exists.
* '''GetHistoryBatchPayment. ''' works for a single data file.
* '''GetHistoryBatchPaymentDataFile''' is recommended when using the consolidation OData Feed.

This function requires a single call to Xero for a single transaction. As such, it should only be used for a few transactions otherwise Xero will quickly impose the [[OdataLink Error Code 9004: Xero imposed a limit of 5000 calls per day on this data file|5000 calls daily limit]].

It is a [[Function Endpoints|function]] that accepts a series of parameters.


== Parameters ==

The GetHistoryBatchPayment is a [[Function Endpoints|function]] that accepts the following parameters.

;DataFile ''(for GetHistoryBatchPaymentDataFile only)''
:A [[Field Type: Text|text field]] that accepts the data file id, name or code.

;BatchPaymentID
:A [[Field Type: GUID|GUID field]] that accepts the id of the batch payment.


== Fields ==

The following fields are available for the GetHistoryBatchPayment endpoint.

;DataFileID
:A [[Field Type: GUID|GUID field]] representing the internal id of the data file within OdataLink. This field can be used to link to the [[Endpoint: DataFiles|data files endpoints]].

;DataFileName
:A [[Field Type: Text|text field]] used as the data file name.

;DataFileCode
:A [[Field Type: Text|text field]] used as the data file code.

;BatchPaymentID
:A [[Field Type: GUID|guid field]] that provides the id of the batch payment.

;Changes
:A [[Field Type: Text|text field]] that provides the type of change.
:Possible values are: 
:* '''Created'''
:* '''Edited'''
:* '''Approved'''
:* '''Reconciled'''
:* '''Deleted'''
:* '''Voided'''
:* '''(other values also possible)'''

;Details
:A [[Field Type: Text|text field]] that provides the details or note of the change.

;User
:A [[Field Type: Text|text field]] that provides the user name of the person that made the changes.

;DateUTC
:A [[Field Type: DateTimeOffset|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 [https://developer.xero.com/documentation/api/accounting/historyandnotes Xero API].


== Related Fields ==

:None


== Related Endpoints ==

:[[Xero Accounting Endpoint: BatchPayments|BatchPayments]]


== Related Topics ==

:[[Xero Accounting Models]]
:[[Xero Accounting Endpoints]]