AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

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

namespace AIM

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ExceptionInfo() = 
        [<DataMember>]
        member val Barcode:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Base64Image:String = null with get,set

        [<DataMember>]
        member val Category:Int32 = new Int32() with get,set

        [<DataMember>]
        member val SubCategory:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PosLineItem() = 
        [<DataMember>]
        member val SkuPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SasPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Sku:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val Quantity:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val ExceptionInfo:ExceptionInfo = null with get,set

        [<DataMember>]
        member val Discount:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val NicsCat:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val NicsSub:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val PriceOverride:Nullable<Decimal> = new Nullable<Decimal>() with get,set

        [<DataMember>]
        member val AllowPriceOverrideToIgnoreMinPrice:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type PosResponseItem() = 
        inherit PosLineItem()
        [<DataMember>]
        member val PriceEach:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Discountable:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val ErrorMessage:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SubmitPOSTransactionResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val RefNumber:String = null with get,set

        [<DataMember>]
        member val ErrorItems:ResizeArray<PosResponseItem> = new ResizeArray<PosResponseItem>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseRequest() = 
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///In development, not yet for public use.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type SubmitPOSTransactionRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val LocId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val TaxId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val Items:ResizeArray<PosLineItem> = new ResizeArray<PosLineItem>() with get,set

        ///<summary>
        ///Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER", Name="TenderType", ParameterType="query")>]
        member val TenderType:String = null with get,set

        ///<summary>
        ///Only applicable for Tender Type of OTHER. Send the Payment Category #
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Only applicable for Tender Type of OTHER. Send the Payment Category #", Name="OtherTenderCategory", ParameterType="query")>]
        member val OtherTenderCategory:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember>]
        member val CardToken:String = null with get,set

        [<DataMember>]
        member val CardExpiration:String = null with get,set

        [<DataMember>]
        member val TokenPk:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SaveCard:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val PONumber:String = null with get,set

        ///<summary>
        ///Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.", Name="TransactionMode", ParameterType="query")>]
        member val TransactionMode:String = null with get,set

        ///<summary>
        ///Only valid for Approvals and Orders.
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="decimal", Description="Only valid for Approvals and Orders.", Name="Deposit", ParameterType="query")>]
        member val Deposit:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val Notes:String = null with get,set

        ///<summary>
        ///Do Not Send This Parameter
        ///</summary>
        [<DataMember>]
        [<ApiMember(Description="Do Not Send This Parameter", Name="OnlineContractRef", ParameterType="query")>]
        member val OnlineContractRef:String = null with get,set

        [<DataMember>]
        member val ShipId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val CardTerminalId:String = null with get,set

F# SubmitPOSTransactionRequest 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/SubmitPOSTransaction 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"}],"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: application/json
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"}}