SOAP API - GetUserAttributeTaxExemptLevels

GetUserAttributeTaxExemptLevels( userName ) : UserAttributeTaxExemptLevel[]

Since: EngageIP v25.2

Accepts a username and returns every tax exempt level and type combination on the user. If the username does not exist, an exception is thrown.

The returned value from this method call is an array of UserAttributeTaxExemptLevel objects. A User Attribute Tax Exempt Level object consists of the following properties:

ID (Integer) - The unique ID of the user attribute tax exempt level
UserID(Integer) - The ID of the user which has the tax exemption
TaxExemptLevel(Integer) - References the ID level of tax for the exemption. For example, Federal, State, County etc..
TaxExemptType(Integer) - References the ID that defines the specific tax exempt type, if null all taxes at this level will be exempt.

Parameters:

userName (String) - The username for which to retrieve the list of tax exemptions. An exception will be thrown if the username does not exist.

Returns:

An array of UserAttributeTaxExemptLevel objects for the specified user

Possible Exceptions:

INVALID USERNAME

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: localhost
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>
    <GetUserAttributeTaxExemptLevels xmlns="Logisense_EngageIP">
      <userName>string</userName>
    </GetUserAttributeTaxExemptLevels>
  </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>
    <GetUserAttributeTaxExemptLevelsResponse xmlns="Logisense_EngageIP">
      <GetUserAttributeTaxExemptLevelsResult>
        <UserAttributeTaxExemptLevel>
          <Validate />
          <ID>int</ID>
          <UserID>int</UserID>
          <TaxExemptLevelID>int</TaxExemptLevelID>
          <TaxExemptTypeID>int</TaxExemptTypeID>
        </UserAttributeTaxExemptLevel>
        <UserAttributeTaxExemptLevel>
          <Validate />
          <ID>int</ID>
          <UserID>int</UserID>
          <TaxExemptLevelID>int</TaxExemptLevelID>
          <TaxExemptTypeID>int</TaxExemptTypeID>
        </UserAttributeTaxExemptLevel>
      </GetUserAttributeTaxExemptLevelsResult>
    </GetUserAttributeTaxExemptLevelsResponse>
  </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: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserAttributeTaxExemptLevels"

<?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>
    <GetUserAttributeTaxExemptLevels xmlns="Logisense_EngageIP">
      <userName>string</userName>
    </GetUserAttributeTaxExemptLevels>
  </soap:Body>
</soap:Envelope>