AIM Web Services

<back to all 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 .xml suffix or ?format=xml

HTTP + XML

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/xml
Content-Type: application/xml
Content-Length: length

<SubmitPOSTransactionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <CardExpiration>String</CardExpiration>
  <CardTerminalId>String</CardTerminalId>
  <CardToken>String</CardToken>
  <Deposit>0</Deposit>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:PosLineItem>
      <d2p1:AllowPriceOverrideToIgnoreMinPrice>false</d2p1:AllowPriceOverrideToIgnoreMinPrice>
      <d2p1:Discount>0</d2p1:Discount>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:NicsCat>0</d2p1:NicsCat>
      <d2p1:NicsSub>0</d2p1:NicsSub>
      <d2p1:Notes>String</d2p1:Notes>
      <d2p1:PriceOverride>0</d2p1:PriceOverride>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:PosLineItem>
  </Items>
  <LocId>0</LocId>
  <Notes>String</Notes>
  <OnlineContractRef>String</OnlineContractRef>
  <OtherTenderCategory>0</OtherTenderCategory>
  <PONumber>String</PONumber>
  <SaveCard>false</SaveCard>
  <ShipId>0</ShipId>
  <TaxId>0</TaxId>
  <TenderType>String</TenderType>
  <TokenPk>0</TokenPk>
  <TransactionMode>String</TransactionMode>
</SubmitPOSTransactionRequest>

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

<SubmitPOSTransactionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ErrorItems>
    <PosResponseItem>
      <AllowPriceOverrideToIgnoreMinPrice xmlns="http://schemas.datacontract.org/2004/07/AIM">false</AllowPriceOverrideToIgnoreMinPrice>
      <Discount xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Discount>
      <ExceptionInfo xmlns="http://schemas.datacontract.org/2004/07/AIM">
        <Barcode>String</Barcode>
        <Base64Image>String</Base64Image>
        <Category>0</Category>
        <Description>String</Description>
        <SubCategory>0</SubCategory>
      </ExceptionInfo>
      <NicsCat xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsCat>
      <NicsSub xmlns="http://schemas.datacontract.org/2004/07/AIM">0</NicsSub>
      <Notes xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Notes>
      <PriceOverride xmlns="http://schemas.datacontract.org/2004/07/AIM">0</PriceOverride>
      <Quantity xmlns="http://schemas.datacontract.org/2004/07/AIM">0</Quantity>
      <SasPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SasPk>
      <Serial xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Serial>
      <Sku xmlns="http://schemas.datacontract.org/2004/07/AIM">String</Sku>
      <SkuPk xmlns="http://schemas.datacontract.org/2004/07/AIM">0</SkuPk>
      <Discountable>false</Discountable>
      <ErrorMessage>String</ErrorMessage>
      <Price>0</Price>
      <PriceEach>0</PriceEach>
    </PosResponseItem>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</SubmitPOSTransactionResponse>