GetTaxes

Retrieve the Taxes at this 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
  • Taxes Array of Tax — Array of Tax objects for this location.

    Tax Properties
    • Amount decimal — Amount or rate of this Tax
    • Id int — Unique Id of this Tax
    • Name string — Name of this Tax
    • Type int — Returns one of the following:
      • 0 = None
      • 1 = Percentage
      • 2 = FlatFee
Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

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

Responses
  • text/xml; charset=utf-8
Request Example for post/GetTaxes
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings.svc?Settings_GetTaxes' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --header 'SOAPAction: "http://tempuri.org/ISettingsWebService/GetTaxes"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:tem="http://tempuri.org/">
    <soapenv:Header/>
    <soapenv:Body>
      <tem:GetTaxes>
        <tem:accessToken>AccessToken</tem:accessToken>
        <tem:locationToken>LocationToken</tem:locationToken>
      </tem:GetTaxes>
    </soapenv:Body>
  </soapenv:Envelope>'
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings_GetTaxesResponse xmlns="http://tempuri.org/">
      <Settings_GetTaxesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Taxes>
          <Tax>
            <Amount>0.0825</Amount>
            <Id>1</Id>
            <Name>State Tax</Name>
            <Type>0</Type>
          </Tax>
        </Taxes>
      </Settings_GetTaxesResult>
    </Settings_GetTaxesResponse>
  </s:Body>
</s:Envelope>