POST api/GetReport

Get the Report in a DateTime Range.

Request Information

URI Parameters

None.

Body Parameters

GetReport
NameDescriptionTypeAdditional information
RequestType

string

None.

TerminalNumber

string

None.

ClerkNumber

string

None.

FromDate

date

None.

ToDate

date

None.

APIKey

string

None.

Request Formats

application/xml, text/xml

Sample:
<GetReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <APIKey>sample string 7</APIKey>
  <RequestType>sample string 1</RequestType>
  <TerminalNumber>sample string 2</TerminalNumber>
  <ClerkNumber>sample string 3</ClerkNumber>
  <FromDate>2019-12-09T19:30:06.6122874-07:00</FromDate>
  <ToDate>2019-12-09T19:30:06.6122874-07:00</ToDate>
  <ExtraMessage>sample string 6</ExtraMessage>
</GetReport>

Response Information

Resource Description

GetReportResponse
NameDescriptionTypeAdditional information
FromDate

date

None.

ToDate

date

None.

MasterCard

Collection of Transactions

None.

Visa

Collection of Transactions

None.

Amex

Collection of Transactions

None.

Discover

Collection of Transactions

None.

Debt

Collection of Transactions

None.

Card

Collection of Transactions

None.

Cash

Collection of Transactions

None.

Clerk

Collection of Transactions

None.

CardCount

string

None.

CashCount

string

None.

ClerkCount

string

None.

MasterCardTotalAmount

string

None.

VisaTotalAmount

string

None.

AmexTotalAmount

string

None.

DiscoverTotalAmount

string

None.

DebtTotalAmount

string

None.

UnknownCardTotalAmount

string

None.

CardTotalAmount

string

None.

CashTotalAmount

string

None.

ClerkTotalAmount

string

None.

BaseAmount

string

None.

TotalTaxAmount

string

None.

TotalAmount

string

None.

TotalTipAmount

string

None.

Code

Request Status Code.

string

None.

Message

Basic Information of the Request Status

string

None.

ExtraMessage

Detailed Information of the Request Status

string

None.

Response Formats

application/xml, text/xml

Sample:
<GetReportResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Code>sample string 19</Code>
  <Message>sample string 20</Message>
  <ExtraMessage>sample string 21</ExtraMessage>
  <FromDate>2019-12-09T19:30:06.6122874-07:00</FromDate>
  <ToDate>2019-12-09T19:30:06.6122874-07:00</ToDate>
  <MasterCard>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </MasterCard>
  <Visa>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Visa>
  <Amex>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Amex>
  <Discover>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Discover>
  <Debt>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Debt>
  <Card>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Card>
  <Cash>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Cash>
  <Clerk>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
    <Transactions>
      <Type>sample string 1</Type>
      <PNRef>2</PNRef>
      <Amount>sample string 3</Amount>
      <Card>sample string 4</Card>
      <Tip>sample string 5</Tip>
    </Transactions>
  </Clerk>
  <CardCount>sample string 3</CardCount>
  <CashCount>sample string 4</CashCount>
  <ClerkCount>sample string 5</ClerkCount>
  <MasterCardTotalAmount>sample string 6</MasterCardTotalAmount>
  <VisaTotalAmount>sample string 7</VisaTotalAmount>
  <AmexTotalAmount>sample string 8</AmexTotalAmount>
  <DiscoverTotalAmount>sample string 9</DiscoverTotalAmount>
  <DebtTotalAmount>sample string 10</DebtTotalAmount>
  <UnknownCardTotalAmount>sample string 11</UnknownCardTotalAmount>
  <CardTotalAmount>sample string 12</CardTotalAmount>
  <CashTotalAmount>sample string 13</CashTotalAmount>
  <ClerkTotalAmount>sample string 14</ClerkTotalAmount>
  <BaseAmount>sample string 15</BaseAmount>
  <TotalTaxAmount>sample string 16</TotalTaxAmount>
  <TotalAmount>sample string 17</TotalAmount>
  <TotalTipAmount>sample string 18</TotalTipAmount>
</GetReportResponse>