GET check/active/{siteId}/{terminalId}

Request Information

URI Parameters

Name	Description	Type	Additional information
siteId		integer	Required
terminalId		integer	Required

Body Parameters

None.

Response Information

Resource Description

ActiveCheckDetails

Name	Type	Additional information
SiteId	integer	None.
TerminalId	integer	None.
CheckId	integer	None.
RawCheckId	integer	None.
Subtotal	decimal number	None.
Tax	decimal number	None.
Balance	decimal number	None.
Items	Collection of ICheckEntry	None.

Response Formats

application/json, text/json

Sample:

{
  "SiteId": 1,
  "TerminalId": 2,
  "CheckId": 3,
  "RawCheckId": 4,
  "Subtotal": 5.0,
  "Tax": 6.0,
  "Balance": 7.0,
  "Items": [
    {
      "DisplayName": "sample string 1",
      "EntryType": 2,
      "ItemId": 3,
      "Level": 4,
      "LongDisplayName": "sample string 5",
      "MenuItemId": 6,
      "ModifierCode": 7,
      "ModifierGroupId": 8,
      "Price": 9.1,
      "Seat": 10,
      "Units": 11.1
    },
    {
      "DisplayName": "sample string 1",
      "EntryType": 2,
      "ItemId": 3,
      "Level": 4,
      "LongDisplayName": "sample string 5",
      "MenuItemId": 6,
      "ModifierCode": 7,
      "ModifierGroupId": 8,
      "Price": 9.1,
      "Seat": 10,
      "Units": 11.1
    }
  ]
}

application/xml, text/xml

Sample:

<ActiveCheckDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pay.Platform.Site.Core.Contracts.Responses">
  <Balance>7</Balance>
  <CheckId>3</CheckId>
  <Items>
    <Item>
      <DisplayName>sample string 1</DisplayName>
      <EntryType>2</EntryType>
      <ItemId>3</ItemId>
      <Level>4</Level>
      <LongDisplayName>sample string 5</LongDisplayName>
      <MenuItemId>6</MenuItemId>
      <ModifierCode>7</ModifierCode>
      <ModifierGroupId>8</ModifierGroupId>
      <Price>9.1</Price>
      <Seat>10</Seat>
      <Units>11.1</Units>
    </Item>
    <Item>
      <DisplayName>sample string 1</DisplayName>
      <EntryType>2</EntryType>
      <ItemId>3</ItemId>
      <Level>4</Level>
      <LongDisplayName>sample string 5</LongDisplayName>
      <MenuItemId>6</MenuItemId>
      <ModifierCode>7</ModifierCode>
      <ModifierGroupId>8</ModifierGroupId>
      <Price>9.1</Price>
      <Seat>10</Seat>
      <Units>11.1</Units>
    </Item>
  </Items>
  <RawCheckId>4</RawCheckId>
  <SiteId>1</SiteId>
  <Subtotal>5</Subtotal>
  <Tax>6</Tax>
  <TerminalId>2</TerminalId>
</ActiveCheckDetails>