AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

The following routes are available for this service:
POST	/api/SubmitPOSTransaction


// @DataContract
export class BaseRequest
{
    /** @description 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")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ExceptionInfo
{
    // @DataMember
    public Barcode: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Base64Image: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public SubCategory?: number;

    public constructor(init?: Partial<ExceptionInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PosLineItem implements IScanItem
{
    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ExceptionInfo: ExceptionInfo;

    // @DataMember
    public Discount?: number;

    // @DataMember
    public NicsCat?: number;

    // @DataMember
    public NicsSub?: number;

    // @DataMember
    public PriceOverride?: number;

    // @DataMember
    public AllowPriceOverrideToIgnoreMinPrice: boolean;

    // @DataMember
    public Notes: string;

    public constructor(init?: Partial<PosLineItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class PosResponseItem extends PosLineItem
{
    // @DataMember
    public PriceEach: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public Discountable: boolean;

    // @DataMember
    public ErrorMessage: string;

    public constructor(init?: Partial<PosResponseItem>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class SubmitPOSTransactionResponse extends BaseResponse
{
    // @DataMember
    public RefNumber: string;

    // @DataMember
    public ErrorItems: PosResponseItem[];

    public constructor(init?: Partial<SubmitPOSTransactionResponse>) { super(init); (Object as any).assign(this, init); }
}

/** @description In development, not yet for public use. */
// @DataContract
export class SubmitPOSTransactionRequest extends BaseSecureRequest
{
    // @DataMember
    public Acct?: number;

    // @DataMember
    public LocId?: number;

    // @DataMember
    public TaxId?: number;

    // @DataMember
    public Items: PosLineItem[];

    /** @description Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER */
    // @DataMember
    // @ApiMember(DataType="string", Description="Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER", Name="TenderType", ParameterType="query")
    public TenderType: string;

    /** @description Only applicable for Tender Type of OTHER. Send the Payment Category # */
    // @DataMember
    // @ApiMember(DataType="string", Description="Only applicable for Tender Type of OTHER. Send the Payment Category #", Name="OtherTenderCategory", ParameterType="query")
    public OtherTenderCategory?: number;

    // @DataMember
    public CardToken: string;

    // @DataMember
    public CardExpiration: string;

    // @DataMember
    public TokenPk?: number;

    // @DataMember
    public SaveCard: boolean;

    // @DataMember
    public PONumber: string;

    /** @description Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.", Name="TransactionMode", ParameterType="query")
    public TransactionMode: string;

    /** @description Only valid for Approvals and Orders. */
    // @DataMember
    // @ApiMember(DataType="decimal", Description="Only valid for Approvals and Orders.", Name="Deposit", ParameterType="query")
    public Deposit: number;

    // @DataMember
    public Notes: string;

    /** @description Do Not Send This Parameter */
    // @DataMember
    // @ApiMember(Description="Do Not Send This Parameter", Name="OnlineContractRef", ParameterType="query")
    public OnlineContractRef: string;

    // @DataMember
    public ShipId?: number;

    // @DataMember
    public CardTerminalId: string;

    public constructor(init?: Partial<SubmitPOSTransactionRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript SubmitPOSTransactionRequest 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.

POST /api/SubmitPOSTransaction HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
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"}],"TenderType":"String","OtherTenderCategory":0,"CardToken":"String","CardExpiration":"String","TokenPk":0,"SaveCard":false,"PONumber":"String","TransactionMode":"String","Deposit":0,"Notes":"String","OnlineContractRef":"String","ShipId":0,"CardTerminalId":"String","Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"RefNumber":"String","ErrorItems":[{"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"}}