SaveTaxes

Create new taxes or update the existing taxes details at a location. Please do not keep batch size of more than 100.

Request Parameters
  • BusinessDate DateTime? — The BusinessDate from when the change should apply. Default is the current BusinessDate of the location.

  • IsImmediatePublish bool — Whether or not the change should be applied immediately (will restart all registers at the location).

  • ChangesetName string — Optionally provide a custom "changeset" name. If the value is not passed, a default "changeset" name is created.

  • Taxes Array of Tax — Specify one or more Tax objects you would like to create.

    Tax Properties
    • 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
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
  • SaveResults Array of SaveTaxesResult — Contains details on whether or not the request has succeeded.

    SaveTaxesResult Properties
    • Id int — The new generated Id of a specific entity in the SaveTaxes request
    • OriginalId int — The original Id of a specific entity passed into the SaveTaxes request
    • ValidationMessages List<string> — Details if the request was unsuccessful
Headers
  • SOAPAction
    Type: string
    required
Body
required
application/json

SOAP envelope for SaveTaxes request containing tax details.

Responses
  • text/xml; charset=utf-8
Request Example for post/SaveTaxes
cURL
curl --request POST \
  --url 'https://{server_name_goes_here}.parpos.com/Settings2.svc?SaveTaxes' \
  --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/SaveTaxes"' \
  --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:SaveTaxes>
        <v2:request>
          <v2:Taxes>
            <v2:Tax>
              <v2:Id>-1</v2:Id>
              <v2:Name>State Tax</v2:Name>
              <v2:Amount>0.0825</v2:Amount>
              <v2:Type>Percentage</v2:Type>
            </v2:Tax>
          </v2:Taxes>
        </v2:request>
      </v2:SaveTaxes>
    </soapenv:Body>
  </soapenv:Envelope>'
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body>
    <SaveTaxesResponse xmlns="http://www.brinksoftware.com/webservices/settings/v2">
      <SaveTaxesResult>
        <Message>Success</Message>
        <ResultCode>0</ResultCode>
        <SaveResults>
          <SaveTaxesResult>
            <Id>12345</Id>
            <OriginalId>-1</OriginalId>
            <ValidationMessages/>
          </SaveTaxesResult>
        </SaveResults>
      </SaveTaxesResult>
    </SaveTaxesResponse>
  </s:Body>
</s:Envelope>