GetFutureDateOrderDeposits

This call returns any Deposits made for Future Date Orders received by the Register on the business date requested.

Future Date Orders are defined as orders that are made one or more days in advance.

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 how many times per minute you should make this call!

Request Parameters

BusinessDate DateTime — Specify at what Date would you like to see the 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 FutureDateOrderDeposit — Array of FutureDateOrderDeposit objects for the requested business date.
FutureDateOrderDeposit Properties
- Amount decimal — Amount of this FutureDateOrderDeposit
- AuthCode string — Authorization Code sent back from the payment processor used for credit card payments
- BusinessDate DateTime — Business date on which this FutureDateOrderDeposit was made (the time component will always return as 00:00:00). Note: This corresponds with the date of the request and when the payment was processed, not when the Order was made.
- CardHolderName string — Name of the cardholder of this FutureDateOrderDeposit, for card payments
- CardNumber string — Account number of the credit card for this FutureDateOrderDeposit, for card payments. Note: Most Payment Processors only return the last four digits, and the rest is hashed out.
- EmployeeId int? — Maps to the Id of the Employee who applied this FutureDateOrderDeposit. Note: If there was no Employee who applied the Deposit (e.g. the Register or Till auto-deposited), then this value will be null.
- MerchantAccountType int? — Returns one of the following if this FutureDateOrderDeposit was a credit card payment: 0 = Payment was processed at the location, 1 = E-Commerce Payment that was made and processed online. Otherwise, this value will be null.
- OrderId long — Maps to the Id of the future date Order of this FutureDateOrderDeposit. Note: Storing it in your own database would be beneficial.
- OrderTotal decimal — Total value of the future date Order that the FutureDateOrderDeposit was made for, including any discounts, promotions, surcharges, and/or taxes
- PaymentId int — Unique Id of the payment for this FutureDateOrderDeposit
- SectionId int? — Maps to the Id of the Section of this FutureDateOrderDeposit, null if not specified
- TenderId int — Maps to the Id of the Tender used to pay this FutureDateOrderDeposit. Note: Future date orders or online orders cannot have Cash as a payment tender.
- TillNumber int? — Number of the Register that accepted this Deposit. Note: If the Order was made online, via the API, then this value will be null.
- Time DateTimeOffset — Date and time of when this FutureDateOrderDeposit was made in UTC
- TipAmount decimal — Tip amount for this FutureDateOrderDeposit

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetFutureDateOrderDeposits request with BusinessDate.

Responses

text/xml; charset=utf-8

post/GetFutureDateOrderDeposits

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetFutureDateOrderDepositsResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
      <GetFutureDateOrderDepositsResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Deposits>
          <FutureDateOrderDeposit>
            <Amount>50.00</Amount>
            <AuthCode>AUTH123</AuthCode>
            <BusinessDate>2024-01-20T00:00:00</BusinessDate>
            <CardHolderName>John Smith</CardHolderName>
            <CardNumber>************1234</CardNumber>
            <EmployeeId>123</EmployeeId>
            <MerchantAccountType>Credit</MerchantAccountType>
            <OrderId>99001</OrderId>
            <OrderTotal>75.00</OrderTotal>
            <PaymentId>1</PaymentId>
            <SectionId>1</SectionId>
            <TenderId>3</TenderId>
            <TillNumber>1</TillNumber>
            <Time>2024-01-15T14:30:00-06:00</Time>
            <TipAmount>5.00</TipAmount>
          </FutureDateOrderDeposit>
        </Deposits>
      </GetFutureDateOrderDepositsResult>
    </GetFutureDateOrderDepositsResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of FutureDateOrderDeposit objects.