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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM.BL.Core.Global;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class PaymentGeneric
    {
        [DataMember]
        public virtual DateTime Date { get; set; }

        [DataMember]
        public virtual decimal Amount { get; set; }

        [DataMember]
        public virtual string Ref { get; set; }
    }

}

namespace AIM.BL.Core.Global
{
    [DataContract]
    public partial class ContractValuesObject
    {
        [DataMember]
        public virtual int Position { get; set; }

        [DataMember]
        public virtual string Display { get; set; }

        [DataMember]
        public virtual decimal Value { get; set; }
    }

}

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract(Name="CCInfo")]
    public partial class CcInfo
    {
        ///<summary>
        ///Token returned from processor
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="query")]
        public virtual string TokenStr { get; set; }

        ///<summary>
        ///Card Type (VISA, MCARD, AMEX, DSCVR)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="query")]
        public virtual string CardType { get; set; }

        ///<summary>
        ///Last four of the card
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")]
        public virtual string LastFour { get; set; }

        ///<summary>
        ///Expiration Date of the Card. (MM/YY)
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="query")]
        public virtual string Expiration { get; set; }

        ///<summary>
        ///Reason the card is on file.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")]
        public virtual string ReasonOnFile { get; set; }

        ///<summary>
        ///ID of the existing Token Record in AIM, if applicable
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="ID of the existing Token Record in AIM, if applicable", Format="int64", Name="TokenPk", ParameterType="query")]
        public virtual long? TokenPk { get; set; }

        ///<summary>
        ///Is this the customer's primary card? Defaults to false.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="boolean", Description="Is this the customer's primary card? Defaults to false.", Name="Primary", ParameterType="query")]
        public virtual bool? Primary { get; set; }
    }

    [DataContract]
    public partial class ContractCalculatedFields
    {
        public ContractCalculatedFields()
        {
            RentDueInfo = new List<ContractValuesObject>{};
            PayoffInfo = new List<ContractValuesObject>{};
        }

        [DataMember]
        public virtual int Terms { get; set; }

        [DataMember]
        public virtual int PayStream { get; set; }

        [DataMember]
        public virtual decimal FinalPay { get; set; }

        [DataMember]
        public virtual decimal AmountDue { get; set; }

        [DataMember]
        public virtual decimal Payoff { get; set; }

        [DataMember]
        public virtual decimal DiscountedPayoff { get; set; }

        [DataMember]
        public virtual decimal RebateFc { get; set; }

        [DataMember]
        public virtual decimal TotalLate { get; set; }

        [DataMember]
        public virtual decimal PaymentsLate { get; set; }

        [DataMember]
        public virtual int PaymentsAhead { get; set; }

        [DataMember]
        public virtual decimal TotalMaintOwed { get; set; }

        [DataMember]
        public virtual decimal CurrentPlusNext { get; set; }

        [DataMember]
        public virtual DateTime PayoffDate { get; set; }

        [DataMember]
        public virtual decimal CreditAmount { get; set; }

        [DataMember]
        public virtual decimal PrinLessTax { get; set; }

        [DataMember]
        public virtual decimal MaintLessTax { get; set; }

        [DataMember]
        public virtual decimal AFeeLessTax { get; set; }

        [DataMember]
        public virtual decimal PaymentTax { get; set; }

        [DataMember]
        public virtual List<ContractValuesObject> RentDueInfo { get; set; }

        [DataMember]
        public virtual List<ContractValuesObject> PayoffInfo { get; set; }

        [DataMember]
        public virtual string Notice { get; set; }

        [DataMember]
        public virtual string Notice2 { get; set; }
    }

    ///<summary>
    ///ContractFullDetailsRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class ContractFullDetailsRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int? Acct { get; set; }

        [DataMember]
        public virtual int? Sub { get; set; }

        [DataMember]
        public virtual DateTime? ChangedDate { get; set; }

        [DataMember]
        public virtual string SerialNumber { get; set; }

        ///<summary>
        ///If sent, additional calculated fields will be returned using this date
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="If sent, additional calculated fields will be returned using this date", Format="date", Name="CalculationsDate", ParameterType="query")]
        public virtual DateTime? CalculationsDate { get; set; }

        ///<summary>
        ///The Starting Offset
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The Starting Offset", Format="int64", Name="StartOffset")]
        public virtual long? StartOffset { get; set; }

        ///<summary>
        ///The # of records to be returned
        ///</summary>
        [DataMember]
        [ApiMember(DataType="integer", Description="The # of records to be returned", Format="int64", Name="RecordCount")]
        public virtual long? RecordCount { get; set; }

        ///<summary>
        ///The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
        ///</summary>
        [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")]
        public virtual string AIMRef { get; set; }

        ///<summary>
        ///The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
        ///</summary>
        [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")]
        public virtual string WebRef { get; set; }
    }

    [DataContract]
    public partial class ContractFullDetailsResponse
        : BaseResponse
    {
        public ContractFullDetailsResponse()
        {
            Contracts = new List<ContractInfo>{};
        }

        [DataMember]
        public virtual List<ContractInfo> Contracts { get; set; }

        [DataMember]
        public virtual long RemainingRecords { get; set; }
    }

    [DataContract]
    public partial class ContractInfo
    {
        public ContractInfo()
        {
            Inventory = new List<ContractInventoryInfo>{};
            Payments = new List<PaymentGeneric>{};
        }

        [DataMember]
        public virtual decimal Rnt_afee { get; set; }

        [DataMember]
        public virtual bool Rnt_alatedbt { get; set; }

        [DataMember]
        public virtual decimal Rnt_amtfin { get; set; }

        [DataMember]
        public virtual decimal Rnt_aofinchg { get; set; }

        [DataMember]
        public virtual bool Rnt_apaydbt { get; set; }

        [DataMember]
        public virtual string Rnt_apaytyp { get; set; }

        [DataMember]
        public virtual short Rnt_atcode { get; set; }

        [DataMember]
        public virtual DateTime Rnt_autopayhold { get; set; }

        [DataMember]
        public virtual decimal Rnt_avgbal { get; set; }

        [DataMember]
        public virtual decimal Rnt_balance { get; set; }

        [DataMember]
        public virtual short Rnt_billdays { get; set; }

        [DataMember]
        public virtual DateTime Rnt_cdate { get; set; }

        [DataMember]
        public virtual string Rnt_colagency { get; set; }

        [DataMember]
        public virtual decimal Rnt_colamt { get; set; }

        [DataMember]
        public virtual DateTime Rnt_coupdate { get; set; }

        [DataMember]
        public virtual decimal Rnt_cramt { get; set; }

        [DataMember]
        public virtual short Rnt_crmo { get; set; }

        [DataMember]
        public virtual decimal Rnt_currafee { get; set; }

        [DataMember]
        public virtual decimal Rnt_currbal { get; set; }

        [DataMember]
        public virtual decimal Rnt_currfc { get; set; }

        [DataMember]
        public virtual decimal Rnt_currfeetax1 { get; set; }

        [DataMember]
        public virtual decimal Rnt_currfeetax2 { get; set; }

        [DataMember]
        public virtual decimal Rnt_currlte { get; set; }

        [DataMember]
        public virtual decimal Rnt_currma { get; set; }

        [DataMember]
        public virtual decimal Rnt_curroth { get; set; }

        [DataMember]
        public virtual decimal Rnt_currprn { get; set; }

        [DataMember]
        public virtual decimal Rnt_currtax1 { get; set; }

        [DataMember]
        public virtual decimal Rnt_currtax2 { get; set; }

        [DataMember]
        public virtual short Rnt_dayslate { get; set; }

        [DataMember]
        public virtual short Rnt_daystlst { get; set; }

        [DataMember]
        public virtual string Rnt_deprcode { get; set; }

        [DataMember]
        public virtual decimal Rnt_discount { get; set; }

        [DataMember]
        public virtual decimal Rnt_downpay { get; set; }

        [DataMember]
        public virtual string Rnt_dunn { get; set; }

        [DataMember]
        public virtual DateTime Rnt_edate { get; set; }

        [DataMember]
        public virtual DateTime Rnt_fdate { get; set; }

        [DataMember]
        public virtual decimal Rnt_fee { get; set; }

        [DataMember]
        public virtual decimal Rnt_finalpay { get; set; }

        [DataMember]
        public virtual decimal Rnt_finchg { get; set; }

        [DataMember]
        public virtual short Rnt_freemos { get; set; }

        [DataMember]
        public virtual DateTime Rnt_intdate { get; set; }

        [DataMember]
        public virtual decimal Rnt_intrate { get; set; }

        [DataMember]
        public virtual bool Rnt_irregular { get; set; }

        [DataMember]
        public virtual short Rnt_itcode { get; set; }

        [DataMember]
        public virtual decimal Rnt_lastpaid { get; set; }

        [DataMember]
        public virtual decimal Rnt_latefee { get; set; }

        [DataMember]
        public virtual decimal Rnt_lateowed { get; set; }

        [DataMember]
        public virtual DateTime Rnt_ldate { get; set; }

        [DataMember]
        public virtual short Rnt_ltcode { get; set; }

        [DataMember]
        public virtual decimal Rnt_monma { get; set; }

        [DataMember]
        public virtual bool Rnt_mopayreq { get; set; }

        [DataMember]
        public virtual short Rnt_mtcode { get; set; }

        [DataMember]
        public virtual DateTime Rnt_ndate { get; set; }

        [DataMember]
        public virtual decimal Rnt_nextpayamt { get; set; }

        [DataMember]
        public virtual short Rnt_nextpaynum { get; set; }

        [DataMember]
        public virtual DateTime Rnt_notedate { get; set; }

        [DataMember]
        public virtual string Rnt_notes { get; set; }

        [DataMember]
        public virtual string Rnt_exchnotes { get; set; }

        [DataMember]
        public virtual decimal Rnt_otherowed { get; set; }

        [DataMember]
        public virtual short Rnt_payfreq { get; set; }

        [DataMember]
        public virtual short Rnt_latefreq { get; set; }

        [DataMember]
        public virtual short Rnt_payfreqtype { get; set; }

        [DataMember]
        public virtual decimal Rnt_payment { get; set; }

        [DataMember]
        public virtual short Rnt_paystrm { get; set; }

        [DataMember]
        public virtual long Rnt_pk { get; set; }

        [DataMember]
        public virtual decimal Rnt_prevamt { get; set; }

        [DataMember]
        public virtual short Rnt_prevmo { get; set; }

        [DataMember]
        public virtual decimal Rnt_price { get; set; }

        [DataMember]
        public virtual DateTime Rnt_rdate { get; set; }

        [DataMember]
        public virtual DateTime Rnt_sdate { get; set; }

        [DataMember]
        public virtual string Rnt_student { get; set; }

        [DataMember]
        public virtual int Rnt_sub { get; set; }

        [DataMember]
        public virtual decimal Rnt_tax { get; set; }

        [DataMember]
        public virtual decimal Rnt_taxrate1 { get; set; }

        [DataMember]
        public virtual decimal Rnt_taxrate2 { get; set; }

        [DataMember]
        public virtual decimal Rnt_taxrateorig1 { get; set; }

        [DataMember]
        public virtual decimal Rnt_taxrateorig2 { get; set; }

        [DataMember]
        public virtual short Rnt_tcode { get; set; }

        [DataMember]
        public virtual short Rnt_term { get; set; }

        [DataMember]
        public virtual decimal Rnt_tmaint { get; set; }

        [DataMember]
        public virtual decimal Rnt_tradein { get; set; }

        [DataMember]
        public virtual string Rnt_typer { get; set; }

        [DataMember]
        public virtual DateTime Rnt_timestamp { get; set; }

        [DataMember]
        public virtual int Acct { get; set; }

        [DataMember]
        public virtual string TaxLocation { get; set; }

        [DataMember]
        public virtual string DefaultDesc { get; set; }

        [DataMember]
        public virtual string PayoffDesc { get; set; }

        [DataMember]
        public virtual string School { get; set; }

        [DataMember]
        public virtual string District { get; set; }

        [DataMember]
        public virtual string Ref { get; set; }

        [DataMember]
        public virtual bool AutoPayDeclined { get; set; }

        [DataMember]
        public virtual List<ContractInventoryInfo> Inventory { get; set; }

        [DataMember]
        public virtual CcInfo CardInfo { get; set; }

        [DataMember]
        public virtual ContractCalculatedFields ContractCalculatedFields { get; set; }

        [DataMember]
        public virtual List<PaymentGeneric> Payments { get; set; }

        [DataMember]
        public virtual string Rnt_avacodeprin { get; set; }

        [DataMember]
        public virtual string Rnt_avacodemaint { get; set; }

        [DataMember]
        public virtual string Rnt_avacodelate { get; set; }

        [DataMember]
        public virtual string Rnt_avacodelease { get; set; }

        [DataMember]
        public virtual string Rnt_avacodefin { get; set; }

        [DataMember]
        public virtual DateTime Rnt_scheduledreturndate { get; set; }

        [DataMember]
        public virtual string Rnt_scheduledreturnoption { get; set; }

        [DataMember]
        public virtual string Rnt_scheduledreturnnotes { get; set; }

        [DataMember]
        public virtual string Rnt_scheduledreturnstatus { get; set; }
    }

    [DataContract]
    public partial class ContractInventoryInfo
    {
        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual DateTime BeginDate { get; set; }

        [DataMember]
        public virtual int Cat { get; set; }

        [DataMember]
        public virtual decimal? Cost { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual decimal Discount { get; set; }

        [DataMember]
        public virtual string Dunn { get; set; }

        [DataMember]
        public virtual DateTime EndDate { get; set; }

        [DataMember]
        public virtual string InvType { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual decimal OurPrice { get; set; }

        [DataMember]
        public virtual decimal Qty { get; set; }

        [DataMember]
        public virtual string ReceiptNotes { get; set; }

        [DataMember]
        public virtual string Serial { get; set; }

        [DataMember]
        public virtual int Sub { get; set; }

        [DataMember]
        public virtual decimal Total { get; set; }

        [DataMember]
        public virtual string Sku { get; set; }

        [DataMember]
        public virtual string Mfg { get; set; }
    }

}

C# 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"}}