GetCashDrawers

This call is to retrieve an array of CashDrawer objects for the location.

Authentication note: Unlike most Brink services, Settings.svc passes accessToken and locationToken inside the SOAP body - do not send them as HTTP headers.

Request Parameters

accessToken string — Your access token (passed in SOAP body, not headers).
locationToken string — Your location token (passed in SOAP body, not headers).

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
- 3 — Server Unavailable
- 4 — Access Denied
CashDrawers Array of CashDrawer — Array of CashDrawer objects for this location.
CashDrawer Properties
- CashInDrawerLimit double — Amount in cash drawer above which register warning is triggered
- CashLimitWarningEnabled bool — True if register warning triggers when cash limit is reached, False if not
- DefaultBank decimal — Default amount of cash for this CashDrawer
- DrawerNumber byte — Number of this CashDrawer
- Id int — Unique Id of this CashDrawer
- IsCompulsory bool — True if CashDrawer is compulsory, False if not
- IsPublic bool — True if CashDrawer is public, False if not
- Name string — Name of this CashDrawer
- TerminalId int — Id of the Terminal this CashDrawer is associated with
- TransactionFrequency int — Number of transactions against this cash drawer after which the register warning is re-triggered
- Type int — Returns one of the following:
  - 0 = None
  - 1 = Printerinterface
  - 2 = OPOS
  - 3 = Serial
  - 4 = PosForDotNet

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetCashDrawers request with accessToken and locationToken in body.

Responses

text/xml; charset=utf-8

post/GetCashDrawers

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetCashDrawers' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetCashDrawers"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetCashDrawers>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetCashDrawers>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetCashDrawersResponse xmlns="http://tempuri.org/">
      <Settings_GetCashDrawersResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <CashDrawers>
          <CashDrawer>
            <CashInDrawerLimit>500.00</CashInDrawerLimit>
            <CashLimitWarningEnabled>true</CashLimitWarningEnabled>
            <DefaultBank>100.00</DefaultBank>
            <DrawerNumber>1</DrawerNumber>
            <Id>5</Id>
            <IsCompulsory>false</IsCompulsory>
            <IsPublic>true</IsPublic>
            <Name>Main Drawer</Name>
            <TerminalId>3</TerminalId>
            <TransactionFrequency>0</TransactionFrequency>
            <Type>0</Type>
          </CashDrawer>
        </CashDrawers>
      </Settings_GetCashDrawersResult>
    </Settings_GetCashDrawersResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of CashDrawer objects.