| POST, GET | /api/C2BPostContract |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/**
* @type {string}
* @description The OAuthToken token return by AeServices30 */
OAuthToken;
/**
* @type {string}
* @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
DeviceId;
/**
* @type {string}
* @description An identifier for your integration */
AppId;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {string}
* @description The Login Token return by the Security API. Required for secured calls. */
Token;
}
export class BaseResponseResult {
/** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
StatusCode;
/** @type {string} */
Login;
/** @type {string} */
ErrorCode;
/** @type {string} */
ErrorDisplayText;
/** @type {string} */
ErrorMessage;
/** @type {string} */
DomainName;
/** @type {string} */
IpAddress;
}
export class BaseResponse {
/** @param {{Status?:BaseResponseResult}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {BaseResponseResult} */
Status;
}
export class C2BPostContractResponse extends BaseResponse {
/** @param {{PaymentRequired?:boolean,Topic?:string,WebRef?:string,BaseUrl?:string,Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {boolean} */
PaymentRequired;
/** @type {string} */
Topic;
/** @type {string} */
WebRef;
/** @type {string} */
BaseUrl;
}
export class Rate {
/** @param {{PlanCode?:string,Level?:number,Grade?:string,DownPay?:number,MoPay?:number,DownMaint?:number,MoMaint?:number,RdfType?:string,ContractDefaultId?:number,Months?:number,DownLease?:number,MoLease?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Plan Code to be used for the contract */
PlanCode;
/**
* @type {?number}
* @description Level to be used for the contract */
Level;
/**
* @type {string}
* @description Grade to be used for the contract */
Grade;
/**
* @type {?number}
* @description Down Payment to be collected. Does not include maintenance or lease fees. */
DownPay;
/**
* @type {?number}
* @description Monthly amount to be collected for the contract. Does not include maintenance or lease fees. */
MoPay;
/**
* @type {?number}
* @description Down Payment to be collected for maintenance. */
DownMaint;
/**
* @type {?number}
* @description Monthly amount to be collected for the maintenance. */
MoMaint;
/**
* @type {string}
* @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 */
RdfType;
/**
* @type {?number}
* @description The ID of the contract default to be used for this contract. */
ContractDefaultId;
/**
* @type {?number}
* @description The Number of Months covered by the downpayment */
Months;
/**
* @type {?number}
* @description Down Payment to be collected for Lease Fees. */
DownLease;
/**
* @type {?number}
* @description Monthly amount to be collected for lease fees. */
MoLease;
}
export class Accessory {
/** @param {{Desc?:string,Price?:number,Type?:string,CatNum?:number,Sku?:string,Report?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description The description to be used for the Accessory */
Desc;
/**
* @type {number}
* @description The price to be used for the Accessory */
Price;
/**
* @type {string}
* @description The type of Accessory. A is Accessory, D is Delivery Option, and M is Maintenance */
Type;
/**
* @type {number}
* @description The category # in AIM to be linked to this accessory. */
CatNum;
/**
* @type {string}
* @description A SKU or Package Deal package SKU can be sent here to link the accessory to that SKU or package. */
Sku;
/**
* @type {?boolean}
* @description Internal Use Only */
Report;
}
export class FormInput {
/** @param {{Key?:string,Value?:string,Encrypted?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Field name of the Input Field. If linking to an Attribute, this should match the Tag value. */
Key;
/**
* @type {string}
* @description Value of the Input Field. */
Value;
/**
* @type {boolean}
* @description Whether or not the field is encryped with the C2B encryption key. */
Encrypted;
}
export class CcInfo {
/** @param {{TokenStr?:string,CardType?:string,LastFour?:string,Expiration?:string,ReasonOnFile?:string,TokenPk?:number,Primary?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description Token returned from processor */
TokenStr;
/**
* @type {string}
* @description Card Type (VISA, MCARD, AMEX, DSCVR) */
CardType;
/**
* @type {string}
* @description Last four of the card */
LastFour;
/**
* @type {string}
* @description Expiration Date of the Card. (MM/YY) */
Expiration;
/**
* @type {string}
* @description Reason the card is on file. */
ReasonOnFile;
/**
* @type {?number}
* @description ID of the existing Token Record in AIM, if applicable */
TokenPk;
/**
* @type {?boolean}
* @description Is this the customer's primary card? Defaults to false. */
Primary;
}
export class CustomerInfo {
/** @param {{WebId?:number,Name?:string,Addr1?:string,Addr2?:string,City?:string,St?:string,Zip?:string,Country?:string,Phone?:string,Email?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?number}
* @description The WebId of the customer. Optional. */
WebId;
/**
* @type {string}
* @description Name of the customer. */
Name;
/**
* @type {string}
* @description Address line 1 of the customer */
Addr1;
/**
* @type {string}
* @description Address line 2 of the customer */
Addr2;
/**
* @type {string}
* @description City of the customer */
City;
/**
* @type {string}
* @description State/Province of the customer */
St;
/**
* @type {string}
* @description Zip code of the customer */
Zip;
/**
* @type {string}
* @description Country of the customer */
Country;
/**
* @type {string}
* @description Phone number of the customer */
Phone;
/**
* @type {string}
* @description Email address of the customer. Required. */
Email;
}
export class C2BPostContractRequest extends BaseSecureRequest {
/** @param {{TeacherId?:number,SchoolName?:string,AIMSchoolId?:number,Stloc?:string,InstrumentId?:number,Sku?:string,Desc?:string,RateId?:number,Rate?:Rate,AccessoryIdList?:number[],AccessoryList?:Accessory[],FormInputList?:FormInput[],CcInfo?:CcInfo,CustomerInfo?:CustomerInfo,CusAcct?:number,Cat?:number,Sub?:number,ReturnTopic?:boolean,StatusId?:number,CardTerminalId?:string,Token?:string,ApiKey?:string,OAuthToken?:string,DeviceId?:string,AppId?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/**
* @type {?number}
* @description ID of the teacher to associate the contract with. */
TeacherId;
/**
* @type {string}
* @description Used to associate the contract with a school by school name. */
SchoolName;
/**
* @type {?number}
* @description Used to associate the contract with a school by the AIM School ID */
AIMSchoolId;
/**
* @type {string}
* @description Used to associate the contract with a location by location code. */
Stloc;
/**
* @type {?number}
* @description ID of the instrument to associate the contract with. */
InstrumentId;
/**
* @type {string}
* @description SKU to associate the contract with. Don't send if you send InstrumentId. */
Sku;
/**
* @type {string}
* @description Description to associate the contract with if a SKU is sent. Don't send if you send InstrumentId. */
Desc;
/**
* @type {?number}
* @description The ID from the C2BGradeGeneric object */
RateId;
/**
* @type {Rate}
* @description Rate object if you're not sending RateId. Don't send both. */
Rate;
/**
* @type {number[]}
* @description List of Accessory/Delivery/Maintenance IDs. */
AccessoryIdList;
/**
* @type {Accessory[]}
* @description List of Accessory/Delivery/Maintenance objects. This is for items not defined in AIM. */
AccessoryList;
/**
* @type {FormInput[]}
* @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 */
FormInputList;
/**
* @type {CcInfo}
* @description Credit Card Information */
CcInfo;
/**
* @type {CustomerInfo}
* @description Customer Information if the a CusAcct is not being passed in. */
CustomerInfo;
/**
* @type {?number}
* @description AIM Customer Acct# to be linked to this contract. Do not pass in CustomerInfo if using CusAcct. */
CusAcct;
/**
* @type {?number}
* @description Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU. */
Cat;
/**
* @type {?number}
* @description Used to associate a contract with a Cat/Sub rather then a SKU. Don't send if you send InstrumentId or SKU. */
Sub;
/**
* @type {?boolean}
* @description If TRUE is sent, a Topic will be returned with information from AIM. Usually not used. */
ReturnTopic;
/**
* @type {?number}
* @description If sent, the Contract will have the specified status in AIM upon creation. Use ContractStatusListing to get the desired Id. Usually not used. */
StatusId;
/**
* @type {string}
* @description Internal Use Only. Do not use. */
CardTerminalId;
}
JavaScript C2BPostContractRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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: application/json
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"}}