GetDeposits

This call is to retrieve cash deposits received by the Register on the business date requested.

Note: This call does not allow for a DateTime Range. Therefore, if you would like Deposits for a week, month, or range any of dates, you need to do a loop that makes the call on a per day basis.

Please use the Best Practice Guide on the frequency of your calls.

Request Parameters

BusinessDate DateTime — Specify the business date you would like to retrieve deposits 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
Deposits Array of Deposit — Array of Deposit objects for the requested business date.
Deposit Properties
- Amount decimal — Amount of this Deposit
- Bag string — Id for this Deposit, used for tracking purposes in PAR POS
- BusinessDate DateTime — Business date on which this Deposit was made (the time component will always return as 00:00:00)
- DepositTypeId int — Type of this Deposit. Note: Deposit Ids are not exposed via the API.
- Id int — Unique Id for this Deposit
- Notes string — Notes for this Deposit
- Number int — Number of the Register that accepted this Deposit. Since locations can have multiple Tills, the number is an indication of which Till received this Deposit.
- Time DateTimeOffset — Date and time when this Deposit was made in UTC

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetDeposits request with BusinessDate.

Responses

text/xml; charset=utf-8

post/GetDeposits

cURL

curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Sales2.svc?GetDeposits' \
  --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/GetDeposits"' \
  --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:GetDeposits>
        <v2:request>
          <v2:BusinessDate>2024-01-15</v2:BusinessDate>
        </v2:request>
      </v2:GetDeposits>
    </soapenv:Body>
  </soapenv:Envelope>'

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetDepositsResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
      <GetDepositsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Deposits>
          <Deposit>
            <Amount>500.00</Amount>
            <Bag>Bag1</Bag>
            <BusinessDate>2024-01-15T00:00:00</BusinessDate>
            <DepositTypeId>1</DepositTypeId>
            <Id>101</Id>
            <Notes>End of day deposit</Notes>
            <Number>1</Number>
            <Time>2024-01-15T08:00:00-06:00</Time>
          </Deposit>
        </Deposits>
      </GetDepositsResult>
    </GetDepositsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Deposit objects.