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

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class PaymentGeneric
            <DataMember>
            Public Overridable Property [Date] As Date

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property Ref As String
        End Class
    End Namespace

    Namespace AIM.BL.Core.Global

        <DataContract>
        Public Partial Class ContractValuesObject
            <DataMember>
            Public Overridable Property Position As Integer

            <DataMember>
            Public Overridable Property Display As String

            <DataMember>
            Public Overridable Property Value As Decimal
        End Class
    End Namespace

    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 Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <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 Overridable Property TokenStr As String

            '''<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 Overridable Property CardType As String

            '''<Summary>
            '''Last four of the card
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Last four of the card", IsRequired:=true, Name:="LastFour", ParameterType:="query")>
            Public Overridable Property LastFour As String

            '''<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 Overridable Property Expiration As String

            '''<Summary>
            '''Reason the card is on file.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Reason the card is on file.", Name:="ReasonOnFile", ParameterType:="query")>
            Public Overridable Property ReasonOnFile As String

            '''<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 Overridable Property TokenPk As Nullable(Of Long)

            '''<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 Overridable Property Primary As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class ContractCalculatedFields
            Public Sub New()
                RentDueInfo = New List(Of ContractValuesObject)
                PayoffInfo = New List(Of ContractValuesObject)
            End Sub

            <DataMember>
            Public Overridable Property Terms As Integer

            <DataMember>
            Public Overridable Property PayStream As Integer

            <DataMember>
            Public Overridable Property FinalPay As Decimal

            <DataMember>
            Public Overridable Property AmountDue As Decimal

            <DataMember>
            Public Overridable Property Payoff As Decimal

            <DataMember>
            Public Overridable Property DiscountedPayoff As Decimal

            <DataMember>
            Public Overridable Property RebateFc As Decimal

            <DataMember>
            Public Overridable Property TotalLate As Decimal

            <DataMember>
            Public Overridable Property PaymentsLate As Decimal

            <DataMember>
            Public Overridable Property PaymentsAhead As Integer

            <DataMember>
            Public Overridable Property TotalMaintOwed As Decimal

            <DataMember>
            Public Overridable Property CurrentPlusNext As Decimal

            <DataMember>
            Public Overridable Property PayoffDate As Date

            <DataMember>
            Public Overridable Property CreditAmount As Decimal

            <DataMember>
            Public Overridable Property PrinLessTax As Decimal

            <DataMember>
            Public Overridable Property MaintLessTax As Decimal

            <DataMember>
            Public Overridable Property AFeeLessTax As Decimal

            <DataMember>
            Public Overridable Property PaymentTax As Decimal

            <DataMember>
            Public Overridable Property RentDueInfo As List(Of ContractValuesObject)

            <DataMember>
            Public Overridable Property PayoffInfo As List(Of ContractValuesObject)

            <DataMember>
            Public Overridable Property Notice As String

            <DataMember>
            Public Overridable Property Notice2 As String
        End Class

        '''<Summary>
        '''ContractFullDetailsRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class ContractFullDetailsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Acct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property Sub As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property ChangedDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property SerialNumber As String

            '''<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 Overridable Property CalculationsDate As Nullable(Of Date)

            '''<Summary>
            '''The Starting Offset
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The Starting Offset", Format:="int64", Name:="StartOffset")>
            Public Overridable Property StartOffset As Nullable(Of Long)

            '''<Summary>
            '''The # of records to be returned
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The # of records to be returned", Format:="int64", Name:="RecordCount")>
            Public Overridable Property RecordCount As Nullable(Of Long)

            '''<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 Overridable Property AIMRef As String

            '''<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 Overridable Property WebRef As String
        End Class

        <DataContract>
        Public Partial Class ContractFullDetailsResponse
            Inherits BaseResponse
            Public Sub New()
                Contracts = New List(Of ContractInfo)
            End Sub

            <DataMember>
            Public Overridable Property Contracts As List(Of ContractInfo)

            <DataMember>
            Public Overridable Property RemainingRecords As Long
        End Class

        <DataContract>
        Public Partial Class ContractInfo
            Public Sub New()
                Inventory = New List(Of ContractInventoryInfo)
                Payments = New List(Of PaymentGeneric)
            End Sub

            <DataMember>
            Public Overridable Property Rnt_afee As Decimal

            <DataMember>
            Public Overridable Property Rnt_alatedbt As Boolean

            <DataMember>
            Public Overridable Property Rnt_amtfin As Decimal

            <DataMember>
            Public Overridable Property Rnt_aofinchg As Decimal

            <DataMember>
            Public Overridable Property Rnt_apaydbt As Boolean

            <DataMember>
            Public Overridable Property Rnt_apaytyp As String

            <DataMember>
            Public Overridable Property Rnt_atcode As Short

            <DataMember>
            Public Overridable Property Rnt_autopayhold As Date

            <DataMember>
            Public Overridable Property Rnt_avgbal As Decimal

            <DataMember>
            Public Overridable Property Rnt_balance As Decimal

            <DataMember>
            Public Overridable Property Rnt_billdays As Short

            <DataMember>
            Public Overridable Property Rnt_cdate As Date

            <DataMember>
            Public Overridable Property Rnt_colagency As String

            <DataMember>
            Public Overridable Property Rnt_colamt As Decimal

            <DataMember>
            Public Overridable Property Rnt_coupdate As Date

            <DataMember>
            Public Overridable Property Rnt_cramt As Decimal

            <DataMember>
            Public Overridable Property Rnt_crmo As Short

            <DataMember>
            Public Overridable Property Rnt_currafee As Decimal

            <DataMember>
            Public Overridable Property Rnt_currbal As Decimal

            <DataMember>
            Public Overridable Property Rnt_currfc As Decimal

            <DataMember>
            Public Overridable Property Rnt_currfeetax1 As Decimal

            <DataMember>
            Public Overridable Property Rnt_currfeetax2 As Decimal

            <DataMember>
            Public Overridable Property Rnt_currlte As Decimal

            <DataMember>
            Public Overridable Property Rnt_currma As Decimal

            <DataMember>
            Public Overridable Property Rnt_curroth As Decimal

            <DataMember>
            Public Overridable Property Rnt_currprn As Decimal

            <DataMember>
            Public Overridable Property Rnt_currtax1 As Decimal

            <DataMember>
            Public Overridable Property Rnt_currtax2 As Decimal

            <DataMember>
            Public Overridable Property Rnt_dayslate As Short

            <DataMember>
            Public Overridable Property Rnt_daystlst As Short

            <DataMember>
            Public Overridable Property Rnt_deprcode As String

            <DataMember>
            Public Overridable Property Rnt_discount As Decimal

            <DataMember>
            Public Overridable Property Rnt_downpay As Decimal

            <DataMember>
            Public Overridable Property Rnt_dunn As String

            <DataMember>
            Public Overridable Property Rnt_edate As Date

            <DataMember>
            Public Overridable Property Rnt_fdate As Date

            <DataMember>
            Public Overridable Property Rnt_fee As Decimal

            <DataMember>
            Public Overridable Property Rnt_finalpay As Decimal

            <DataMember>
            Public Overridable Property Rnt_finchg As Decimal

            <DataMember>
            Public Overridable Property Rnt_freemos As Short

            <DataMember>
            Public Overridable Property Rnt_intdate As Date

            <DataMember>
            Public Overridable Property Rnt_intrate As Decimal

            <DataMember>
            Public Overridable Property Rnt_irregular As Boolean

            <DataMember>
            Public Overridable Property Rnt_itcode As Short

            <DataMember>
            Public Overridable Property Rnt_lastpaid As Decimal

            <DataMember>
            Public Overridable Property Rnt_latefee As Decimal

            <DataMember>
            Public Overridable Property Rnt_lateowed As Decimal

            <DataMember>
            Public Overridable Property Rnt_ldate As Date

            <DataMember>
            Public Overridable Property Rnt_ltcode As Short

            <DataMember>
            Public Overridable Property Rnt_monma As Decimal

            <DataMember>
            Public Overridable Property Rnt_mopayreq As Boolean

            <DataMember>
            Public Overridable Property Rnt_mtcode As Short

            <DataMember>
            Public Overridable Property Rnt_ndate As Date

            <DataMember>
            Public Overridable Property Rnt_nextpayamt As Decimal

            <DataMember>
            Public Overridable Property Rnt_nextpaynum As Short

            <DataMember>
            Public Overridable Property Rnt_notedate As Date

            <DataMember>
            Public Overridable Property Rnt_notes As String

            <DataMember>
            Public Overridable Property Rnt_exchnotes As String

            <DataMember>
            Public Overridable Property Rnt_otherowed As Decimal

            <DataMember>
            Public Overridable Property Rnt_payfreq As Short

            <DataMember>
            Public Overridable Property Rnt_latefreq As Short

            <DataMember>
            Public Overridable Property Rnt_payfreqtype As Short

            <DataMember>
            Public Overridable Property Rnt_payment As Decimal

            <DataMember>
            Public Overridable Property Rnt_paystrm As Short

            <DataMember>
            Public Overridable Property Rnt_pk As Long

            <DataMember>
            Public Overridable Property Rnt_prevamt As Decimal

            <DataMember>
            Public Overridable Property Rnt_prevmo As Short

            <DataMember>
            Public Overridable Property Rnt_price As Decimal

            <DataMember>
            Public Overridable Property Rnt_rdate As Date

            <DataMember>
            Public Overridable Property Rnt_sdate As Date

            <DataMember>
            Public Overridable Property Rnt_student As String

            <DataMember>
            Public Overridable Property Rnt_sub As Integer

            <DataMember>
            Public Overridable Property Rnt_tax As Decimal

            <DataMember>
            Public Overridable Property Rnt_taxrate1 As Decimal

            <DataMember>
            Public Overridable Property Rnt_taxrate2 As Decimal

            <DataMember>
            Public Overridable Property Rnt_taxrateorig1 As Decimal

            <DataMember>
            Public Overridable Property Rnt_taxrateorig2 As Decimal

            <DataMember>
            Public Overridable Property Rnt_tcode As Short

            <DataMember>
            Public Overridable Property Rnt_term As Short

            <DataMember>
            Public Overridable Property Rnt_tmaint As Decimal

            <DataMember>
            Public Overridable Property Rnt_tradein As Decimal

            <DataMember>
            Public Overridable Property Rnt_typer As String

            <DataMember>
            Public Overridable Property Rnt_timestamp As Date

            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property TaxLocation As String

            <DataMember>
            Public Overridable Property DefaultDesc As String

            <DataMember>
            Public Overridable Property PayoffDesc As String

            <DataMember>
            Public Overridable Property School As String

            <DataMember>
            Public Overridable Property District As String

            <DataMember>
            Public Overridable Property Ref As String

            <DataMember>
            Public Overridable Property AutoPayDeclined As Boolean

            <DataMember>
            Public Overridable Property Inventory As List(Of ContractInventoryInfo)

            <DataMember>
            Public Overridable Property CardInfo As CcInfo

            <DataMember>
            Public Overridable Property ContractCalculatedFields As ContractCalculatedFields

            <DataMember>
            Public Overridable Property Payments As List(Of PaymentGeneric)

            <DataMember>
            Public Overridable Property Rnt_avacodeprin As String

            <DataMember>
            Public Overridable Property Rnt_avacodemaint As String

            <DataMember>
            Public Overridable Property Rnt_avacodelate As String

            <DataMember>
            Public Overridable Property Rnt_avacodelease As String

            <DataMember>
            Public Overridable Property Rnt_avacodefin As String

            <DataMember>
            Public Overridable Property Rnt_scheduledreturndate As Date

            <DataMember>
            Public Overridable Property Rnt_scheduledreturnoption As String

            <DataMember>
            Public Overridable Property Rnt_scheduledreturnnotes As String

            <DataMember>
            Public Overridable Property Rnt_scheduledreturnstatus As String
        End Class

        <DataContract>
        Public Partial Class ContractInventoryInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property BeginDate As Date

            <DataMember>
            Public Overridable Property Cat As Integer

            <DataMember>
            Public Overridable Property Cost As Nullable(Of Decimal)

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Discount As Decimal

            <DataMember>
            Public Overridable Property Dunn As String

            <DataMember>
            Public Overridable Property EndDate As Date

            <DataMember>
            Public Overridable Property InvType As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property OurPrice As Decimal

            <DataMember>
            Public Overridable Property Qty As Decimal

            <DataMember>
            Public Overridable Property ReceiptNotes As String

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property Sub As Integer

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Mfg As String
        End Class
    End Namespace
End Namespace

VB.NET ContractFullDetailsRequest 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/ContractFullDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}