ReportBatchSummary Element

Description

ReportBatchSummary returns a batch's status information and totals broken down by payment type. This report is for the site and device referenced in the header.

Namespace

http://Hps.Exchange.PosGateway

Type

PosReportBatchSummaryReqType Complex Type

Diagram

Overview

ReportBatchSummary PosReportBatchSummaryReqType Complex Type

ReportBatchSummary returns a batch's status information and totals broken down by payment type. This report is for the site and device referenced in the header.

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.

Source

<xs:element name="ReportBatchSummary" type="PosReportBatchSummaryReqType" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:annotation>
    <xs:documentation>
      <p xmlns="http://Hps.Exchange.PosGateway">ReportBatchSummary returns a batch's status information and totals broken down by payment type. This report is for the site and device referenced in the header.</p>
    </xs:documentation>
  </xs:annotation>
</xs:element>