AIM Web Services

SubmitPOSTransactionRequest

In development, not yet for public use.

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

import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* In development, not yet for public use.
*/
@DataContract
open class SubmitPOSTransactionRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null

    @DataMember
    var LocId:Long? = null

    @DataMember
    var TaxId:Long? = null

    @DataMember
    var Items:ArrayList<PosLineItem> = ArrayList<PosLineItem>()

    /**
    * 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")
    var TenderType:String? = null

    /**
    * 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")
    var OtherTenderCategory:Int? = null

    @DataMember
    var CardToken:String? = null

    @DataMember
    var CardExpiration:String? = null

    @DataMember
    var TokenPk:Long? = null

    @DataMember
    var SaveCard:Boolean? = null

    @DataMember
    var PONumber:String? = null

    /**
    * 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")
    var TransactionMode:String? = null

    /**
    * Only valid for Approvals and Orders.
    */
    @DataMember
    @ApiMember(DataType="decimal", Description="Only valid for Approvals and Orders.", Name="Deposit", ParameterType="query")
    var Deposit:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    /**
    * Do Not Send This Parameter
    */
    @DataMember
    @ApiMember(Description="Do Not Send This Parameter", Name="OnlineContractRef", ParameterType="query")
    var OnlineContractRef:String? = null

    @DataMember
    var ShipId:Long? = null

    @DataMember
    var CardTerminalId:String? = 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 PosLineItem : IScanItem
{
    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ExceptionInfo:ExceptionInfo? = null

    @DataMember
    var Discount:BigDecimal? = null

    @DataMember
    var NicsCat:Int? = null

    @DataMember
    var NicsSub:Int? = null

    @DataMember
    var PriceOverride:BigDecimal? = null

    @DataMember
    var AllowPriceOverrideToIgnoreMinPrice:Boolean? = null

    @DataMember
    var Notes:String? = null
}

@DataContract
open class ExceptionInfo
{
    @DataMember
    var Barcode:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var Base64Image:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var SubCategory:Int? = null
}

@DataContract
open class SubmitPOSTransactionResponse : BaseResponse()
{
    @DataMember
    var RefNumber:String? = null

    @DataMember
    var ErrorItems:ArrayList<PosResponseItem> = ArrayList<PosResponseItem>()
}

@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 PosResponseItem : PosLineItem()
{
    @DataMember
    var PriceEach:BigDecimal? = null

    @DataMember
    var Price:BigDecimal? = null

    @DataMember
    var Discountable:Boolean? = null

    @DataMember
    var ErrorMessage:String? = null
}

Kotlin 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"}}