AIM Web Services

<back to all web services

ContractFullDetailsRequest

ContractFullDetails
Requires active-e Contracts Service.

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


/**
* ContractFullDetailsRequires active-e Contracts Service.
*/
@DataContract
open class ContractFullDetailsRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null

    @DataMember
    var Sub:Int? = null

    @DataMember
    var ChangedDate:Date? = null

    @DataMember
    var SerialNumber:String? = null

    /**
    * If sent, additional calculated fields will be returned using this date
    */
    @DataMember
    @ApiMember(DataType="string", Description="If sent, additional calculated fields will be returned using this date", Format="date", Name="CalculationsDate", ParameterType="query")
    var CalculationsDate:Date? = null

    /**
    * The Starting Offset
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The Starting Offset", Format="int64", Name="StartOffset")
    var StartOffset:Long? = null

    /**
    * The # of records to be returned
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The # of records to be returned", Format="int64", Name="RecordCount")
    var RecordCount:Long? = null

    /**
    * The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="AIMRef")
    var AIMRef:String? = null

    /**
    * The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
    */
    @DataMember
    @ApiMember(DataType="string", Description="The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="WebRef")
    var WebRef: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 ContractFullDetailsResponse : BaseResponse()
{
    @DataMember
    var Contracts:ArrayList<ContractInfo> = ArrayList<ContractInfo>()

    @DataMember
    var RemainingRecords:Long? = null
}

@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 ContractInfo
{
    @DataMember
    var Rnt_afee:BigDecimal? = null

    @DataMember
    var Rnt_alatedbt:Boolean? = null

    @DataMember
    var Rnt_amtfin:BigDecimal? = null

    @DataMember
    var Rnt_aofinchg:BigDecimal? = null

    @DataMember
    var Rnt_apaydbt:Boolean? = null

    @DataMember
    var Rnt_apaytyp:String? = null

    @DataMember
    var Rnt_atcode:Short? = null

    @DataMember
    var Rnt_autopayhold:Date? = null

    @DataMember
    var Rnt_avgbal:BigDecimal? = null

    @DataMember
    var Rnt_balance:BigDecimal? = null

    @DataMember
    var Rnt_billdays:Short? = null

    @DataMember
    var Rnt_cdate:Date? = null

    @DataMember
    var Rnt_colagency:String? = null

    @DataMember
    var Rnt_colamt:BigDecimal? = null

    @DataMember
    var Rnt_coupdate:Date? = null

    @DataMember
    var Rnt_cramt:BigDecimal? = null

    @DataMember
    var Rnt_crmo:Short? = null

    @DataMember
    var Rnt_currafee:BigDecimal? = null

    @DataMember
    var Rnt_currbal:BigDecimal? = null

    @DataMember
    var Rnt_currfc:BigDecimal? = null

    @DataMember
    var Rnt_currfeetax1:BigDecimal? = null

    @DataMember
    var Rnt_currfeetax2:BigDecimal? = null

    @DataMember
    var Rnt_currlte:BigDecimal? = null

    @DataMember
    var Rnt_currma:BigDecimal? = null

    @DataMember
    var Rnt_curroth:BigDecimal? = null

    @DataMember
    var Rnt_currprn:BigDecimal? = null

    @DataMember
    var Rnt_currtax1:BigDecimal? = null

    @DataMember
    var Rnt_currtax2:BigDecimal? = null

    @DataMember
    var Rnt_dayslate:Short? = null

    @DataMember
    var Rnt_daystlst:Short? = null

    @DataMember
    var Rnt_deprcode:String? = null

    @DataMember
    var Rnt_discount:BigDecimal? = null

    @DataMember
    var Rnt_downpay:BigDecimal? = null

    @DataMember
    var Rnt_dunn:String? = null

    @DataMember
    var Rnt_edate:Date? = null

    @DataMember
    var Rnt_fdate:Date? = null

    @DataMember
    var Rnt_fee:BigDecimal? = null

    @DataMember
    var Rnt_finalpay:BigDecimal? = null

    @DataMember
    var Rnt_finchg:BigDecimal? = null

    @DataMember
    var Rnt_freemos:Short? = null

    @DataMember
    var Rnt_intdate:Date? = null

    @DataMember
    var Rnt_intrate:BigDecimal? = null

    @DataMember
    var Rnt_irregular:Boolean? = null

    @DataMember
    var Rnt_itcode:Short? = null

    @DataMember
    var Rnt_lastpaid:BigDecimal? = null

    @DataMember
    var Rnt_latefee:BigDecimal? = null

    @DataMember
    var Rnt_lateowed:BigDecimal? = null

    @DataMember
    var Rnt_ldate:Date? = null

    @DataMember
    var Rnt_ltcode:Short? = null

    @DataMember
    var Rnt_monma:BigDecimal? = null

    @DataMember
    var Rnt_mopayreq:Boolean? = null

    @DataMember
    var Rnt_mtcode:Short? = null

    @DataMember
    var Rnt_ndate:Date? = null

    @DataMember
    var Rnt_nextpayamt:BigDecimal? = null

    @DataMember
    var Rnt_nextpaynum:Short? = null

    @DataMember
    var Rnt_notedate:Date? = null

    @DataMember
    var Rnt_notes:String? = null

    @DataMember
    var Rnt_exchnotes:String? = null

    @DataMember
    var Rnt_otherowed:BigDecimal? = null

    @DataMember
    var Rnt_payfreq:Short? = null

    @DataMember
    var Rnt_latefreq:Short? = null

    @DataMember
    var Rnt_payfreqtype:Short? = null

    @DataMember
    var Rnt_payment:BigDecimal? = null

    @DataMember
    var Rnt_paystrm:Short? = null

    @DataMember
    var Rnt_pk:Long? = null

    @DataMember
    var Rnt_prevamt:BigDecimal? = null

    @DataMember
    var Rnt_prevmo:Short? = null

    @DataMember
    var Rnt_price:BigDecimal? = null

    @DataMember
    var Rnt_rdate:Date? = null

    @DataMember
    var Rnt_sdate:Date? = null

    @DataMember
    var Rnt_student:String? = null

    @DataMember
    var Rnt_sub:Int? = null

    @DataMember
    var Rnt_tax:BigDecimal? = null

    @DataMember
    var Rnt_taxrate1:BigDecimal? = null

    @DataMember
    var Rnt_taxrate2:BigDecimal? = null

    @DataMember
    var Rnt_taxrateorig1:BigDecimal? = null

    @DataMember
    var Rnt_taxrateorig2:BigDecimal? = null

    @DataMember
    var Rnt_tcode:Short? = null

    @DataMember
    var Rnt_term:Short? = null

    @DataMember
    var Rnt_tmaint:BigDecimal? = null

    @DataMember
    var Rnt_tradein:BigDecimal? = null

    @DataMember
    var Rnt_typer:String? = null

    @DataMember
    var Rnt_timestamp:Date? = null

    @DataMember
    var Acct:Int? = null

    @DataMember
    var TaxLocation:String? = null

    @DataMember
    var DefaultDesc:String? = null

    @DataMember
    var PayoffDesc:String? = null

    @DataMember
    var School:String? = null

    @DataMember
    var District:String? = null

    @DataMember
    var Ref:String? = null

    @DataMember
    var AutoPayDeclined:Boolean? = null

    @DataMember
    var Inventory:ArrayList<ContractInventoryInfo> = ArrayList<ContractInventoryInfo>()

    @DataMember
    var CardInfo:CcInfo? = null

    @DataMember
    var ContractCalculatedFields:ContractCalculatedFields? = null

    @DataMember
    var Payments:ArrayList<PaymentGeneric> = ArrayList<PaymentGeneric>()

    @DataMember
    var Rnt_avacodeprin:String? = null

    @DataMember
    var Rnt_avacodemaint:String? = null

    @DataMember
    var Rnt_avacodelate:String? = null

    @DataMember
    var Rnt_avacodelease:String? = null

    @DataMember
    var Rnt_avacodefin:String? = null

    @DataMember
    var Rnt_scheduledreturndate:Date? = null

    @DataMember
    var Rnt_scheduledreturnoption:String? = null

    @DataMember
    var Rnt_scheduledreturnnotes:String? = null

    @DataMember
    var Rnt_scheduledreturnstatus:String? = null
}

@DataContract
open class ContractInventoryInfo
{
    @DataMember
    var Id:Long? = null

    @DataMember
    var BeginDate:Date? = null

    @DataMember
    var Cat:Int? = null

    @DataMember
    var Cost:BigDecimal? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var Discount:BigDecimal? = null

    @DataMember
    var Dunn:String? = null

    @DataMember
    var EndDate:Date? = null

    @DataMember
    var InvType:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var OurPrice:BigDecimal? = null

    @DataMember
    var Qty:BigDecimal? = null

    @DataMember
    var ReceiptNotes:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Sub:Int? = null

    @DataMember
    var Total:BigDecimal? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Mfg:String? = null
}

@DataContract(Name="CCInfo")
open class CcInfo
{
    /**
    * Token returned from processor
    */
    @DataMember
    @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")
    var TokenStr:String? = null

    /**
    * Card Type (VISA, MCARD, AMEX, DSCVR)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")
    var CardType:String? = null

    /**
    * Last four of the card
    */
    @DataMember
    @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    var LastFour:String? = null

    /**
    * Expiration Date of the Card. (MM/YY)
    */
    @DataMember
    @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")
    var Expiration:String? = null

    /**
    * Reason the card is on file.
    */
    @DataMember
    @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    var ReasonOnFile:String? = null

    /**
    * ID of the existing Token Record in AIM, if applicable
    */
    @DataMember
    @ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")
    var TokenPk:Long? = null

    /**
    * Is this the customer's primary card? Defaults to false.
    */
    @DataMember
    @ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")
    var Primary:Boolean? = null
}

@DataContract
open class ContractCalculatedFields
{
    @DataMember
    var Terms:Int? = null

    @DataMember
    var PayStream:Int? = null

    @DataMember
    var FinalPay:BigDecimal? = null

    @DataMember
    var AmountDue:BigDecimal? = null

    @DataMember
    var Payoff:BigDecimal? = null

    @DataMember
    var DiscountedPayoff:BigDecimal? = null

    @DataMember
    var RebateFc:BigDecimal? = null

    @DataMember
    var TotalLate:BigDecimal? = null

    @DataMember
    var PaymentsLate:BigDecimal? = null

    @DataMember
    var PaymentsAhead:Int? = null

    @DataMember
    var TotalMaintOwed:BigDecimal? = null

    @DataMember
    var CurrentPlusNext:BigDecimal? = null

    @DataMember
    var PayoffDate:Date? = null

    @DataMember
    var CreditAmount:BigDecimal? = null

    @DataMember
    var PrinLessTax:BigDecimal? = null

    @DataMember
    var MaintLessTax:BigDecimal? = null

    @DataMember
    var AFeeLessTax:BigDecimal? = null

    @DataMember
    var PaymentTax:BigDecimal? = null

    @DataMember
    var RentDueInfo:ArrayList<ContractValuesObject> = ArrayList<ContractValuesObject>()

    @DataMember
    var PayoffInfo:ArrayList<ContractValuesObject> = ArrayList<ContractValuesObject>()

    @DataMember
    var Notice:String? = null

    @DataMember
    var Notice2:String? = null
}

@DataContract
open class ContractValuesObject
{
    @DataMember
    var Position:Int? = null

    @DataMember
    var Display:String? = null

    @DataMember
    var Value:BigDecimal? = null
}

@DataContract
open class PaymentGeneric
{
    @DataMember
    var Date:Date? = null

    @DataMember
    var Amount:BigDecimal? = null

    @DataMember
    var Ref:String? = null
}

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

GET /api/ContractFullDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"Contracts":[{"Rnt_afee":0,"Rnt_alatedbt":false,"Rnt_amtfin":0,"Rnt_aofinchg":0,"Rnt_apaydbt":false,"Rnt_apaytyp":"String","Rnt_atcode":0,"Rnt_avgbal":0,"Rnt_balance":0,"Rnt_billdays":0,"Rnt_colagency":"String","Rnt_colamt":0,"Rnt_cramt":0,"Rnt_crmo":0,"Rnt_currafee":0,"Rnt_currbal":0,"Rnt_currfc":0,"Rnt_currfeetax1":0,"Rnt_currfeetax2":0,"Rnt_currlte":0,"Rnt_currma":0,"Rnt_curroth":0,"Rnt_currprn":0,"Rnt_currtax1":0,"Rnt_currtax2":0,"Rnt_dayslate":0,"Rnt_daystlst":0,"Rnt_deprcode":"String","Rnt_discount":0,"Rnt_downpay":0,"Rnt_dunn":"String","Rnt_fee":0,"Rnt_finalpay":0,"Rnt_finchg":0,"Rnt_freemos":0,"Rnt_intrate":0,"Rnt_irregular":false,"Rnt_itcode":0,"Rnt_lastpaid":0,"Rnt_latefee":0,"Rnt_lateowed":0,"Rnt_ltcode":0,"Rnt_monma":0,"Rnt_mopayreq":false,"Rnt_mtcode":0,"Rnt_nextpayamt":0,"Rnt_nextpaynum":0,"Rnt_notes":"String","Rnt_exchnotes":"String","Rnt_otherowed":0,"Rnt_payfreq":0,"Rnt_latefreq":0,"Rnt_payfreqtype":0,"Rnt_payment":0,"Rnt_paystrm":0,"Rnt_pk":0,"Rnt_prevamt":0,"Rnt_prevmo":0,"Rnt_price":0,"Rnt_student":"String","Rnt_sub":0,"Rnt_tax":0,"Rnt_taxrate1":0,"Rnt_taxrate2":0,"Rnt_taxrateorig1":0,"Rnt_taxrateorig2":0,"Rnt_tcode":0,"Rnt_term":0,"Rnt_tmaint":0,"Rnt_tradein":0,"Rnt_typer":"String","Acct":0,"TaxLocation":"String","DefaultDesc":"String","PayoffDesc":"String","School":"String","District":"String","Ref":"String","AutoPayDeclined":false,"Inventory":[{"Id":0,"Cat":0,"Cost":0,"Description":"String","Discount":0,"Dunn":"String","InvType":"String","Notes":"String","OurPrice":0,"Qty":0,"ReceiptNotes":"String","Serial":"String","Sub":0,"Total":0,"Sku":"String","Mfg":"String"}],"CardInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"ContractCalculatedFields":{"Terms":0,"PayStream":0,"FinalPay":0,"AmountDue":0,"Payoff":0,"DiscountedPayoff":0,"RebateFc":0,"TotalLate":0,"PaymentsLate":0,"PaymentsAhead":0,"TotalMaintOwed":0,"CurrentPlusNext":0,"CreditAmount":0,"PrinLessTax":0,"MaintLessTax":0,"AFeeLessTax":0,"PaymentTax":0,"RentDueInfo":[{"Position":0,"Display":"String","Value":0}],"PayoffInfo":[{"Position":0,"Display":"String","Value":0}],"Notice":"String","Notice2":"String"},"Payments":[{"Amount":0,"Ref":"String"}],"Rnt_avacodeprin":"String","Rnt_avacodemaint":"String","Rnt_avacodelate":"String","Rnt_avacodelease":"String","Rnt_avacodefin":"String","Rnt_scheduledreturnoption":"String","Rnt_scheduledreturnnotes":"String","Rnt_scheduledreturnstatus":"String"}],"RemainingRecords":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}