AIM Web Services

C2BPostContractRequest

C2BPostContract
Requires active-e Contracts Service.

The following routes are available for this service:
POST, GET	/api/C2BPostContract

**C2BPostContractRequest** Parameters:
Name	Parameter	Data Type	Required	Description
TeacherId	body	integer	No	ID of the teacher to associate the contract with.
SchoolName	body	string	No	Used to associate the contract with a school by school name.
AIMSchoolId	body	string	No	Used to associate the contract with a school by the AIM School ID
Stloc	body	string	No	Used to associate the contract with a location by location code.
InstrumentId	body	integer	No	ID of the instrument to associate the contract with.
Sku	body	string	No	SKU to associate the contract with. Don't send if you send InstrumentId.
Desc	body	string	No	Description to associate the contract with if a SKU is sent. Don't send if you send InstrumentId.
RateId	body	integer	No	The ID from the C2BGradeGeneric object
Rate	body	object	No	Rate object if you're not sending RateId. Don't send both.
AccessoryIdList	body	array	No	List of Accessory/Delivery/Maintenance IDs.
AccessoryList	body	array	No	List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM.
FormInputList	body	array	No	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
CcInfo	body	object	No	Credit Card Information
CustomerInfo	body	object	No	Customer Information if the a CusAcct is not being passed in.
CusAcct	body	integer	No	AIM Customer Acct# to be linked to this contract. Do not pass in CustomerInfo if using CusAcct.
Cat	body	int	No	Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
Sub	body	int	No	Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU.
ReturnTopic	body	bool	No	If TRUE is sent, a Topic will be returned with information from AIM. Usually not used.
StatusId	body	int	No	If sent, the Contract will have the specified status in AIM upon creation. Use ContractStatusListing to get the desired Id. Usually not used.
CardTerminalId	body	string	No	Internal Use Only. Do not use.

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Token	Header	string	No	The Login Token return by the Security API. Required for secured calls.

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	Header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	Header	string	Yes	The OAuthToken token return by AeServices30
DeviceId	Header	string	No	The Device ID of the Mobile Device. Not used for non-mobile devices.
AppId	Header	string	Yes	An identifier for your integration

**Rate** Parameters:
Name	Parameter	Data Type	Required	Description
PlanCode	body	string	No	Plan Code to be used for the contract
Level	body	int	No	Level to be used for the contract
Grade	body	string	No	Grade to be used for the contract
DownPay	body	decimal	No	Down Payment to be collected. Does not include maintenance or lease fees.
MoPay	body	decimal	No	Monthly amount to be collected for the contract. Does not include maintenance or lease fees.
DownMaint	body	decimal	No	Down Payment to be collected for maintenance.
MoMaint	body	decimal	No	Monthly amount to be collected for the maintenance.
RdfType	body	int64	No	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
ContractDefaultId	body	int64	No	The ID of the contract default to be used for this contract.
Months	body	int	No	The Number of Months covered by the downpayment
DownLease	body	decimal	No	Down Payment to be collected for Lease Fees.
MoLease	body	decimal	No	Monthly amount to be collected for lease fees.

**Accessory** Parameters:
Name	Parameter	Data Type	Required	Description
Desc	body	string	Yes	The description to be used for the Accessory
Price	body	decimal	No	The price to be used for the Accessory
Type	body	string	No	The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance
CatNum	body	int	No	The category # in AIM to be linked to this accessory.
Sku	body	string	No	A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package.
Report	body	bool	No	Internal Use Only

**FormInput** Parameters:
Name	Parameter	Data Type	Required	Description
Key	body	string	Yes	Field name of the Input Field. If linking to an Attribute, this should match the Tag value.
Value	body	string	Yes	Value of the Input Field.
Encrypted	body	boolean	No	Whether or not the field is encryped with the C2B encryption key.

**CcInfo** Parameters:
Name	Parameter	Data Type	Required	Description
TokenStr	body	string	Yes	Token returned from processor
CardType	body	string	Yes	Card Type (VISA, MCARD, AMEX, DSCVR)
LastFour	body	string	Yes	Last four of the card
Expiration	body	string	No	Expiration Date of the Card. (MM/YY)
ReasonOnFile	body	string	No	Reason the card is on file.
TokenPk	body	integer	No	ID of the existing Token Record in AIM, if applicable
Primary	body	boolean	No	Is this the customer's primary card? Defaults to false.

**CustomerInfo** Parameters:
Name	Parameter	Data Type	Required	Description
WebId	body	integer	No	The WebId of the customer. Optional.
Name	body	string	Yes	Name of the customer.
Addr1	body	string	No	Address line 1 of the customer
Addr2	body	string	No	Address line 2 of the customer
City	body	string	No	City of the customer
St	body	string	No	State/Province of the customer
Zip	body	string	No	Zip code of the customer
Country	body	string	No	Country of the customer
Phone	body	string	No	Phone number of the customer
Email	body	string	Yes	Email address of the customer. Required.

**C2BPostContractResponse** Parameters:
Name	Parameter	Data Type	Required
PaymentRequired	form	bool	No
Topic	form	string	No
WebRef	form	string	No
BaseUrl	form	string	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

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>

AIM Web Services

C2BPostContractRequest

C2BPostContract Requires active-e Contracts Service.

HTTP + XML

C2BPostContract
Requires active-e Contracts Service.