AIM Web Services

<back to all web services

ContractFullDetailsRequest

ContractFullDetails
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ContractFullDetails

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

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

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

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: 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 ContractInventoryInfo
{
    // @DataMember
    public Id: number;

    // @DataMember
    public BeginDate: string;

    // @DataMember
    public Cat: number;

    // @DataMember
    public Cost?: number;

    // @DataMember
    public Description: string;

    // @DataMember
    public Discount: number;

    // @DataMember
    public Dunn: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public InvType: string;

    // @DataMember
    public Notes: string;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public Qty: number;

    // @DataMember
    public ReceiptNotes: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Sub: number;

    // @DataMember
    public Total: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Mfg: string;

    public constructor(init?: Partial<ContractInventoryInfo>) { (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="query")
    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="query")
    public CardType: string;

    /** @description Last four of the card */
    // @DataMember
    // @ApiMember(DataType="string", Description="Last four of the card", IsRequired=true, Name="LastFour", ParameterType="query")
    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="query")
    public Expiration: string;

    /** @description Reason the card is on file. */
    // @DataMember
    // @ApiMember(DataType="string", Description="Reason the card is on file.", Name="ReasonOnFile", ParameterType="query")
    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="query")
    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="query")
    public Primary?: boolean;

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

// @DataContract
export class ContractValuesObject
{
    // @DataMember
    public Position: number;

    // @DataMember
    public Display: string;

    // @DataMember
    public Value: number;

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

// @DataContract
export class ContractCalculatedFields
{
    // @DataMember
    public Terms: number;

    // @DataMember
    public PayStream: number;

    // @DataMember
    public FinalPay: number;

    // @DataMember
    public AmountDue: number;

    // @DataMember
    public Payoff: number;

    // @DataMember
    public DiscountedPayoff: number;

    // @DataMember
    public RebateFc: number;

    // @DataMember
    public TotalLate: number;

    // @DataMember
    public PaymentsLate: number;

    // @DataMember
    public PaymentsAhead: number;

    // @DataMember
    public TotalMaintOwed: number;

    // @DataMember
    public CurrentPlusNext: number;

    // @DataMember
    public PayoffDate: string;

    // @DataMember
    public CreditAmount: number;

    // @DataMember
    public PrinLessTax: number;

    // @DataMember
    public MaintLessTax: number;

    // @DataMember
    public AFeeLessTax: number;

    // @DataMember
    public PaymentTax: number;

    // @DataMember
    public RentDueInfo: ContractValuesObject[];

    // @DataMember
    public PayoffInfo: ContractValuesObject[];

    // @DataMember
    public Notice: string;

    // @DataMember
    public Notice2: string;

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

// @DataContract
export class PaymentGeneric
{
    // @DataMember
    public Date: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public Ref: string;

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

// @DataContract
export class ContractInfo
{
    // @DataMember
    public Rnt_afee: number;

    // @DataMember
    public Rnt_alatedbt: boolean;

    // @DataMember
    public Rnt_amtfin: number;

    // @DataMember
    public Rnt_aofinchg: number;

    // @DataMember
    public Rnt_apaydbt: boolean;

    // @DataMember
    public Rnt_apaytyp: string;

    // @DataMember
    public Rnt_atcode: number;

    // @DataMember
    public Rnt_autopayhold: string;

    // @DataMember
    public Rnt_avgbal: number;

    // @DataMember
    public Rnt_balance: number;

    // @DataMember
    public Rnt_billdays: number;

    // @DataMember
    public Rnt_cdate: string;

    // @DataMember
    public Rnt_colagency: string;

    // @DataMember
    public Rnt_colamt: number;

    // @DataMember
    public Rnt_coupdate: string;

    // @DataMember
    public Rnt_cramt: number;

    // @DataMember
    public Rnt_crmo: number;

    // @DataMember
    public Rnt_currafee: number;

    // @DataMember
    public Rnt_currbal: number;

    // @DataMember
    public Rnt_currfc: number;

    // @DataMember
    public Rnt_currfeetax1: number;

    // @DataMember
    public Rnt_currfeetax2: number;

    // @DataMember
    public Rnt_currlte: number;

    // @DataMember
    public Rnt_currma: number;

    // @DataMember
    public Rnt_curroth: number;

    // @DataMember
    public Rnt_currprn: number;

    // @DataMember
    public Rnt_currtax1: number;

    // @DataMember
    public Rnt_currtax2: number;

    // @DataMember
    public Rnt_dayslate: number;

    // @DataMember
    public Rnt_daystlst: number;

    // @DataMember
    public Rnt_deprcode: string;

    // @DataMember
    public Rnt_discount: number;

    // @DataMember
    public Rnt_downpay: number;

    // @DataMember
    public Rnt_dunn: string;

    // @DataMember
    public Rnt_edate: string;

    // @DataMember
    public Rnt_fdate: string;

    // @DataMember
    public Rnt_fee: number;

    // @DataMember
    public Rnt_finalpay: number;

    // @DataMember
    public Rnt_finchg: number;

    // @DataMember
    public Rnt_freemos: number;

    // @DataMember
    public Rnt_intdate: string;

    // @DataMember
    public Rnt_intrate: number;

    // @DataMember
    public Rnt_irregular: boolean;

    // @DataMember
    public Rnt_itcode: number;

    // @DataMember
    public Rnt_lastpaid: number;

    // @DataMember
    public Rnt_latefee: number;

    // @DataMember
    public Rnt_lateowed: number;

    // @DataMember
    public Rnt_ldate: string;

    // @DataMember
    public Rnt_ltcode: number;

    // @DataMember
    public Rnt_monma: number;

    // @DataMember
    public Rnt_mopayreq: boolean;

    // @DataMember
    public Rnt_mtcode: number;

    // @DataMember
    public Rnt_ndate: string;

    // @DataMember
    public Rnt_nextpayamt: number;

    // @DataMember
    public Rnt_nextpaynum: number;

    // @DataMember
    public Rnt_notedate: string;

    // @DataMember
    public Rnt_notes: string;

    // @DataMember
    public Rnt_exchnotes: string;

    // @DataMember
    public Rnt_otherowed: number;

    // @DataMember
    public Rnt_payfreq: number;

    // @DataMember
    public Rnt_latefreq: number;

    // @DataMember
    public Rnt_payfreqtype: number;

    // @DataMember
    public Rnt_payment: number;

    // @DataMember
    public Rnt_paystrm: number;

    // @DataMember
    public Rnt_pk: number;

    // @DataMember
    public Rnt_prevamt: number;

    // @DataMember
    public Rnt_prevmo: number;

    // @DataMember
    public Rnt_price: number;

    // @DataMember
    public Rnt_rdate: string;

    // @DataMember
    public Rnt_sdate: string;

    // @DataMember
    public Rnt_student: string;

    // @DataMember
    public Rnt_sub: number;

    // @DataMember
    public Rnt_tax: number;

    // @DataMember
    public Rnt_taxrate1: number;

    // @DataMember
    public Rnt_taxrate2: number;

    // @DataMember
    public Rnt_taxrateorig1: number;

    // @DataMember
    public Rnt_taxrateorig2: number;

    // @DataMember
    public Rnt_tcode: number;

    // @DataMember
    public Rnt_term: number;

    // @DataMember
    public Rnt_tmaint: number;

    // @DataMember
    public Rnt_tradein: number;

    // @DataMember
    public Rnt_typer: string;

    // @DataMember
    public Rnt_timestamp: string;

    // @DataMember
    public Acct: number;

    // @DataMember
    public TaxLocation: string;

    // @DataMember
    public DefaultDesc: string;

    // @DataMember
    public PayoffDesc: string;

    // @DataMember
    public School: string;

    // @DataMember
    public District: string;

    // @DataMember
    public Ref: string;

    // @DataMember
    public AutoPayDeclined: boolean;

    // @DataMember
    public Inventory: ContractInventoryInfo[];

    // @DataMember
    public CardInfo: CcInfo;

    // @DataMember
    public ContractCalculatedFields: ContractCalculatedFields;

    // @DataMember
    public Payments: PaymentGeneric[];

    // @DataMember
    public Rnt_avacodeprin: string;

    // @DataMember
    public Rnt_avacodemaint: string;

    // @DataMember
    public Rnt_avacodelate: string;

    // @DataMember
    public Rnt_avacodelease: string;

    // @DataMember
    public Rnt_avacodefin: string;

    // @DataMember
    public Rnt_scheduledreturndate: string;

    // @DataMember
    public Rnt_scheduledreturnoption: string;

    // @DataMember
    public Rnt_scheduledreturnnotes: string;

    // @DataMember
    public Rnt_scheduledreturnstatus: string;

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

// @DataContract
export class ContractFullDetailsResponse extends BaseResponse
{
    // @DataMember
    public Contracts: ContractInfo[];

    // @DataMember
    public RemainingRecords: number;

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

/** @description ContractFullDetailsRequires active-e Contracts Service. */
// @DataContract
export class ContractFullDetailsRequest extends BaseSecureRequest
{
    // @DataMember
    public Acct?: number;

    // @DataMember
    public Sub?: number;

    // @DataMember
    public ChangedDate?: string;

    // @DataMember
    public SerialNumber: string;

    /** @description If sent, additional calculated fields will be returned using this date */
    // @DataMember
    // @ApiMember(DataType="string", Description="If sent, additional calculated fields will be returned using this date", Format="date", Name="CalculationsDate", ParameterType="query")
    public CalculationsDate?: string;

    /** @description The Starting Offset */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The Starting Offset", Format="int64", Name="StartOffset")
    public StartOffset?: number;

    /** @description The # of records to be returned */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The # of records to be returned", Format="int64", Name="RecordCount")
    public RecordCount?: number;

    /** @description The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="AIMRef")
    public AIMRef: string;

    /** @description The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount */
    // @DataMember
    // @ApiMember(DataType="string", Description="The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount", Name="WebRef")
    public WebRef: string;

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

TypeScript ContractFullDetailsRequest 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

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}