GetCurrentBusinessDate

This call is to submit orders to PAR POS. It is an important call to API integrators who submit orders via the Ordering.svc.

The response tells you what the Business Date is on the Register. The server may say something different because the Register could be ahead or behind. In the event that the server and Register business dates are different, these sync issues reported to Main Support.

Note: This call should only be made once a day, or at most once every three hours per location. The Register is unlikely to change the Business Date unless End of Day is run.

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 — Request was not valid
- 3 — Server Unavailable
- 4 — Access Denied
BusinessDate DateTime — Current Business Date shown on the register in a YYYY-MM-DD format (the time component will always return as 00:00:00). Note: this reflects what is stored in the Register.sdf.

Headers

SOAPAction
Type: string
required

Body

required

application/json

SOAP envelope containing the GetCurrentBusinessDate request.

Responses

text/xml; charset=utf-8

post/GetCurrentBusinessDate

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <GetCurrentBusinessDateResponse xmlns="http://www.brinksoftware.com/webservices/sales/v2">
      <GetCurrentBusinessDateResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <BusinessDate>2024-01-15</BusinessDate>
      </GetCurrentBusinessDateResult>
    </GetCurrentBusinessDateResponse>
  </s:Body>
</s:Envelope>

SOAP response containing the current BusinessDate string.