AIM Web Services

<back to all web services

GetTaxAuthoritiesRequest

GetTaxAuthorities
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/GetTaxAuthorities
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* GetTaxAuthoritiesRequires active-e Customer Service.
*/
@DataContract
open class GetTaxAuthoritiesRequest : BaseSecureRequest()
{
    /**
    * Tax Authority lookup. If sent, all other parameters will be ignored.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="Tax Authority lookup. If sent, all other parameters will be ignored.", Format="int64", Name="TaxAuthorityId", ParameterType="query")
    var TaxAuthorityId:Long? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class GetTaxAuthoritiesResponse : BaseResponse()
{
    @DataMember
    var TaxAuthorities:ArrayList<TaxAuthoritityInfo> = ArrayList<TaxAuthoritityInfo>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class TaxAuthoritityInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var Desc:String? = null

    @DataMember
    var ShortDesc:String? = null

    @DataMember
    var City:String? = null

    @DataMember
    var County:String? = null

    @DataMember
    var ZipCode:String? = null

    @DataMember
    var GeoCode:String? = null

    @DataMember
    var TaxRate1:BigDecimal? = null

    @DataMember
    var TaxRate2:BigDecimal? = null
}

Kotlin GetTaxAuthoritiesRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/GetTaxAuthorities HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetTaxAuthoritiesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <TaxAuthorities>
    <GetTaxAuthoritiesResponse.TaxAuthoritityInfo>
      <City>String</City>
      <County>String</County>
      <Desc>String</Desc>
      <GeoCode>String</GeoCode>
      <Id>0</Id>
      <ShortDesc>String</ShortDesc>
      <TaxRate1>0</TaxRate1>
      <TaxRate2>0</TaxRate2>
      <ZipCode>String</ZipCode>
    </GetTaxAuthoritiesResponse.TaxAuthoritityInfo>
  </TaxAuthorities>
</GetTaxAuthoritiesResponse>