ReportBatchHistory Element

Description

ReportBatchHistory returns information about previous batches over a period of time. This report is for the site referenced in the header.

Namespace

http://Hps.Exchange.PosGateway

Type

PosReportBatchHistoryReqType Complex Type

Diagram

Overview

ReportBatchHistory PosReportBatchHistoryReqType Complex Type

ReportBatchHistory returns information about previous batches over a period of time. This report is for the site referenced in the header.

All

RptStartUtcDT optional xs:dateTime

Start date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, start date time will be defaulted to six days prior at 00:00:00.

Batches must have been opened at or after this time to be returned.

RptEndUtcDT optional xs:dateTime

End date time used to filter the results to a particular date time range. The date time must be specified in UTC (Coordinated Universal Time). If the element is not present, end date time will be defaulted to tomorrow at 00:00:00.

Batches must have been opened before or at this time to be returned.

Note: The end date/time must be after the start date/time.

DeviceId optional deviceIdType Simple Type

Device identifier used to filter the report results to a particular device.

Note: If not provided, all devices associated with the site will be included.

TzConversion optional tzoneConversionType Simple Type

Indicates that a time zone conversion should be applied to dates/times in the response; see the associated Type enumerations for specific values supported.

Source

<xs:element name="ReportBatchHistory" type="PosReportBatchHistoryReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">ReportBatchHistory returns information about previous batches over a period of time. This report is for the site referenced in the header.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>