AIM Web Services

<back to all web services

GetPOSTotalsRequest

In development, not yet for public use.

The following routes are available for this service:
POST/api/GetPOSTotals
"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 ExceptionInfo {
    /** @param {{Barcode?:string,Description?:string,Base64Image?:string,Category?:number,SubCategory?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Barcode;
    /** @type {string} */
    Description;
    /** @type {string} */
    Base64Image;
    /** @type {number} */
    Category;
    /** @type {?number} */
    SubCategory;
}
export class PosLineItem {
    /** @param {{SkuPk?:number,SasPk?:number,Sku?:string,Serial?:string,Quantity?:number,ExceptionInfo?:ExceptionInfo,Discount?:number,NicsCat?:number,NicsSub?:number,PriceOverride?:number,AllowPriceOverrideToIgnoreMinPrice?:boolean,Notes?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    SkuPk;
    /** @type {?number} */
    SasPk;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Serial;
    /** @type {number} */
    Quantity;
    /** @type {ExceptionInfo} */
    ExceptionInfo;
    /** @type {?number} */
    Discount;
    /** @type {?number} */
    NicsCat;
    /** @type {?number} */
    NicsSub;
    /** @type {?number} */
    PriceOverride;
    /** @type {boolean} */
    AllowPriceOverrideToIgnoreMinPrice;
    /** @type {string} */
    Notes;
}
export class PosResponseItem extends PosLineItem {
    /** @param {{PriceEach?:number,Price?:number,Discountable?:boolean,ErrorMessage?:string,SkuPk?:number,SasPk?:number,Sku?:string,Serial?:string,Quantity?:number,ExceptionInfo?:ExceptionInfo,Discount?:number,NicsCat?:number,NicsSub?:number,PriceOverride?:number,AllowPriceOverrideToIgnoreMinPrice?:boolean,Notes?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    PriceEach;
    /** @type {number} */
    Price;
    /** @type {boolean} */
    Discountable;
    /** @type {string} */
    ErrorMessage;
}
export class GetPOSTotalsResponse extends BaseResponse {
    /** @param {{SubTotal?:number,TaxTotal?:number,Total?:number,Items?:PosResponseItem[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    SubTotal;
    /** @type {number} */
    TaxTotal;
    /** @type {number} */
    Total;
    /** @type {PosResponseItem[]} */
    Items;
}
export class GetPOSTotalsRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,LocId?:number,TaxId?:number,Items?:PosLineItem[],DiscountMode?:string,DiscountDetail?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    Acct;
    /** @type {?number} */
    LocId;
    /** @type {?number} */
    TaxId;
    /** @type {PosLineItem[]} */
    Items;
    /**
     * @type {string}
     * @description MANUAL, BLANKET_PERCENT, BLANKET_AMOUNT, BACK_INTO_TOTAL, or BACK_INTO_TOTAL_WITH_TAX. Defaults to Manual. No line item discounts can be set unless this is MANUAL. */
    DiscountMode;
    /** @type {?number} */
    DiscountDetail;
}

JavaScript GetPOSTotalsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /api/GetPOSTotals HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Acct":0,"LocId":0,"TaxId":0,"Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"DiscountMode":"String","DiscountDetail":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"SubTotal":0,"TaxTotal":0,"Total":0,"Items":[{"PriceEach":0,"Price":0,"Discountable":false,"ErrorMessage":"String","SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"Discount":0,"NicsCat":0,"NicsSub":0,"PriceOverride":0,"AllowPriceOverrideToIgnoreMinPrice":false,"Notes":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}