| GET | /api/ContractFullDetails |
|---|
"use strict";
export class BaseRequest {
/** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {string}
* @description This is your AIM API Key provided by Tri-Tech */
ApiKey;
/** @type {string} */
OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
/** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
Token;
/** @type {string} */
DeviceId;
/** @type {string} */
AppId;
}
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 ContractInventoryInfo {
/** @param {{Id?:number,BeginDate?:string,Cat?:number,Cost?:number,Description?:string,Discount?:number,Dunn?:string,EndDate?:string,InvType?:string,Notes?:string,OurPrice?:number,Qty?:number,ReceiptNotes?:string,Serial?:string,Sub?:number,Total?:number,Sku?:string,Mfg?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
BeginDate;
/** @type {number} */
Cat;
/** @type {?number} */
Cost;
/** @type {string} */
Description;
/** @type {number} */
Discount;
/** @type {string} */
Dunn;
/** @type {string} */
EndDate;
/** @type {string} */
InvType;
/** @type {string} */
Notes;
/** @type {number} */
OurPrice;
/** @type {number} */
Qty;
/** @type {string} */
ReceiptNotes;
/** @type {string} */
Serial;
/** @type {number} */
Sub;
/** @type {number} */
Total;
/** @type {string} */
Sku;
/** @type {string} */
Mfg;
}
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 ContractValuesObject {
/** @param {{Position?:number,Display?:string,Value?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Position;
/** @type {string} */
Display;
/** @type {number} */
Value;
}
export class ContractCalculatedFields {
/** @param {{Terms?:number,PayStream?:number,FinalPay?:number,AmountDue?:number,Payoff?:number,DiscountedPayoff?:number,RebateFc?:number,TotalLate?:number,PaymentsLate?:number,PaymentsAhead?:number,TotalMaintOwed?:number,CurrentPlusNext?:number,PayoffDate?:string,CreditAmount?:number,PrinLessTax?:number,MaintLessTax?:number,AFeeLessTax?:number,PaymentTax?:number,RentDueInfo?:ContractValuesObject[],PayoffInfo?:ContractValuesObject[],Notice?:string,Notice2?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Terms;
/** @type {number} */
PayStream;
/** @type {number} */
FinalPay;
/** @type {number} */
AmountDue;
/** @type {number} */
Payoff;
/** @type {number} */
DiscountedPayoff;
/** @type {number} */
RebateFc;
/** @type {number} */
TotalLate;
/** @type {number} */
PaymentsLate;
/** @type {number} */
PaymentsAhead;
/** @type {number} */
TotalMaintOwed;
/** @type {number} */
CurrentPlusNext;
/** @type {string} */
PayoffDate;
/** @type {number} */
CreditAmount;
/** @type {number} */
PrinLessTax;
/** @type {number} */
MaintLessTax;
/** @type {number} */
AFeeLessTax;
/** @type {number} */
PaymentTax;
/** @type {ContractValuesObject[]} */
RentDueInfo;
/** @type {ContractValuesObject[]} */
PayoffInfo;
/** @type {string} */
Notice;
/** @type {string} */
Notice2;
}
export class PaymentGeneric {
/** @param {{Date?:string,Amount?:number,Ref?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Date;
/** @type {number} */
Amount;
/** @type {string} */
Ref;
}
export class ContractInfo {
/** @param {{Rnt_afee?:number,Rnt_alatedbt?:boolean,Rnt_amtfin?:number,Rnt_aofinchg?:number,Rnt_apaydbt?:boolean,Rnt_apaytyp?:string,Rnt_atcode?:number,Rnt_autopayhold?:string,Rnt_avgbal?:number,Rnt_balance?:number,Rnt_billdays?:number,Rnt_cdate?:string,Rnt_colagency?:string,Rnt_colamt?:number,Rnt_coupdate?:string,Rnt_cramt?:number,Rnt_crmo?:number,Rnt_currafee?:number,Rnt_currbal?:number,Rnt_currfc?:number,Rnt_currfeetax1?:number,Rnt_currfeetax2?:number,Rnt_currlte?:number,Rnt_currma?:number,Rnt_curroth?:number,Rnt_currprn?:number,Rnt_currtax1?:number,Rnt_currtax2?:number,Rnt_dayslate?:number,Rnt_daystlst?:number,Rnt_deprcode?:string,Rnt_discount?:number,Rnt_downpay?:number,Rnt_dunn?:string,Rnt_edate?:string,Rnt_fdate?:string,Rnt_fee?:number,Rnt_finalpay?:number,Rnt_finchg?:number,Rnt_freemos?:number,Rnt_intdate?:string,Rnt_intrate?:number,Rnt_irregular?:boolean,Rnt_itcode?:number,Rnt_lastpaid?:number,Rnt_latefee?:number,Rnt_lateowed?:number,Rnt_ldate?:string,Rnt_ltcode?:number,Rnt_monma?:number,Rnt_mopayreq?:boolean,Rnt_mtcode?:number,Rnt_ndate?:string,Rnt_nextpayamt?:number,Rnt_nextpaynum?:number,Rnt_notedate?:string,Rnt_notes?:string,Rnt_exchnotes?:string,Rnt_otherowed?:number,Rnt_payfreq?:number,Rnt_latefreq?:number,Rnt_payfreqtype?:number,Rnt_payment?:number,Rnt_paystrm?:number,Rnt_pk?:number,Rnt_prevamt?:number,Rnt_prevmo?:number,Rnt_price?:number,Rnt_rdate?:string,Rnt_sdate?:string,Rnt_student?:string,Rnt_sub?:number,Rnt_tax?:number,Rnt_taxrate1?:number,Rnt_taxrate2?:number,Rnt_taxrateorig1?:number,Rnt_taxrateorig2?:number,Rnt_tcode?:number,Rnt_term?:number,Rnt_tmaint?:number,Rnt_tradein?:number,Rnt_typer?:string,Rnt_timestamp?:string,Acct?:number,TaxLocation?:string,DefaultDesc?:string,PayoffDesc?:string,School?:string,District?:string,Ref?:string,AutoPayDeclined?:boolean,Inventory?:ContractInventoryInfo[],CardInfo?:CcInfo,ContractCalculatedFields?:ContractCalculatedFields,Payments?:PaymentGeneric[],Rnt_avacodeprin?:string,Rnt_avacodemaint?:string,Rnt_avacodelate?:string,Rnt_avacodelease?:string,Rnt_avacodefin?:string,Rnt_scheduledreturndate?:string,Rnt_scheduledreturnoption?:string,Rnt_scheduledreturnnotes?:string,Rnt_scheduledreturnstatus?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Rnt_afee;
/** @type {boolean} */
Rnt_alatedbt;
/** @type {number} */
Rnt_amtfin;
/** @type {number} */
Rnt_aofinchg;
/** @type {boolean} */
Rnt_apaydbt;
/** @type {string} */
Rnt_apaytyp;
/** @type {number} */
Rnt_atcode;
/** @type {string} */
Rnt_autopayhold;
/** @type {number} */
Rnt_avgbal;
/** @type {number} */
Rnt_balance;
/** @type {number} */
Rnt_billdays;
/** @type {string} */
Rnt_cdate;
/** @type {string} */
Rnt_colagency;
/** @type {number} */
Rnt_colamt;
/** @type {string} */
Rnt_coupdate;
/** @type {number} */
Rnt_cramt;
/** @type {number} */
Rnt_crmo;
/** @type {number} */
Rnt_currafee;
/** @type {number} */
Rnt_currbal;
/** @type {number} */
Rnt_currfc;
/** @type {number} */
Rnt_currfeetax1;
/** @type {number} */
Rnt_currfeetax2;
/** @type {number} */
Rnt_currlte;
/** @type {number} */
Rnt_currma;
/** @type {number} */
Rnt_curroth;
/** @type {number} */
Rnt_currprn;
/** @type {number} */
Rnt_currtax1;
/** @type {number} */
Rnt_currtax2;
/** @type {number} */
Rnt_dayslate;
/** @type {number} */
Rnt_daystlst;
/** @type {string} */
Rnt_deprcode;
/** @type {number} */
Rnt_discount;
/** @type {number} */
Rnt_downpay;
/** @type {string} */
Rnt_dunn;
/** @type {string} */
Rnt_edate;
/** @type {string} */
Rnt_fdate;
/** @type {number} */
Rnt_fee;
/** @type {number} */
Rnt_finalpay;
/** @type {number} */
Rnt_finchg;
/** @type {number} */
Rnt_freemos;
/** @type {string} */
Rnt_intdate;
/** @type {number} */
Rnt_intrate;
/** @type {boolean} */
Rnt_irregular;
/** @type {number} */
Rnt_itcode;
/** @type {number} */
Rnt_lastpaid;
/** @type {number} */
Rnt_latefee;
/** @type {number} */
Rnt_lateowed;
/** @type {string} */
Rnt_ldate;
/** @type {number} */
Rnt_ltcode;
/** @type {number} */
Rnt_monma;
/** @type {boolean} */
Rnt_mopayreq;
/** @type {number} */
Rnt_mtcode;
/** @type {string} */
Rnt_ndate;
/** @type {number} */
Rnt_nextpayamt;
/** @type {number} */
Rnt_nextpaynum;
/** @type {string} */
Rnt_notedate;
/** @type {string} */
Rnt_notes;
/** @type {string} */
Rnt_exchnotes;
/** @type {number} */
Rnt_otherowed;
/** @type {number} */
Rnt_payfreq;
/** @type {number} */
Rnt_latefreq;
/** @type {number} */
Rnt_payfreqtype;
/** @type {number} */
Rnt_payment;
/** @type {number} */
Rnt_paystrm;
/** @type {number} */
Rnt_pk;
/** @type {number} */
Rnt_prevamt;
/** @type {number} */
Rnt_prevmo;
/** @type {number} */
Rnt_price;
/** @type {string} */
Rnt_rdate;
/** @type {string} */
Rnt_sdate;
/** @type {string} */
Rnt_student;
/** @type {number} */
Rnt_sub;
/** @type {number} */
Rnt_tax;
/** @type {number} */
Rnt_taxrate1;
/** @type {number} */
Rnt_taxrate2;
/** @type {number} */
Rnt_taxrateorig1;
/** @type {number} */
Rnt_taxrateorig2;
/** @type {number} */
Rnt_tcode;
/** @type {number} */
Rnt_term;
/** @type {number} */
Rnt_tmaint;
/** @type {number} */
Rnt_tradein;
/** @type {string} */
Rnt_typer;
/** @type {string} */
Rnt_timestamp;
/** @type {number} */
Acct;
/** @type {string} */
TaxLocation;
/** @type {string} */
DefaultDesc;
/** @type {string} */
PayoffDesc;
/** @type {string} */
School;
/** @type {string} */
District;
/** @type {string} */
Ref;
/** @type {boolean} */
AutoPayDeclined;
/** @type {ContractInventoryInfo[]} */
Inventory;
/** @type {CcInfo} */
CardInfo;
/** @type {ContractCalculatedFields} */
ContractCalculatedFields;
/** @type {PaymentGeneric[]} */
Payments;
/** @type {string} */
Rnt_avacodeprin;
/** @type {string} */
Rnt_avacodemaint;
/** @type {string} */
Rnt_avacodelate;
/** @type {string} */
Rnt_avacodelease;
/** @type {string} */
Rnt_avacodefin;
/** @type {string} */
Rnt_scheduledreturndate;
/** @type {string} */
Rnt_scheduledreturnoption;
/** @type {string} */
Rnt_scheduledreturnnotes;
/** @type {string} */
Rnt_scheduledreturnstatus;
}
export class ContractFullDetailsResponse extends BaseResponse {
/** @param {{Contracts?:ContractInfo[],RemainingRecords?:number,Status?:BaseResponseResult}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {ContractInfo[]} */
Contracts;
/** @type {number} */
RemainingRecords;
}
export class ContractFullDetailsRequest extends BaseSecureRequest {
/** @param {{Acct?:number,Sub?:number,ChangedDate?:string,SerialNumber?:string,CalculationsDate?:string,StartOffset?:number,RecordCount?:number,AIMRef?:string,WebRef?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {?number} */
Acct;
/** @type {?number} */
Sub;
/** @type {?string} */
ChangedDate;
/** @type {string} */
SerialNumber;
/**
* @type {?string}
* @description If sent, additional calculated fields will be returned using this date */
CalculationsDate;
/**
* @type {?number}
* @description The Starting Offset */
StartOffset;
/**
* @type {?number}
* @description The # of records to be returned */
RecordCount;
/**
* @type {string}
* @description The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount */
AIMRef;
/**
* @type {string}
* @description The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount */
WebRef;
}
JavaScript ContractFullDetailsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/ContractFullDetails HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Contracts":[{"Rnt_afee":0,"Rnt_alatedbt":false,"Rnt_amtfin":0,"Rnt_aofinchg":0,"Rnt_apaydbt":false,"Rnt_apaytyp":"String","Rnt_atcode":0,"Rnt_avgbal":0,"Rnt_balance":0,"Rnt_billdays":0,"Rnt_colagency":"String","Rnt_colamt":0,"Rnt_cramt":0,"Rnt_crmo":0,"Rnt_currafee":0,"Rnt_currbal":0,"Rnt_currfc":0,"Rnt_currfeetax1":0,"Rnt_currfeetax2":0,"Rnt_currlte":0,"Rnt_currma":0,"Rnt_curroth":0,"Rnt_currprn":0,"Rnt_currtax1":0,"Rnt_currtax2":0,"Rnt_dayslate":0,"Rnt_daystlst":0,"Rnt_deprcode":"String","Rnt_discount":0,"Rnt_downpay":0,"Rnt_dunn":"String","Rnt_fee":0,"Rnt_finalpay":0,"Rnt_finchg":0,"Rnt_freemos":0,"Rnt_intrate":0,"Rnt_irregular":false,"Rnt_itcode":0,"Rnt_lastpaid":0,"Rnt_latefee":0,"Rnt_lateowed":0,"Rnt_ltcode":0,"Rnt_monma":0,"Rnt_mopayreq":false,"Rnt_mtcode":0,"Rnt_nextpayamt":0,"Rnt_nextpaynum":0,"Rnt_notes":"String","Rnt_exchnotes":"String","Rnt_otherowed":0,"Rnt_payfreq":0,"Rnt_latefreq":0,"Rnt_payfreqtype":0,"Rnt_payment":0,"Rnt_paystrm":0,"Rnt_pk":0,"Rnt_prevamt":0,"Rnt_prevmo":0,"Rnt_price":0,"Rnt_student":"String","Rnt_sub":0,"Rnt_tax":0,"Rnt_taxrate1":0,"Rnt_taxrate2":0,"Rnt_taxrateorig1":0,"Rnt_taxrateorig2":0,"Rnt_tcode":0,"Rnt_term":0,"Rnt_tmaint":0,"Rnt_tradein":0,"Rnt_typer":"String","Acct":0,"TaxLocation":"String","DefaultDesc":"String","PayoffDesc":"String","School":"String","District":"String","Ref":"String","AutoPayDeclined":false,"Inventory":[{"Id":0,"Cat":0,"Cost":0,"Description":"String","Discount":0,"Dunn":"String","InvType":"String","Notes":"String","OurPrice":0,"Qty":0,"ReceiptNotes":"String","Serial":"String","Sub":0,"Total":0,"Sku":"String","Mfg":"String"}],"CardInfo":{"TokenStr":"String","CardType":"String","LastFour":"String","Expiration":"String","ReasonOnFile":"String","TokenPk":0,"Primary":false},"ContractCalculatedFields":{"Terms":0,"PayStream":0,"FinalPay":0,"AmountDue":0,"Payoff":0,"DiscountedPayoff":0,"RebateFc":0,"TotalLate":0,"PaymentsLate":0,"PaymentsAhead":0,"TotalMaintOwed":0,"CurrentPlusNext":0,"CreditAmount":0,"PrinLessTax":0,"MaintLessTax":0,"AFeeLessTax":0,"PaymentTax":0,"RentDueInfo":[{"Position":0,"Display":"String","Value":0}],"PayoffInfo":[{"Position":0,"Display":"String","Value":0}],"Notice":"String","Notice2":"String"},"Payments":[{"Amount":0,"Ref":"String"}],"Rnt_avacodeprin":"String","Rnt_avacodemaint":"String","Rnt_avacodelate":"String","Rnt_avacodelease":"String","Rnt_avacodefin":"String","Rnt_scheduledreturnoption":"String","Rnt_scheduledreturnnotes":"String","Rnt_scheduledreturnstatus":"String"}],"RemainingRecords":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}