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

// @DataContract
export class BaseRequest
{
    /** @description 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 ApiKey: string;

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

    /** @description 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 DeviceId: string;

    /** @description An identifier for your integration */
    // @DataMember
    // @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description 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 Token: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

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

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

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

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

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class C2BPostContractResponse extends BaseResponse
{
    // @DataMember
    public PaymentRequired: boolean;

    // @DataMember
    public Topic: string;

    // @DataMember
    public WebRef: string;

    // @DataMember
    public BaseUrl: string;

    public constructor(init?: Partial<C2BPostContractResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract(Name="Rate")
export class Rate
{
    /** @description 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 PlanCode: string;

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

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

    /** @description 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 DownPay?: number;

    /** @description 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 MoPay?: number;

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

    /** @description 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 MoMaint?: number;

    /** @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 */
    // @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 RdfType: string;

    /** @description 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 ContractDefaultId?: number;

    /** @description 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 Months?: number;

    /** @description 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 DownLease?: number;

    /** @description 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 MoLease?: number;

    public constructor(init?: Partial<Rate>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="Accessory")
export class Accessory
{
    /** @description 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 Desc: string;

    /** @description 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 Price: number;

    /** @description 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 Type: string;

    /** @description 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 CatNum: number;

    /** @description 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 Sku: string;

    /** @description Internal Use Only */
    // @DataMember
    // @ApiMember(DataType="bool", Description="Internal Use Only", Name="Report", ParameterType="body")
    public Report?: boolean;

    public constructor(init?: Partial<Accessory>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="FormInput")
export class FormInput
{
    /** @description 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 Key: string;

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

    /** @description 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 Encrypted: boolean;

    public constructor(init?: Partial<FormInput>) { (Object as any).assign(this, init); }
}

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

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

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

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

    /** @description Reason the card is on file. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="body")
    public ReasonOnFile: string;

    /** @description 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 TokenPk?: number;

    /** @description 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 Primary?: boolean;

    public constructor(init?: Partial<CcInfo>) { (Object as any).assign(this, init); }
}

// @DataContract(Name="CustomerInfo")
export class CustomerInfo
{
    /** @description The WebId of the customer. Optional. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The WebId of the customer. Optional.", Format="int32", Name="WebId", ParameterType="body")
    public WebId?: number;

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

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

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

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

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

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

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

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

    /** @description Email address of the customer. Required. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Email address of the customer. Required.", IsRequired=true, Name="Email", ParameterType="body")
    public Email: string;

    public constructor(init?: Partial<CustomerInfo>) { (Object as any).assign(this, init); }
}

/** @description C2BPostContractRequires active-e Contracts Service. */
// @DataContract
export class C2BPostContractRequest extends BaseSecureRequest
{
    /** @description 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 TeacherId?: number;

    /** @description 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 SchoolName: string;

    /** @description 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 AIMSchoolId?: number;

    /** @description 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 Stloc: string;

    /** @description 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 InstrumentId?: number;

    /** @description 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 Sku: string;

    /** @description 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 Desc: string;

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

    /** @description 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;

    /** @description List of Accessory/Delivery/Maintenance IDs. */
    // @DataMember
    // @ApiMember(DataType="array", Description="List of Accessory/Delivery/Maintenance IDs.", Name="AccessoryIdList", ParameterType="body")
    public AccessoryIdList: number[];

    /** @description 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 AccessoryList: Accessory[];

    /** @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 */
    // @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 FormInputList: FormInput[];

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

    /** @description 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;

    /** @description 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 CusAcct?: number;

    /** @description 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 Cat?: number;

    /** @description 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 Sub?: number;

    /** @description 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 ReturnTopic?: boolean;

    /** @description 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 StatusId?: number;

    /** @description Internal Use Only. Do not use. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Internal Use Only. Do not use.", Name="CardTerminalId", ParameterType="body")
    public CardTerminalId: string;

    public constructor(init?: Partial<C2BPostContractRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript C2BPostContractRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<C2BPostContractRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <AIMSchoolId>0</AIMSchoolId>
  <AccessoryIdList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </AccessoryIdList>
  <AccessoryList>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AccessoryList>
  <CardTerminalId>String</CardTerminalId>
  <Cat>0</Cat>
  <CcInfo>
    <CardType>String</CardType>
    <Expiration>String</Expiration>
    <LastFour>String</LastFour>
    <Primary>false</Primary>
    <ReasonOnFile>String</ReasonOnFile>
    <TokenPk>0</TokenPk>
    <TokenStr>String</TokenStr>
  </CcInfo>
  <CusAcct>0</CusAcct>
  <CustomerInfo>
    <Addr1>String</Addr1>
    <Addr2>String</Addr2>
    <City>String</City>
    <Country>String</Country>
    <Email>String</Email>
    <Name>String</Name>
    <Phone>String</Phone>
    <St>String</St>
    <WebId>0</WebId>
    <Zip>String</Zip>
  </CustomerInfo>
  <Desc>String</Desc>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <InstrumentId>0</InstrumentId>
  <Rate>
    <ContractDefaultId>0</ContractDefaultId>
    <DownLease>0</DownLease>
    <DownMaint>0</DownMaint>
    <DownPay>0</DownPay>
    <Grade>String</Grade>
    <Level>0</Level>
    <MoLease>0</MoLease>
    <MoMaint>0</MoMaint>
    <MoPay>0</MoPay>
    <Months>0</Months>
    <PlanCode>String</PlanCode>
    <RdfType>String</RdfType>
  </Rate>
  <RateId>0</RateId>
  <ReturnTopic>false</ReturnTopic>
  <SchoolName>String</SchoolName>
  <Sku>String</Sku>
  <StatusId>0</StatusId>
  <Stloc>String</Stloc>
  <Sub>0</Sub>
  <TeacherId>0</TeacherId>
</C2BPostContractRequest>

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

<C2BPostContractResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <BaseUrl>String</BaseUrl>
  <PaymentRequired>false</PaymentRequired>
  <Topic>String</Topic>
  <WebRef>String</WebRef>
</C2BPostContractResponse>