AIM Web Services

<back to all web services

C2BPostContractRequest

C2BPostContract
Requires active-e Contracts Service.

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

public class dtos
{

    /**
    * C2BPostContractRequires active-e Contracts Service.
    */
    @DataContract
    public static class C2BPostContractRequest extends BaseSecureRequest
    {
        /**
        * ID of the teacher to associate the contract with.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the teacher to associate the contract with.", Format="int64", Name="TeacherId", ParameterType="body")
        public Long TeacherId = null;

        /**
        * Used to associate the contract with a school by school name.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Used to associate the contract with a school by school name.", Name="SchoolName", ParameterType="body")
        public String SchoolName = null;

        /**
        * Used to associate the contract with a school by the AIM School ID
        */
        @DataMember
        @ApiMember(DataType="string", Description="Used to associate the contract with a school by the AIM School ID", Name="AIMSchoolId", ParameterType="body")
        public Long AIMSchoolId = null;

        /**
        * Used to associate the contract with a location by location code.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Used to associate the contract with a location by location code.", Name="Stloc", ParameterType="body")
        public String Stloc = null;

        /**
        * ID of the instrument to associate the contract with.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="ID of the instrument to associate the contract with.", Format="int64", Name="InstrumentId", ParameterType="body")
        public Long InstrumentId = null;

        /**
        * SKU to associate the contract with. Don't send if you send InstrumentId.
        */
        @DataMember
        @ApiMember(DataType="string", Description="SKU to associate the contract with. Don't send if you send InstrumentId.", Name="Sku", ParameterType="body")
        public String Sku = null;

        /**
        * Description to associate the contract with if a SKU is sent. Don't send if you send InstrumentId.
        */
        @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 String Desc = null;

        /**
        * The ID from the C2BGradeGeneric object
        */
        @DataMember
        @ApiMember(DataType="integer", Description="The ID from the C2BGradeGeneric object", Format="int64", Name="RateId", ParameterType="body")
        public Long RateId = null;

        /**
        * Rate object if you're not sending RateId. Don't send both.
        */
        @DataMember
        @ApiMember(DataType="object", Description="Rate object if you're not sending RateId. Don't send both.", Name="Rate", ParameterType="body")
        public Rate Rate = null;

        /**
        * List of Accessory/Delivery/Maintenance IDs.
        */
        @DataMember
        @ApiMember(DataType="array", Description="List of Accessory/Delivery/Maintenance IDs.", Name="AccessoryIdList", ParameterType="body")
        public ArrayList<Long> AccessoryIdList = null;

        /**
        * List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM.
        */
        @DataMember
        @ApiMember(DataType="array", Description="List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM.", Name="AccessoryList", ParameterType="body")
        public ArrayList<Accessory> AccessoryList = null;

        /**
        * 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
        */
        @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 ArrayList<FormInput> FormInputList = null;

        /**
        * Credit Card Information
        */
        @DataMember
        @ApiMember(DataType="object", Description="Credit Card Information", Name="CcInfo", ParameterType="body")
        public CcInfo CcInfo = null;

        /**
        * Customer Information if the a CusAcct is not being passed in.
        */
        @DataMember
        @ApiMember(DataType="object", Description="Customer Information if the a CusAcct is not being passed in.", Name="CustomerInfo", ParameterType="body")
        public CustomerInfo CustomerInfo = null;

        /**
        * AIM Customer Acct# to be linked to this contract. Do not pass in CustomerInfo if using CusAcct.
        */
        @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 Integer CusAcct = null;

        /**
        * Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
        */
        @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 Integer Cat = null;

        /**
        * Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
        */
        @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 Integer Sub = null;

        /**
        * If TRUE is sent, a Topic will be returned with information from AIM. Usually not used.
        */
        @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 Boolean ReturnTopic = null;

        /**
        * If sent, the Contract will have the specified status in AIM upon creation. Use ContractStatusListing to get the desired Id. Usually not used.
        */
        @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 Long StatusId = null;

        /**
        * Internal Use Only. Do not use.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Internal Use Only. Do not use.", Name="CardTerminalId", ParameterType="body")
        public String CardTerminalId = null;
        
        public Long getTeacherId() { return TeacherId; }
        public C2BPostContractRequest setTeacherId(Long value) { this.TeacherId = value; return this; }
        public String getSchoolName() { return SchoolName; }
        public C2BPostContractRequest setSchoolName(String value) { this.SchoolName = value; return this; }
        public Long getAimSchoolId() { return AIMSchoolId; }
        public C2BPostContractRequest setAimSchoolId(Long value) { this.AIMSchoolId = value; return this; }
        public String getStloc() { return Stloc; }
        public C2BPostContractRequest setStloc(String value) { this.Stloc = value; return this; }
        public Long getInstrumentId() { return InstrumentId; }
        public C2BPostContractRequest setInstrumentId(Long value) { this.InstrumentId = value; return this; }
        public String getSku() { return Sku; }
        public C2BPostContractRequest setSku(String value) { this.Sku = value; return this; }
        public String getDesc() { return Desc; }
        public C2BPostContractRequest setDesc(String value) { this.Desc = value; return this; }
        public Long getRateId() { return RateId; }
        public C2BPostContractRequest setRateId(Long value) { this.RateId = value; return this; }
        public Rate getRate() { return Rate; }
        public C2BPostContractRequest setRate(Rate value) { this.Rate = value; return this; }
        public ArrayList<Long> getAccessoryIdList() { return AccessoryIdList; }
        public C2BPostContractRequest setAccessoryIdList(ArrayList<Long> value) { this.AccessoryIdList = value; return this; }
        public ArrayList<Accessory> getAccessoryList() { return AccessoryList; }
        public C2BPostContractRequest setAccessoryList(ArrayList<Accessory> value) { this.AccessoryList = value; return this; }
        public ArrayList<FormInput> getFormInputList() { return FormInputList; }
        public C2BPostContractRequest setFormInputList(ArrayList<FormInput> value) { this.FormInputList = value; return this; }
        public CcInfo getCcInfo() { return CcInfo; }
        public C2BPostContractRequest setCcInfo(CcInfo value) { this.CcInfo = value; return this; }
        public CustomerInfo getCustomerInfo() { return CustomerInfo; }
        public C2BPostContractRequest setCustomerInfo(CustomerInfo value) { this.CustomerInfo = value; return this; }
        public Integer getCusAcct() { return CusAcct; }
        public C2BPostContractRequest setCusAcct(Integer value) { this.CusAcct = value; return this; }
        public Integer getCat() { return Cat; }
        public C2BPostContractRequest setCat(Integer value) { this.Cat = value; return this; }
        public Integer getSub() { return Sub; }
        public C2BPostContractRequest setSub(Integer value) { this.Sub = value; return this; }
        public Boolean isReturnTopic() { return ReturnTopic; }
        public C2BPostContractRequest setReturnTopic(Boolean value) { this.ReturnTopic = value; return this; }
        public Long getStatusId() { return StatusId; }
        public C2BPostContractRequest setStatusId(Long value) { this.StatusId = value; return this; }
        public String getCardTerminalId() { return CardTerminalId; }
        public C2BPostContractRequest setCardTerminalId(String value) { this.CardTerminalId = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * The Login Token return by the Security API. Required for secured calls.
        */
        @DataMember
        @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
        public String Token = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

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

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

        /**
        * An identifier for your integration
        */
        @DataMember
        @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract(Name="Rate")
    public static class Rate
    {
        /**
        * Plan Code to be used for the contract
        */
        @DataMember
        @ApiMember(DataType="string", Description="Plan Code to be used for the contract", Name="PlanCode", ParameterType="body")
        public String PlanCode = null;

        /**
        * Level to be used for the contract
        */
        @DataMember
        @ApiMember(DataType="int", Description="Level to be used for the contract", Name="Level", ParameterType="body")
        public Integer Level = null;

        /**
        * Grade to be used for the contract
        */
        @DataMember
        @ApiMember(DataType="string", Description="Grade to be used for the contract", Name="Grade", ParameterType="body")
        public String Grade = null;

        /**
        * Down Payment to be collected. Does not include maintenance or lease fees.
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="Down Payment to be collected. Does not include maintenance or lease fees.", Name="DownPay", ParameterType="body")
        public BigDecimal DownPay = null;

        /**
        * Monthly amount to be collected for the contract. Does not include maintenance or lease fees.
        */
        @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 BigDecimal MoPay = null;

        /**
        * Down Payment to be collected for maintenance.
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="Down Payment to be collected for maintenance.", Name="DownMaint", ParameterType="body")
        public BigDecimal DownMaint = null;

        /**
        * Monthly amount to be collected for the maintenance.
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="Monthly amount to be collected for the maintenance.", Name="MoMaint", ParameterType="body")
        public BigDecimal MoMaint = null;

        /**
        * 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
        */
        @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 String RdfType = null;

        /**
        * The ID of the contract default to be used for this contract.
        */
        @DataMember
        @ApiMember(DataType="int64", Description="The ID of the contract default to be used for this contract.", Name="ContractDefaultId", ParameterType="body")
        public Long ContractDefaultId = null;

        /**
        * The Number of Months covered by the downpayment
        */
        @DataMember
        @ApiMember(DataType="int", Description="The Number of Months covered by the downpayment", Name="Months", ParameterType="body")
        public Integer Months = null;

        /**
        * Down Payment to be collected for Lease Fees.
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="Down Payment to be collected for Lease Fees.", Name="DownMaint", ParameterType="body")
        public BigDecimal DownLease = null;

        /**
        * Monthly amount to be collected for lease fees.
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="Monthly amount to be collected for lease fees.", Name="MoLease", ParameterType="body")
        public BigDecimal MoLease = null;
        
        public String getPlanCode() { return PlanCode; }
        public Rate setPlanCode(String value) { this.PlanCode = value; return this; }
        public Integer getLevel() { return Level; }
        public Rate setLevel(Integer value) { this.Level = value; return this; }
        public String getGrade() { return Grade; }
        public Rate setGrade(String value) { this.Grade = value; return this; }
        public BigDecimal getDownPay() { return DownPay; }
        public Rate setDownPay(BigDecimal value) { this.DownPay = value; return this; }
        public BigDecimal getMoPay() { return MoPay; }
        public Rate setMoPay(BigDecimal value) { this.MoPay = value; return this; }
        public BigDecimal getDownMaint() { return DownMaint; }
        public Rate setDownMaint(BigDecimal value) { this.DownMaint = value; return this; }
        public BigDecimal getMoMaint() { return MoMaint; }
        public Rate setMoMaint(BigDecimal value) { this.MoMaint = value; return this; }
        public String getRdfType() { return RdfType; }
        public Rate setRdfType(String value) { this.RdfType = value; return this; }
        public Long getContractDefaultId() { return ContractDefaultId; }
        public Rate setContractDefaultId(Long value) { this.ContractDefaultId = value; return this; }
        public Integer getMonths() { return Months; }
        public Rate setMonths(Integer value) { this.Months = value; return this; }
        public BigDecimal getDownLease() { return DownLease; }
        public Rate setDownLease(BigDecimal value) { this.DownLease = value; return this; }
        public BigDecimal getMoLease() { return MoLease; }
        public Rate setMoLease(BigDecimal value) { this.MoLease = value; return this; }
    }

    @DataContract(Name="Accessory")
    public static class Accessory
    {
        /**
        * The description to be used for the Accessory
        */
        @DataMember
        @ApiMember(DataType="string", Description="The description to be used for the Accessory", IsRequired=true, Name="Desc", ParameterType="body")
        public String Desc = null;

        /**
        * The price to be used for the Accessory
        */
        @DataMember
        @ApiMember(DataType="decimal", Description="The price to be used for the Accessory", Name="Price", ParameterType="body")
        public BigDecimal Price = null;

        /**
        * The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
        */
        @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 String Type = null;

        /**
        * The category # in AIM to be linked to this accessory.
        */
        @DataMember
        @ApiMember(DataType="int", Description="The category # in AIM to be linked to this accessory.", Name="CatNum", ParameterType="body")
        public Integer CatNum = null;

        /**
        * A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
        */
        @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 String Sku = null;

        /**
        * Internal Use Only
        */
        @DataMember
        @ApiMember(DataType="bool", Description="Internal Use Only", Name="Report", ParameterType="body")
        public Boolean Report = null;
        
        public String getDesc() { return Desc; }
        public Accessory setDesc(String value) { this.Desc = value; return this; }
        public BigDecimal getPrice() { return Price; }
        public Accessory setPrice(BigDecimal value) { this.Price = value; return this; }
        public String getType() { return Type; }
        public Accessory setType(String value) { this.Type = value; return this; }
        public Integer getCatNum() { return CatNum; }
        public Accessory setCatNum(Integer value) { this.CatNum = value; return this; }
        public String getSku() { return Sku; }
        public Accessory setSku(String value) { this.Sku = value; return this; }
        public Boolean isReport() { return Report; }
        public Accessory setReport(Boolean value) { this.Report = value; return this; }
    }

    @DataContract(Name="FormInput")
    public static class FormInput
    {
        /**
        * Field name of the Input Field. If linking to an Attribute, this should match the Tag value.
        */
        @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 String Key = null;

        /**
        * Value of the Input Field.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="body")
        public String Value = null;

        /**
        * Whether or not the field is encryped with the C2B encryption key.
        */
        @DataMember
        @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", Name="Encrypted", ParameterType="body")
        public Boolean Encrypted = null;
        
        public String getKey() { return Key; }
        public FormInput setKey(String value) { this.Key = value; return this; }
        public String getValue() { return Value; }
        public FormInput setValue(String value) { this.Value = value; return this; }
        public Boolean isEncrypted() { return Encrypted; }
        public FormInput setEncrypted(Boolean value) { this.Encrypted = value; return this; }
    }

    @DataContract(Name="CCInfo")
    public static class CcInfo
    {
        /**
        * Token returned from processor
        */
        @DataMember
        @ApiMember(DataType="string", Description="Token returned from processor", IsRequired=true, Name="TokenStr", ParameterType="body")
        public String TokenStr = null;

        /**
        * Card Type (VISA, MCARD, AMEX, DSCVR)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Card Type (VISA, MCARD, AMEX, DSCVR)", IsRequired=true, Name="CardType", ParameterType="body")
        public String CardType = null;

        /**
        * Last four of the card
        */
        @DataMember
        @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="body")
        public String LastFour = null;

        /**
        * Expiration Date of the Card. (MM/YY)
        */
        @DataMember
        @ApiMember(DataType="string", Description="Expiration Date of the Card. (MM/YY)", Name="Expiration", ParameterType="body")
        public String Expiration = null;

        /**
        * Reason the card is on file.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="body")
        public String ReasonOnFile = 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="body")
        public Long TokenPk = 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="body")
        public Boolean Primary = null;
        
        public String getTokenStr() { return TokenStr; }
        public CcInfo setTokenStr(String value) { this.TokenStr = value; return this; }
        public String getCardType() { return CardType; }
        public CcInfo setCardType(String value) { this.CardType = value; return this; }
        public String getLastFour() { return LastFour; }
        public CcInfo setLastFour(String value) { this.LastFour = value; return this; }
        public String getExpiration() { return Expiration; }
        public CcInfo setExpiration(String value) { this.Expiration = value; return this; }
        public String getReasonOnFile() { return ReasonOnFile; }
        public CcInfo setReasonOnFile(String value) { this.ReasonOnFile = value; return this; }
        public Long getTokenPk() { return TokenPk; }
        public CcInfo setTokenPk(Long value) { this.TokenPk = value; return this; }
        public Boolean isPrimary() { return Primary; }
        public CcInfo setPrimary(Boolean value) { this.Primary = value; return this; }
    }

    @DataContract(Name="CustomerInfo")
    public static class CustomerInfo
    {
        /**
        * The WebId of the customer. Optional.
        */
        @DataMember
        @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", Name="WebId", ParameterType="body")
        public Integer WebId = null;

        /**
        * Name of the customer.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Name of the customer.", IsRequired=true, Name="Name", ParameterType="body")
        public String Name = null;

        /**
        * Address line 1 of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="Address line 1 of the customer", Name="Addr1", ParameterType="body")
        public String Addr1 = null;

        /**
        * Address line 2 of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="Address line 2 of the customer", Name="Addr2", ParameterType="body")
        public String Addr2 = null;

        /**
        * City of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="City of the customer", Name="City", ParameterType="body")
        public String City = null;

        /**
        * State/Province of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="State/Province of the customer", Name="St", ParameterType="body")
        public String St = null;

        /**
        * Zip code of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="Zip code of the customer", Name="Zip", ParameterType="body")
        public String Zip = null;

        /**
        * Country of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="Country of the customer", Name="Country", ParameterType="body")
        public String Country = null;

        /**
        * Phone number of the customer
        */
        @DataMember
        @ApiMember(DataType="string", Description="Phone number of the customer", Name="Phone", ParameterType="body")
        public String Phone = null;

        /**
        * Email address of the customer. Required.
        */
        @DataMember
        @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="body")
        public String Email = null;
        
        public Integer getWebId() { return WebId; }
        public CustomerInfo setWebId(Integer value) { this.WebId = value; return this; }
        public String getName() { return Name; }
        public CustomerInfo setName(String value) { this.Name = value; return this; }
        public String getAddr1() { return Addr1; }
        public CustomerInfo setAddr1(String value) { this.Addr1 = value; return this; }
        public String getAddr2() { return Addr2; }
        public CustomerInfo setAddr2(String value) { this.Addr2 = value; return this; }
        public String getCity() { return City; }
        public CustomerInfo setCity(String value) { this.City = value; return this; }
        public String getSt() { return St; }
        public CustomerInfo setSt(String value) { this.St = value; return this; }
        public String getZip() { return Zip; }
        public CustomerInfo setZip(String value) { this.Zip = value; return this; }
        public String getCountry() { return Country; }
        public CustomerInfo setCountry(String value) { this.Country = value; return this; }
        public String getPhone() { return Phone; }
        public CustomerInfo setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public CustomerInfo setEmail(String value) { this.Email = value; return this; }
    }

    @DataContract
    public static class C2BPostContractResponse extends BaseResponse
    {
        @DataMember
        public Boolean PaymentRequired = null;

        @DataMember
        public String Topic = null;

        @DataMember
        public String WebRef = null;

        @DataMember
        public String BaseUrl = null;
        
        public Boolean isPaymentRequired() { return PaymentRequired; }
        public C2BPostContractResponse setPaymentRequired(Boolean value) { this.PaymentRequired = value; return this; }
        public String getTopic() { return Topic; }
        public C2BPostContractResponse setTopic(String value) { this.Topic = value; return this; }
        public String getWebRef() { return WebRef; }
        public C2BPostContractResponse setWebRef(String value) { this.WebRef = value; return this; }
        public String getBaseUrl() { return BaseUrl; }
        public C2BPostContractResponse setBaseUrl(String value) { this.BaseUrl = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

}

Java C2BPostContractRequest 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.

POST /api/C2BPostContract HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"TeacherId":0,"SchoolName":"String","AIMSchoolId":0,"Stloc":"String","InstrumentId":0,"Sku":"String","Desc":"String","RateId":0,"Rate":{"PlanCode":"String","Level":0,"Grade":"String","DownPay":0,"MoPay":0,"DownMaint":0,"MoMaint":0,"RdfType":"String","ContractDefaultId":0,"Months":0,"DownLease":0,"MoLease":0},"AccessoryIdList":[0],"AccessoryList":[{"Desc":"String","Price":0,"Type":"String","CatNum":0,"Sku":"String","Report":false}],"FormInputList":[{"Key":"String","Value":"String","Encrypted":false}],"CcInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"CustomerInfo":{"WebId":0,"Name":"String","Addr1":"String","Addr2":"String","City":"String","St":"String","Zip":"String","Country":"String","Phone":"String","Email":"String"},"CusAcct":0,"Cat":0,"Sub":0,"ReturnTopic":false,"StatusId":0,"CardTerminalId":"String","Token":"String","ApiKey":"String","OAuthToken":"String","DeviceId":"String","AppId":"String"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"PaymentRequired":false,"Topic":"String","WebRef":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}