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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseRequest:
    # @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    api_key: Optional[str] = None
    """
    This is your AIM API Key provided by Tri-Tech
    """


    # @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    o_auth_token: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseSecureRequest(BaseRequest):
    # @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    token: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    device_id: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    app_id: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponseResult:
    # @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    status_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    login: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    error_code: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    error_display_text: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    error_message: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    domain_name: Optional[str] = None
    """
    
    """

    # @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    ip_address: Optional[str] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseResponse:
    # @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    status: Optional[BaseResponseResult] = None
    """
    
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExceptionInfo:
    barcode: Optional[str] = None
    description: Optional[str] = None
    base64_image: Optional[str] = None
    category: int = 0
    sub_category: Optional[int] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PosLineItem(IScanItem):
    sku_pk: Optional[int] = None
    sas_pk: Optional[int] = None
    sku: Optional[str] = None
    serial: Optional[str] = None
    quantity: Decimal = decimal.Decimal(0)
    exception_info: Optional[ExceptionInfo] = None
    discount: Optional[Decimal] = None
    nics_cat: Optional[int] = None
    nics_sub: Optional[int] = None
    price_override: Optional[Decimal] = None
    allow_price_override_to_ignore_min_price: bool = False
    notes: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PosResponseItem(PosLineItem):
    price_each: Decimal = decimal.Decimal(0)
    price: Decimal = decimal.Decimal(0)
    discountable: bool = False
    error_message: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubmitPOSTransactionResponse(BaseResponse):
    ref_number: Optional[str] = None
    error_items: Optional[List[PosResponseItem]] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SubmitPOSTransactionRequest(BaseSecureRequest):
    """
    In development, not yet for public use.
    """

    acct: Optional[int] = None
    loc_id: Optional[int] = None
    tax_id: Optional[int] = None
    items: Optional[List[PosLineItem]] = None
    # @ApiMember(DataType="string", Description="Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER", Name="TenderType", ParameterType="query")
    tender_type: Optional[str] = None
    """
    Can be CARD, CARD_DEVICE, CASH, CHARGE, SUSPEND, ONFILE, or OTHER
    """


    # @ApiMember(DataType="string", Description="Only applicable for Tender Type of OTHER. Send the Payment Category #", Name="OtherTenderCategory", ParameterType="query")
    other_tender_category: Optional[int] = None
    """
    Only applicable for Tender Type of OTHER. Send the Payment Category #
    """


    card_token: Optional[str] = None
    card_expiration: Optional[str] = None
    token_pk: Optional[int] = None
    save_card: bool = False
    po_number: Optional[str] = None
    # @ApiMember(DataType="string", Description="Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.", Name="TransactionMode", ParameterType="query")
    transaction_mode: Optional[str] = None
    """
    Can be INVOICE, PROPOSAL, APPROVAL, ORDER, or LOANER. Defaults to INVOICE is not sent.
    """


    # @ApiMember(DataType="decimal", Description="Only valid for Approvals and Orders.", Name="Deposit", ParameterType="query")
    deposit: Decimal = decimal.Decimal(0)
    """
    Only valid for Approvals and Orders.
    """


    notes: Optional[str] = None
    # @ApiMember(Description="Do Not Send This Parameter", Name="OnlineContractRef", ParameterType="query")
    online_contract_ref: Optional[str] = None
    """
    Do Not Send This Parameter
    """


    ship_id: Optional[int] = None
    card_terminal_id: Optional[str] = None

Python 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>