GetTills

This call is to retrieve Tills on the business date requested.

Request Parameters

BusinessDate DateTime — Specify the business date you would like to retrieve tills for.

Response Parameters

Message string — Returns a PAR POS Error message if the request did not go through. Otherwise, this field will be null.
ResultCode int — Returns one of the following:
- 0 — Success
- 1 — Unknown Error
- 2 — Invalid Request
- 3 — Server Unavailable
- 4 — Access Denied
Tills Array of Till — Tills for the business date requested.
Till Properties
- BusinessDate DateTime — Business date of this Till (This DateTime object's time component will be equal to 00:00:00)
- CashDrawerId int? — Maps to the Id of the CashDrawer if this Till is not virtual, otherwise null
- ClosedByEmployeeId int? — Maps to the Id of the Employee who closed this Till, otherwise null if auto-closed
- ClosedTime DateTimeOffset? — Time that this Till was closed, for tills that have been closed
- DeclaredCash decimal? — Amount of cash declared for this Till, for tills that have been closed
- EmployeeId int? — Maps to the Id of the Employee who owns this Till, for non-public tills, otherwise null
- IsClosed bool — True if Till has been closed, False if not
- IsPublic bool — True if Till is public, False if not. Public tills are not owned by an employee.
- IsVirtual bool — True if Till is virtual, False if not. Virtual tills are not tied to a cash drawer.
- Number int — Unique identifier for this Till
- OpenedTime DateTimeOffset — Time that this Till was opened
- OverShort decimal? — Calculated amount that this Till was over or short, for tills that have been closed
- PaidInOuts Array of PaidInOut — Paid ins and out on this Till
  PaidInOut Properties
  - AccountType int — Returns one of the following: 0 = Cash In, 1 = Cash Out
  - Amount decimal — Amount that was paid for this PaidInOut
  - Description string — Description for this PaidInOut
  - EmployeeId int — Maps to the Id of the Employee who processed this PaidInOut
  - Number int — Unique identifier for this PaidInOut
  - PettyAccountId int — Maps to the Id of the Account affected by this PaidInOut
  - Time DateTimeOffset — Time at which this PaidInOut was processed in UTC
- Skims Array of Skim — Cash Skims performed on this Till
  Skim Properties
  - CashDrawerName string — Name of the CashDrawer from which Skim is performed
  - Duration TimeSpan — Time from first prompt until Skim performed
  - SkimAmount decimal — Amount that was processed in this Skim
  - SkimTime DateTimeOffset — Time at which this Skim was processed in UTC
  - UserName string — Name of the Employee who processed this Skim
- StartingBank decimal — Starting bank that was declared for this Till when it was opened

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetTills request with BusinessDate.

Responses

text/xml; charset=utf-8

post/GetTills

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Sales2.svc?GetTills' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'AccessToken: your-access-token' \
  --header 'LocationToken: your-location-token' \
  --header 'SOAPAction: "http://www.brinksoftware.com/webservices/sales/v2/ISalesWebService2/GetTills"' \
  --data '<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/sales/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetTills>
        <v2:request>
          <v2:BusinessDate>2024-01-15</v2:BusinessDate>
        </v2:request>
      </v2:GetTills>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetTillsResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
      <GetTillsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Tills>
          <Till>
            <BusinessDate>2024-01-15T00:00:00</BusinessDate>
            <CashDrawerId>1</CashDrawerId>
            <ClosedByEmployeeId>42</ClosedByEmployeeId>
            <ClosedTime>2024-01-15T22:00:00Z</ClosedTime>
            <DeclaredCash>350.00</DeclaredCash>
            <EmployeeId>42</EmployeeId>
            <IsClosed>true</IsClosed>
            <IsPublic>false</IsPublic>
            <IsVirtual>false</IsVirtual>
            <Number>1</Number>
            <OpenedTime>2024-01-15T07:00:00Z</OpenedTime>
            <OverShort>-5.25</OverShort>
            <PaidInOuts>
              <PaidInOut>
                <AccountType>1</AccountType>
                <Amount>50.00</Amount>
                <Description>Bank Deposit</Description>
                <EmployeeId>42</EmployeeId>
                <Number>1</Number>
                <PettyAccountId>1</PettyAccountId>
                <Time>2024-01-15T14:00:00Z</Time>
              </PaidInOut>
            </PaidInOuts>
            <Skims>
              <Skim>
                <CashDrawerName>Main Drawer</CashDrawerName>
                <Duration>PT1M30S</Duration>
                <SkimAmount>200.00</SkimAmount>
                <SkimTime>2024-01-15T18:00:00Z</SkimTime>
                <UserName>John Smith</UserName>
              </Skim>
            </Skims>
            <StartingBank>100.00</StartingBank>
          </Till>
        </Tills>
      </GetTillsResult>
    </GetTillsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Till objects for the specified business date.