PosReportBatchDetailReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosReportBatchDetailReqType

All

BatchId optional batchIdType Simple Type

Batch identifier used to filter the report results to a particular batch.

Note: If this is not provided, results will be returned for the current open batch.

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.

SiteId optional siteIdType Simple Type

The Site identifier to query.

Note: The Site must belong to the same License as the requesting Site and Device. The Device identifier must also be specified. The Merchant must be enabled for this functionality.

DeviceId optional deviceIdType Simple Type

The Device identifier to query.

Note: The Device must belong to the Site in the request header or request body if used. The Merchant must be enabled for this functionality.

Used By

ReportBatchDetail Element

Source

<xs:complexType name="PosReportBatchDetailReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:all>
    <xs:element name="BatchId" type="batchIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Batch identifier used to filter the report results to a particular batch.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> If this is not provided, results will be returned for the current open batch.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="TzConversion" type="tzoneConversionType" default="UTC" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Indicates that a time zone conversion should be applied to dates/times in the response; see the associated Type enumerations for specific values supported.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="SiteId" type="siteIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The Site identifier to query.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The Site must belong to the same License as the requesting Site and Device. The Device identifier must also be specified. The Merchant must be enabled for this functionality.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="DeviceId" type="deviceIdType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">The Device identifier to query.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The Device must belong to the Site in the request header or request body if used. The Merchant must be enabled for this functionality.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
  </xs:all>
</xs:complexType>