SOAP API - AddUserAttributeTaxExemptLevels

AddUserAttributeTaxExemptLevels( username, taxExemptLevelName, taxExemptTypeName ) : Integer

Since: EngageIP v25.2

Adds UserAttributeTaxExemptLevels data. Tax exemption levels can be used to exempt a user from paying taxes to specific levels of government.

This can be combined with tax types to exempt only specific taxes at a given level. If you want to exempt County, State and Local, which may tax individually, you need to add each individually rather than just selecting ‘State_County_Local’. The ‘State_County_Local’ is only for tax line items that are an aggregate tax for these 3 definitions.

Note: An exemption at the parent level will apply to all sub account levels as well so there is no need to duplicate exemptions on child / sub accounts.

If the username or the tax exempt level and type combination do not exist, this function will throw an exception. Also, an exception will be thrown if the tax exempt level and type combination already exist for the specified user.

Returns:

The new user attribute tax exempt level ID

Parameters:

username (String) - The username of the user in which to add the tax exempt level. An exception will be thrown if the username does not exist.
taxExemptLevelName (String) - Defines the level of tax for the exemption. For example, Federal, State, County etc..
taxExemptTypeName (String) - Optionally define the specific tax exempt type, otherwise all taxes at this level will be exempt.

Possible Exceptions:

INVALID USERNAME
INVALID EXEMPT VALUES

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <AddUserAttributeTaxExemptLevels xmlns="Logisense_EngageIP">
      <userName>string</userName>
      <taxExemptLevelName>string</taxExemptLevelName>
      <taxExemptTypeName>string</taxExemptTypeName>
    </AddUserAttributeTaxExemptLevels>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <AddUserAttributeTaxExemptLevelsResponse xmlns="Logisense_EngageIP">
      <AddUserAttributeTaxExemptLevelsResult>int</AddUserAttributeTaxExemptLevelsResult>
    </AddUserAttributeTaxExemptLevelsResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /adminportal/webservice.asmx HTTP/1.1
Host: demo.logisense.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/AddUserAttributeTaxExemptLevels"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <AddUserAttributeTaxExemptLevels xmlns="Logisense_EngageIP">
      <userName>string</userName>
      <taxExemptLevelName>string</taxExemptLevelName>
      <taxExemptTypeName>string</taxExemptTypeName>
    </AddUserAttributeTaxExemptLevels>
  </soap:Body>
</soap:Envelope>