AIM Web Services

<back to all web services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/History360
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* History360Requires active-e Customer Service.
*/
@DataContract
open class History360Request : BaseSecureRequest()
{
    @DataMember
    open var CustomerAccount:Int? = null

    @DataMember
    open var IncludeInvoices:Boolean? = null

    @DataMember
    open var IncludeOrders:Boolean? = null

    @DataMember
    open var IncludeWorkOrders:Boolean? = null

    @DataMember
    open var IncludeContracts:Boolean? = null

    @DataMember
    open var IncludeClosed:Boolean? = null

    @DataMember
    open var ClosedStartDate:Date? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    open var Token: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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class History360Response : BaseResponse()
{
    @DataMember
    open var Invoices:ArrayList<Invoice360>? = null

    @DataMember
    open var Orders:ArrayList<Order360>? = null

    @DataMember
    open var WorkOrders:ArrayList<WorkOrder360>? = null

    @DataMember
    open var Contracts:ArrayList<Contract360>? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    open var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class Invoice360
{
    @DataMember
    open var Id:String? = null

    @DataMember
    open var DueDate:Date? = null

    @DataMember
    open var Total:BigDecimal? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var AmountPaid:BigDecimal? = null

    @DataMember
    open var PaymentType:String? = null

    @DataMember
    open var LateFeeAmount:BigDecimal? = null

    @DataMember
    open var PurchaseDate:Date? = null

    @DataMember
    open var StoreLocationId:Int? = null

    @DataMember
    open var Discount:BigDecimal? = null

    @DataMember
    open var Tax:BigDecimal? = null

    @DataMember
    open var Shipping:BigDecimal? = null

    @DataMember
    open var Items:ArrayList<Item360>? = null
}

@DataContract
open class Item360
{
    @DataMember
    open var PslrId:Long? = null

    @DataMember
    open var Quantity:BigDecimal? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var TotalDiscountAmount:BigDecimal? = null

    @DataMember
    open var SerialNumber:String? = null

    @DataMember
    open var Condition:String? = null
}

@DataContract
open class Order360
{
    @DataMember
    open var Id:Int? = null

    @DataMember
    open var Date:Date? = null

    @DataMember
    open var Discount:BigDecimal? = null

    @DataMember
    open var PaymentType:String? = null

    @DataMember
    open var SubTotal:BigDecimal? = null

    @DataMember
    open var Tax:BigDecimal? = null

    @DataMember
    open var ShippingAmount:BigDecimal? = null

    @DataMember
    open var Total:BigDecimal? = null
}

@DataContract
open class WorkOrder360
{
    @DataMember
    open var Id:String? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var Deposit:BigDecimal? = null

    @DataMember
    open var StoreLocationId:Int? = null

    @DataMember
    open var CreationDate:Date? = null

    @DataMember
    open var CompletedDate:Date? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var LocationName:String? = null

    @DataMember
    open var Jobs:ArrayList<Job360>? = null
}

@DataContract
open class Job360
{
    @DataMember
    open var ItemId:String? = null

    @DataMember
    open var ItemType:String? = null

    @DataMember
    open var Title:String? = null

    @DataMember
    open var Quantity:BigDecimal? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var TotalDiscountAmount:BigDecimal? = null

    @DataMember
    open var SerialNumber:String? = null

    @DataMember
    open var Condition:String? = null
}

@DataContract
open class Contract360
{
    @DataMember
    open var Id:String? = null

    @DataMember
    open var PaymentDate:Date? = null

    @DataMember
    open var StoreLocationId:Int? = null

    @DataMember
    open var AmountDue:BigDecimal? = null

    @DataMember
    open var LateFee:BigDecimal? = null

    @DataMember
    open var ContractStatus:String? = null

    @DataMember
    open var Amount:BigDecimal? = null

    @DataMember
    open var LocationName:String? = null

    @DataMember
    open var ContractItems:ArrayList<Item360>? = null
}

Kotlin History360Request 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.

GET /api/History360 HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

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

{"Invoices":[{"Id":"String","DueDate":"0001-01-01T00:00:00.0000000","Total":0,"Status":"String","AmountPaid":0,"PaymentType":"String","LateFeeAmount":0,"StoreLocationId":0,"Discount":0,"Tax":0,"Shipping":0,"Items":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Orders":[{"Id":0,"Discount":0,"PaymentType":"String","SubTotal":0,"Tax":0,"ShippingAmount":0,"Total":0}],"WorkOrders":[{"Id":"String","Status":"String","Deposit":0,"StoreLocationId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","Price":0,"LocationName":"String","Jobs":[{"ItemId":"String","ItemType":"String","Title":"String","Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Contracts":[{"Id":"String","StoreLocationId":0,"AmountDue":0,"LateFee":0,"ContractStatus":"String","Amount":0,"LocationName":"String","ContractItems":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}