PosReportBatchSummaryReqType Complex Type

Namespace

http://Hps.Exchange.PosGateway

Diagram

Overview

PosReportBatchSummaryReqType

All

BatchId optional batchIdType Simple Type

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

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

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, dates are not used.

Transactions must have been run 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, dates are not used.

Transactions must have been run before or at this time to be returned.

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

BatchSeqNbr optional batchSeqNbrType Simple Type

Batch sequence number used to filter the report results

Note: If batch id is provided, this field is ignored.

ClerkID optional Restriction of xs:string

Clerk id used to filter the report results

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

ReportBatchSummary Element

Source

<xs:complexType name="PosReportBatchSummaryReqType" 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 specific 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="RptStartUtcDT" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">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, dates are not used.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Transactions must have been run at or after this time to be returned.</p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="RptEndUtcDT" type="xs:dateTime" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">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, dates are not used.</p>
          <p xmlns="http://Hps.Exchange.PosGateway">Transactions must have been run before or at this time to be returned.</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> The end date/time must be after the start date/time.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="BatchSeqNbr" type="batchSeqNbrType" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Batch sequence number used to filter the report results</p>
          <p xmlns="http://Hps.Exchange.PosGateway" />
          <p xmlns="http://Hps.Exchange.PosGateway">
            <strong>Note:</strong> If batch id is provided, this field is ignored.
            </p>
        </xs:documentation>
      </xs:annotation>
    </xs:element>
    <xs:element name="ClerkID" minOccurs="0">
      <xs:annotation>
        <xs:documentation>
          <p xmlns="http://Hps.Exchange.PosGateway">Clerk id used to filter the report results</p>
        </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:string">
          <xs:maxLength value="50" />
        </xs:restriction>
      </xs:simpleType>
    </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>