GetTaxes

This call is to retrieve an array of Tax objects for the location.

Response Parameters

Taxes Type:

  • Amount decimal — Amount of this tax

  • AppliesTo IdList — Items in the Selected Items list will have this tax applied to them.

  • CompoundTax boolTrue when tax is considered to be compounded, False if not

  • CompoundTaxPriority int — The order in which compound taxes are applied. The lowest priority is applied first.

  • Destinations Array of TaxDestination — Destinations to which the tax must be applied

    TaxDestination Properties
    • Id int — Unique Id of this TaxDestination
    • DestinationId int — Maps to the Id of the Destination the tax must be applied to
  • DisplayName string — An alternative name that prints on the receipt.

  • ExemptionEnabled boolTrue if the tax is to be excluded based on an Order Total amount, False if not

  • ExemptionItemGroupId int — Mention the items for which tax is to be exempted up to a certain order amount.

  • ExemptionOrderAmount decimal — Order Amount below which the tax is exempted.

  • Id int — Unique ID of this tax

  • IsInclusive boolTrue if tax is included in price of item, False if not

  • LimitDestinations boolTrue if tax is to be applied for a specific destination, False if not

  • MinimumAmount decimal — Mimimum amount to be applied per qualifying order

  • ModifierItems IdList — Modifiers in the list will result in the tax being applied to the root item

  • Name string — Name of this tax

  • OrderTotalType OrderTotalType — One of the following:

    • Order Total
    • Order Subtotal
    • None
  • NonRepeatingTaxBrackets Array of TaxBracket — For rows where the intervals are not repeated, such as for the first dollar, where the taxation rate often includes a point below which no tax is charged

    TaxBracket Properties
    • From decimal — The lowest order total for which the Tax Amount is charged
    • Id int — Unique Id against the tax entity
    • TaxAmount decimal — The amount of tax charged for this bracket
    • To decimal — The highest order total for which the Tax Amount is charged
  • RepeatingTaxBrackets Array of TaxBracket — For establishing a pattern of tax brackets. When you enter a number of rows in the Repeating sub-tab to establish the pattern, the system extrapolates based on the established pattern for values above what is entered

    TaxBracket Properties
    • From decimal — The lowest order total for which the Tax Amount is charged
    • Id int — Unique Id against the tax entity
    • TaxAmount decimal — The amount of tax charged for this bracket
    • To decimal — The highest order total for which the Tax Amount is charged
  • RoundingMethod RoundingMethod — Select how taxes will be rounded when a calculation results in fractional cents.:

    • Up: Rounds up to the next higher cent.
    • Down: Rounds down to the next lower cent.
    • Nearest: Rounds to the nearest cent.
    • Bracket: Selecting Bracket displays two lists: Non-Repeating and Repeating
  • Type TaxType — One of the following:

    • Percentage
    • FlatFee
    • None
  • UseLocationRules boolTrue if PAR POS uses embedded, location-specific tax tables, False if not

TaxBracket Type:

  • From decimal — The lowest order total for which the Tax Amount is charged.
  • TaxAmount decimal — The amount of tax charge
  • To decimal — The highest order total for which the Tax Amount is charged
  • Id int — Unique Id against the tax entity

TaxDestination Type:

  • DestinationId int — Unique ID of the destination to which the tax is being applied
  • Id int — Unique mapping ID
Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

SOAP envelope for GetTaxes request. No parameters required.

Responses
  • text/xml; charset=utf-8
Request Example for post/GetTaxes
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?GetTaxes' \
  --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/settings/v2/ISettingsWebService2/GetTaxes"' \
  --data '<soapenv:Envelope
    xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
    xmlns:v2="http://www.brinksoftware.com/webservices/settings/v2">
    <soapenv:Header/>
    <soapenv:Body>
      <v2:GetTaxes/>
    </soapenv:Body>
  </soapenv:Envelope>'
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <Settings2_GetTaxesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <Settings2_GetTaxesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <Taxes>
          <Tax>
            <Type>0</Type>
            <Amount>8.25</Amount>
            <MinimumAmount>0</MinimumAmount>
            <DisplayName>Sales Tax</DisplayName>
            <IsInclusive>false</IsInclusive>
            <UseLocationRules>false</UseLocationRules>
            <CompoundTax>false</CompoundTax>
            <CompoundTaxPriority>0</CompoundTaxPriority>
            <ExemptionEnabled>false</ExemptionEnabled>
            <RoundingMethod>0</RoundingMethod>
            <OrderTotalType>0</OrderTotalType>
            <ExemptionOrderAmount>0</ExemptionOrderAmount>
            <ExemptionItemGroupId>0</ExemptionItemGroupId>
            <LimitDestinations>false</LimitDestinations>
            <Destinations/>
            <ModifierItems/>
            <NonRepeatingTaxBrackets/>
            <RepeatingTaxBrackets/>
            <AppliesTo/>
            <Id>1</Id>
            <Name>Sales Tax</Name>
          </Tax>
        </Taxes>
      </Settings2_GetTaxesResult>
    </Settings2_GetTaxesResponse>
  </s:Body>
</s:Envelope>