' Options:
'Date: 2025-08-04 00:03:57
'Version: 8.40
'Tip: To override a DTO option, remove "''" prefix before updating
'BaseUrl: https://active-ewebservice.biz/aeServices30/api
'
'''GlobalNamespace: 
'''MakePartial: True
'''MakeVirtual: True
'''MakeDataContractsExtensible: False
'''AddReturnMarker: True
'''AddDescriptionAsComments: True
'''AddDataContractAttributes: False
'''AddIndexesToDataMembers: False
'''AddGeneratedCodeAttributes: False
'''AddResponseStatus: False
'''AddImplicitVersion: 
'''InitializeCollections: True
'''ExportValueTypes: False
'IncludeTypes: C2BPostContractRequest.*
'''ExcludeTypes: 
'''AddNamespaces: 
'''AddDefaultXmlNamespace: http://schemas.servicestack.net/types

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract(Name:="Accessory")>
        Public Partial Class Accessory
            '''<Summary>
            '''The description to be used for the Accessory
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The description to be used for the Accessory", IsRequired:=true, Name:="Desc", ParameterType:="body")>
            Public Overridable Property Desc As String

            '''<Summary>
            '''The price to be used for the Accessory
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="The price to be used for the Accessory", Name:="Price", ParameterType:="body")>
            Public Overridable Property Price As Decimal

            '''<Summary>
            '''The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance", Name:="Type", ParameterType:="body")>
            Public Overridable Property Type As String

            '''<Summary>
            '''The category # in AIM to be linked to this accessory.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="The category # in AIM to be linked to this accessory.", Name:="CatNum", ParameterType:="body")>
            Public Overridable Property CatNum As Integer

            '''<Summary>
            '''A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.", Name:="Sku", ParameterType:="body")>
            Public Overridable Property Sku As String

            '''<Summary>
            '''Internal Use Only
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="bool", Description:="Internal Use Only", Name:="Report", ParameterType:="body")>
            Public Overridable Property Report As Nullable(Of Boolean)
        End Class

        <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

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId 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
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        '''<Summary>
        '''C2BPostContractRequires active-e Contracts Service.
        '''</Summary>
        <Route("/C2BPostContract", "POST, GET")>
        <DataContract>
        Public Partial Class C2BPostContractRequest
            Inherits BaseSecureRequest
            Implements IReturn(Of C2BPostContractResponse)
            Public Sub New()
                AccessoryIdList = New List(Of Long)
                AccessoryList = New List(Of Accessory)
                FormInputList = New List(Of FormInput)
            End Sub

            '''<Summary>
            '''ID of the teacher to associate the contract with.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="ID of the teacher to associate the contract with.", Format:="int64", Name:="TeacherId", ParameterType:="body")>
            Public Overridable Property TeacherId As Nullable(Of Long)

            '''<Summary>
            '''Used to associate the contract with a school by school name.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Used to associate the contract with a school by school name.", Name:="SchoolName", ParameterType:="body")>
            Public Overridable Property SchoolName As String

            '''<Summary>
            '''Used to associate the contract with a school by the AIM School ID
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Used to associate the contract with a school by the AIM School ID", Name:="AIMSchoolId", ParameterType:="body")>
            Public Overridable Property AIMSchoolId As Nullable(Of Long)

            '''<Summary>
            '''Used to associate the contract with a location by location code.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Used to associate the contract with a location by location code.", Name:="Stloc", ParameterType:="body")>
            Public Overridable Property Stloc As String

            '''<Summary>
            '''ID of the instrument to associate the contract with.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="ID of the instrument to associate the contract with.", Format:="int64", Name:="InstrumentId", ParameterType:="body")>
            Public Overridable Property InstrumentId As Nullable(Of Long)

            '''<Summary>
            '''SKU to associate the contract with. Don't send if you send InstrumentId.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="SKU to associate the contract with. Don't send if you send InstrumentId.", Name:="Sku", ParameterType:="body")>
            Public Overridable Property Sku As String

            '''<Summary>
            '''Description to associate the contract with if a SKU is sent. Don't send if you send InstrumentId.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Description to associate the contract with if a SKU is sent. Don't send if you send InstrumentId.", Name:="Desc", ParameterType:="body")>
            Public Overridable Property Desc As String

            '''<Summary>
            '''The ID from the C2BGradeGeneric object
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The ID from the C2BGradeGeneric object", Format:="int64", Name:="RateId", ParameterType:="body")>
            Public Overridable Property RateId As Nullable(Of Long)

            '''<Summary>
            '''Rate object if you're not sending RateId. Don't send both.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="object", Description:="Rate object if you're not sending RateId. Don't send both.", Name:="Rate", ParameterType:="body")>
            Public Overridable Property Rate As Rate

            '''<Summary>
            '''List of Accessory/Delivery/Maintenance IDs.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="List of Accessory/Delivery/Maintenance IDs.", Name:="AccessoryIdList", ParameterType:="body")>
            Public Overridable Property AccessoryIdList As List(Of Long)

            '''<Summary>
            '''List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM.", Name:="AccessoryList", ParameterType:="body")>
            Public Overridable Property AccessoryList As List(Of Accessory)

            '''<Summary>
            '''List of Key/Value pairs containing additional information about the customer. If the Key matches an attribute tag within AIM it will populate that attribute. The following Keys are also handled specially: RENTALNOTES, ONLINESIGNATURE, ATTENTION, EMPLOYER, SOCIALSECURITY, WORKPHONE, EXTENSION, EXTENSION2, CELLPHONE, FAX, BANKROUTINGNUMBER, BANKACCOUNTNUMBER, BANKTRANSACTIONTYPE, DRIVERSLICENSENUMBER, DRIVERSLICENSESTATE, BIRTHDAY, SIGCAPTURE, WORKPHONE_EXT, CELLPHONE_EXT, FAX_EXT, CREDITCHECKNAMEOVERRIDE, DELIVERYDATE
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="array", Description:="List of Key/Value pairs containing additional information about the customer. If the Key matches an attribute tag within AIM it will populate that attribute. The following Keys are also handled specially: RENTALNOTES, ONLINESIGNATURE, ATTENTION, EMPLOYER, SOCIALSECURITY, WORKPHONE, EXTENSION, EXTENSION2, CELLPHONE, FAX, BANKROUTINGNUMBER, BANKACCOUNTNUMBER, BANKTRANSACTIONTYPE, DRIVERSLICENSENUMBER, DRIVERSLICENSESTATE, BIRTHDAY, SIGCAPTURE, WORKPHONE_EXT, CELLPHONE_EXT, FAX_EXT, CREDITCHECKNAMEOVERRIDE, DELIVERYDATE", Name:="FormInputList", ParameterType:="body")>
            Public Overridable Property FormInputList As List(Of FormInput)

            '''<Summary>
            '''Credit Card Information
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="object", Description:="Credit Card Information", Name:="CcInfo", ParameterType:="body")>
            Public Overridable Property CcInfo As CcInfo

            '''<Summary>
            '''Customer Information if the a CusAcct is not being passed in.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="object", Description:="Customer Information if the a CusAcct is not being passed in.", Name:="CustomerInfo", ParameterType:="body")>
            Public Overridable Property CustomerInfo As CustomerInfo

            '''<Summary>
            '''AIM Customer Acct# to be linked to this contract. Do not pass in CustomerInfo if using CusAcct.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="AIM Customer Acct# to be linked to this contract. Do not pass in CustomerInfo if using CusAcct.", Format:="int32", Name:="CusAcct", ParameterType:="body")>
            Public Overridable Property CusAcct As Nullable(Of Integer)

            '''<Summary>
            '''Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.", Name:="Cat", ParameterType:="body")>
            Public Overridable Property Cat As Nullable(Of Integer)

            '''<Summary>
            '''Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.", Name:="Sub", ParameterType:="body")>
            Public Overridable Property Sub As Nullable(Of Integer)

            '''<Summary>
            '''If TRUE is sent, a Topic will be returned with information from AIM. Usually not used.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="bool", Description:="If TRUE is sent, a Topic will be returned with information from AIM. Usually not used.", Name:="ReturnTopic", ParameterType:="body")>
            Public Overridable Property ReturnTopic As Nullable(Of Boolean)

            '''<Summary>
            '''If sent, the Contract will have the specified status in AIM upon creation. Use ContractStatusListing to get the desired Id. Usually not used.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="If sent, the Contract will have the specified status in AIM upon creation. Use ContractStatusListing to get the desired Id. Usually not used.", Name:="StatusId", ParameterType:="body")>
            Public Overridable Property StatusId As Nullable(Of Long)

            '''<Summary>
            '''Internal Use Only. Do not use.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Internal Use Only. Do not use.", Name:="CardTerminalId", ParameterType:="body")>
            Public Overridable Property CardTerminalId As String
        End Class

        <DataContract>
        Public Partial Class C2BPostContractResponse
            Inherits BaseResponse
            <DataMember>
            Public Overridable Property PaymentRequired As Boolean

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property WebRef As String

            <DataMember>
            Public Overridable Property BaseUrl 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:="body")>
            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:="body")>
            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:="body")>
            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:="body")>
            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:="body")>
            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:="body")>
            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:="body")>
            Public Overridable Property Primary As Nullable(Of Boolean)
        End Class

        <DataContract(Name:="CustomerInfo")>
        Public Partial Class CustomerInfo
            '''<Summary>
            '''The WebId of the customer. Optional.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The WebId of the customer. Optional.", Format:="int32", Name:="WebId", ParameterType:="body")>
            Public Overridable Property WebId As Nullable(Of Integer)

            '''<Summary>
            '''Name of the customer.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Name of the customer.", IsRequired:=true, Name:="Name", ParameterType:="body")>
            Public Overridable Property Name As String

            '''<Summary>
            '''Address line 1 of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Address line 1 of the customer", Name:="Addr1", ParameterType:="body")>
            Public Overridable Property Addr1 As String

            '''<Summary>
            '''Address line 2 of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Address line 2 of the customer", Name:="Addr2", ParameterType:="body")>
            Public Overridable Property Addr2 As String

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

            '''<Summary>
            '''State/Province of the customer
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="State/Province of the customer", Name:="St", ParameterType:="body")>
            Public Overridable Property St As String

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

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

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

            '''<Summary>
            '''Email address of the customer. Required.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Email address of the customer. Required.", IsRequired:=true, Name:="Email", ParameterType:="body")>
            Public Overridable Property Email As String
        End Class

        <DataContract(Name:="FormInput")>
        Public Partial Class FormInput
            '''<Summary>
            '''Field name of the Input Field. If linking to an Attribute, this should match the Tag value.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Field name of the Input Field. If linking to an Attribute, this should match the Tag value.", IsRequired:=true, Name:="Key", ParameterType:="body")>
            Public Overridable Property Key As String

            '''<Summary>
            '''Value of the Input Field.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Value of the Input Field.", IsRequired:=true, Name:="Value", ParameterType:="body")>
            Public Overridable Property Value As String

            '''<Summary>
            '''Whether or not the field is encryped with the C2B encryption key.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="Whether or not the field is encryped with the C2B encryption key.", Name:="Encrypted", ParameterType:="body")>
            Public Overridable Property Encrypted As Boolean
        End Class

        <DataContract(Name:="Rate")>
        Public Partial Class Rate
            '''<Summary>
            '''Plan Code to be used for the contract
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Plan Code to be used for the contract", Name:="PlanCode", ParameterType:="body")>
            Public Overridable Property PlanCode As String

            '''<Summary>
            '''Level to be used for the contract
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="Level to be used for the contract", Name:="Level", ParameterType:="body")>
            Public Overridable Property Level As Nullable(Of Integer)

            '''<Summary>
            '''Grade to be used for the contract
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="Grade to be used for the contract", Name:="Grade", ParameterType:="body")>
            Public Overridable Property Grade As String

            '''<Summary>
            '''Down Payment to be collected. Does not include maintenance or lease fees.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Down Payment to be collected. Does not include maintenance or lease fees.", Name:="DownPay", ParameterType:="body")>
            Public Overridable Property DownPay As Nullable(Of Decimal)

            '''<Summary>
            '''Monthly amount to be collected for the contract. Does not include maintenance or lease fees.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Monthly amount to be collected for the contract. Does not include maintenance or lease fees.", Name:="MoPay", ParameterType:="body")>
            Public Overridable Property MoPay As Nullable(Of Decimal)

            '''<Summary>
            '''Down Payment to be collected for maintenance.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Down Payment to be collected for maintenance.", Name:="DownMaint", ParameterType:="body")>
            Public Overridable Property DownMaint As Nullable(Of Decimal)

            '''<Summary>
            '''Monthly amount to be collected for the maintenance.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Monthly amount to be collected for the maintenance.", Name:="MoMaint", ParameterType:="body")>
            Public Overridable Property MoMaint As Nullable(Of Decimal)

            '''<Summary>
            '''If sent, the first Contract Default with this rental type will be used. Not used if ContractDefaultId is sent. Valid values are EW: Extended Warranty, RO: Rent to Rent, RF: Rent to Own, SF: Sales Contract, RV: Simple Intrst: Rent, SV: Simple Intrst: Sales
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int64", Description:="If sent, the first Contract Default with this rental type will be used. Not used if ContractDefaultId is sent. Valid values are EW: Extended Warranty, RO: Rent to Rent, RF: Rent to Own, SF: Sales Contract, RV: Simple Intrst: Rent, SV: Simple Intrst: Sales", Name:="RdfType", ParameterType:="body")>
            Public Overridable Property RdfType As String

            '''<Summary>
            '''The ID of the contract default to be used for this contract.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int64", Description:="The ID of the contract default to be used for this contract.", Name:="ContractDefaultId", ParameterType:="body")>
            Public Overridable Property ContractDefaultId As Nullable(Of Long)

            '''<Summary>
            '''The Number of Months covered by the downpayment
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="int", Description:="The Number of Months covered by the downpayment", Name:="Months", ParameterType:="body")>
            Public Overridable Property Months As Nullable(Of Integer)

            '''<Summary>
            '''Down Payment to be collected for Lease Fees.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Down Payment to be collected for Lease Fees.", Name:="DownMaint", ParameterType:="body")>
            Public Overridable Property DownLease As Nullable(Of Decimal)

            '''<Summary>
            '''Monthly amount to be collected for lease fees.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="decimal", Description:="Monthly amount to be collected for lease fees.", Name:="MoLease", ParameterType:="body")>
            Public Overridable Property MoLease As Nullable(Of Decimal)
        End Class
    End Namespace
End Namespace