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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class TaxAuthoritityInfo {
    /** @param {{Id?:number,Desc?:string,ShortDesc?:string,City?:string,County?:string,ZipCode?:string,GeoCode?:string,TaxRate1?:number,TaxRate2?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Desc;
    /** @type {string} */
    ShortDesc;
    /** @type {string} */
    City;
    /** @type {string} */
    County;
    /** @type {string} */
    ZipCode;
    /** @type {string} */
    GeoCode;
    /** @type {number} */
    TaxRate1;
    /** @type {number} */
    TaxRate2;
}
export class GetTaxAuthoritiesResponse extends BaseResponse {
    /** @param {{TaxAuthorities?:TaxAuthoritityInfo[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {TaxAuthoritityInfo[]} */
    TaxAuthorities;
}
export class GetTaxAuthoritiesRequest extends BaseSecureRequest {
    /** @param {{TaxAuthorityId?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /**
     * @type {?number}
     * @description Tax Authority lookup. If sent, all other parameters will be ignored. */
    TaxAuthorityId;
}

JavaScript GetTaxAuthoritiesRequest DTOs

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

HTTP + OTHER

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: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"TaxAuthorities":[{"Id":0,"Desc":"String","ShortDesc":"String","City":"String","County":"String","ZipCode":"String","GeoCode":"String","TaxRate1":0,"TaxRate2":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}