GetSurcharges

This call is to retrieve an array of Surcharge objects at the location.

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
Surcharges Array of Surcharge — Array of Surcharge objects for this location.
Surcharge Properties
- Amount decimal — Amount of this Surcharge
- AutomaticallyApply bool — True if this Surcharge is automatically applied, False if not
- Days int — Binary flag indicating days this Surcharge applies (add values: 1=Sunday, 2=Monday, 4=Tuesday, 8=Wednesday, 16=Thursday, 32=Friday, 64=Saturday; 127=all days)
- EndDate DateTime — Applies if EnforceDateRanges is True: end date for when this Surcharge is enforced
- EndTime DateTime — Applies if EnforceTimeRanges is True: end time for when this Surcharge is enforced
- EnforceDateRanges bool — True if this Surcharge is enforced within a specified date range, False if not
- EnforceDays bool — True if this Surcharge is enforced on specific days, False if not
- EnforcePartySize bool — True if this Surcharge is enforced within a specified party size range, False if not
- EnforceTimeRanges bool — True if this Surcharge is enforced within a specified time range, False if not
- Id int — Unique Id of this Surcharge
- LimitDestinations bool — True if this Surcharge is limited to ValidDestinationIds, False if not
- LimitSections bool — True if this Surcharge is limited to ValidSectionIds, False if not
- MaximumPartySize int — Applies if EnforcePartySize is True: maximum party size for which this Surcharge is enforced, 0 if null
- Method int — Returns one of the following:
  - 0 = Fixed Per Order
  - 1 = Percentage Per Order
  - 2 = Fixed Per Item
  - 3 = Percentage Per Item
- MinimumPartySize int — Applies if EnforcePartySize is True: minimum party size for which this Surcharge is enforced, 0 if null
- Name string — Name of this Surcharge
- Prompt bool — True if this Surcharge is prompted on the register, False if not
- StartDate DateTime — Applies if EnforceDateRanges is True: start date for when this Surcharge is enforced
- StartTime DateTime — Applies if EnforceTimeRanges is True: start time for when this Surcharge is enforced
- TaxIds IdList — Maps to the Id(s) of the Tax(es) associated with this Surcharge
- TerminalTypes int — Binary flag indicating terminal types this Surcharge applies to (add values: 0=None, 1=Register, 2=Web Ordering, 8=Web Mobile Ordering, 16=Web-Service, 32=Mobile App)
- Type int — Returns one of the following:
  - 0 = ServiceCharge
  - 1 = Gratuity
  - 2 = NonCashAdjustment
- ValidDestinationIds IdList — Applies if LimitDestinations is True: Ids of the Destination(s) this Surcharge is limited to
- ValidSectionIds IdList — Applies if LimitSections is True: Ids of the Section(s) this Surcharge is limited to

Headers

SOAPAction
Type: string
required

Body

required

application/json

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

Responses

text/xml; charset=utf-8

post/GetSurcharges

cURL

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

Show Schema

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetSurchargesResponse xmlns="http://tempuri.org/">
      <Settings_GetSurchargesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Surcharges>
          <Surcharge>
            <Amount>1.50</Amount>
            <AutomaticallyApply>true</AutomaticallyApply>
            <Days>127</Days>
            <EndDate/>
            <EndTime>PT23H59M59S</EndTime>
            <EnforceDateRanges>false</EnforceDateRanges>
            <EnforceDays>false</EnforceDays>
            <EnforcePartySize>false</EnforcePartySize>
            <EnforceTimeRanges>false</EnforceTimeRanges>
            <Id>4</Id>
            <LimitDestinations>false</LimitDestinations>
            <LimitSections>false</LimitSections>
            <MaximumPartySize>0</MaximumPartySize>
            <Method>0</Method>
            <MinimumPartySize>0</MinimumPartySize>
            <Name>Outdoor Seating Fee</Name>
            <Prompt>false</Prompt>
            <StartDate/>
            <StartTime>PT0S</StartTime>
            <TaxIds>
              <Id>1</Id>
            </TaxIds>
            <TerminalTypes>0</TerminalTypes>
            <Type>0</Type>
            <ValidDestinationIds/>
            <ValidSectionIds/>
          </Surcharge>
        </Surcharges>
      </Settings_GetSurchargesResult>
    </Settings_GetSurchargesResponse>
  </s:Body>
</s:Envelope>

SOAP response containing an array of Surcharge objects.