AIM Web Services

ContractFullDetailsRequest

ContractFullDetails
Requires active-e Contracts Service.

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

**ContractFullDetailsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Acct	query	int?	No
Sub	query	int?	No
ChangedDate	query	DateTime?	No
SerialNumber	query	string	No
CalculationsDate	query	string	No	If sent, additional calculated fields will be returned using this date
StartOffset	query	integer	No	The Starting Offset
RecordCount	query	integer	No	The # of records to be returned
AIMRef	query	string	No	The Contract Ref# to be looked up. If sent, do not send WebRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount
WebRef	query	string	No	The WebRef to be looked up. If sent, do not send AIMRef, Acct, Sub, ChangedDate, SerialNumber, StartOffset, or Recordcount

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**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	No

**ContractFullDetailsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Contracts	form	List<ContractInfo>	No
RemainingRecords	form	long	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

**ContractInfo** Parameters:
Name	Parameter	Data Type	Required
Rnt_afee	form	decimal	No
Rnt_alatedbt	form	bool	No
Rnt_amtfin	form	decimal	No
Rnt_aofinchg	form	decimal	No
Rnt_apaydbt	form	bool	No
Rnt_apaytyp	form	string	No
Rnt_atcode	form	short	No
Rnt_autopayhold	form	DateTime	No
Rnt_avgbal	form	decimal	No
Rnt_balance	form	decimal	No
Rnt_billdays	form	short	No
Rnt_cdate	form	DateTime	No
Rnt_colagency	form	string	No
Rnt_colamt	form	decimal	No
Rnt_coupdate	form	DateTime	No
Rnt_cramt	form	decimal	No
Rnt_crmo	form	short	No
Rnt_currafee	form	decimal	No
Rnt_currbal	form	decimal	No
Rnt_currfc	form	decimal	No
Rnt_currfeetax1	form	decimal	No
Rnt_currfeetax2	form	decimal	No
Rnt_currlte	form	decimal	No
Rnt_currma	form	decimal	No
Rnt_curroth	form	decimal	No
Rnt_currprn	form	decimal	No
Rnt_currtax1	form	decimal	No
Rnt_currtax2	form	decimal	No
Rnt_dayslate	form	short	No
Rnt_daystlst	form	short	No
Rnt_deprcode	form	string	No
Rnt_discount	form	decimal	No
Rnt_downpay	form	decimal	No
Rnt_dunn	form	string	No
Rnt_edate	form	DateTime	No
Rnt_fdate	form	DateTime	No
Rnt_fee	form	decimal	No
Rnt_finalpay	form	decimal	No
Rnt_finchg	form	decimal	No
Rnt_freemos	form	short	No
Rnt_intdate	form	DateTime	No
Rnt_intrate	form	decimal	No
Rnt_irregular	form	bool	No
Rnt_itcode	form	short	No
Rnt_lastpaid	form	decimal	No
Rnt_latefee	form	decimal	No
Rnt_lateowed	form	decimal	No
Rnt_ldate	form	DateTime	No
Rnt_ltcode	form	short	No
Rnt_monma	form	decimal	No
Rnt_mopayreq	form	bool	No
Rnt_mtcode	form	short	No
Rnt_ndate	form	DateTime	No
Rnt_nextpayamt	form	decimal	No
Rnt_nextpaynum	form	short	No
Rnt_notedate	form	DateTime	No
Rnt_notes	form	string	No
Rnt_exchnotes	form	string	No
Rnt_otherowed	form	decimal	No
Rnt_payfreq	form	short	No
Rnt_latefreq	form	short	No
Rnt_payfreqtype	form	short	No
Rnt_payment	form	decimal	No
Rnt_paystrm	form	short	No
Rnt_pk	form	long	No
Rnt_prevamt	form	decimal	No
Rnt_prevmo	form	short	No
Rnt_price	form	decimal	No
Rnt_rdate	form	DateTime	No
Rnt_sdate	form	DateTime	No
Rnt_student	form	string	No
Rnt_sub	form	int	No
Rnt_tax	form	decimal	No
Rnt_taxrate1	form	decimal	No
Rnt_taxrate2	form	decimal	No
Rnt_taxrateorig1	form	decimal	No
Rnt_taxrateorig2	form	decimal	No
Rnt_tcode	form	short	No
Rnt_term	form	short	No
Rnt_tmaint	form	decimal	No
Rnt_tradein	form	decimal	No
Rnt_typer	form	string	No
Rnt_timestamp	form	DateTime	No
Acct	form	int	No
TaxLocation	form	string	No
DefaultDesc	form	string	No
PayoffDesc	form	string	No
School	form	string	No
District	form	string	No
Ref	form	string	No
AutoPayDeclined	form	bool	No
Inventory	form	List<ContractInventoryInfo>	No
CardInfo	form	CcInfo	No
ContractCalculatedFields	form	ContractCalculatedFields	No
Payments	form	List<PaymentGeneric>	No
Rnt_avacodeprin	form	string	No
Rnt_avacodemaint	form	string	No
Rnt_avacodelate	form	string	No
Rnt_avacodelease	form	string	No
Rnt_avacodefin	form	string	No
Rnt_scheduledreturndate	form	DateTime	No
Rnt_scheduledreturnoption	form	string	No
Rnt_scheduledreturnnotes	form	string	No
Rnt_scheduledreturnstatus	form	string	No

**ContractInventoryInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
BeginDate	form	DateTime	No
Cat	form	int	No
Cost	form	decimal?	No
Description	form	string	No
Discount	form	decimal	No
Dunn	form	string	No
EndDate	form	DateTime	No
InvType	form	string	No
Notes	form	string	No
OurPrice	form	decimal	No
Qty	form	decimal	No
ReceiptNotes	form	string	No
Serial	form	string	No
Sub	form	int	No
Total	form	decimal	No
Sku	form	string	No
Mfg	form	string	No

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

**ContractCalculatedFields** Parameters:
Name	Parameter	Data Type	Required
Terms	form	int	No
PayStream	form	int	No
FinalPay	form	decimal	No
AmountDue	form	decimal	No
Payoff	form	decimal	No
DiscountedPayoff	form	decimal	No
RebateFc	form	decimal	No
TotalLate	form	decimal	No
PaymentsLate	form	decimal	No
PaymentsAhead	form	int	No
TotalMaintOwed	form	decimal	No
CurrentPlusNext	form	decimal	No
PayoffDate	form	DateTime	No
CreditAmount	form	decimal	No
PrinLessTax	form	decimal	No
MaintLessTax	form	decimal	No
AFeeLessTax	form	decimal	No
PaymentTax	form	decimal	No
RentDueInfo	form	List<ContractValuesObject>	No
PayoffInfo	form	List<ContractValuesObject>	No
Notice	form	string	No
Notice2	form	string	No

**ContractValuesObject** Parameters:
Name	Parameter	Data Type	Required
Position	form	int	No
Display	form	string	No
Value	form	decimal	No

**PaymentGeneric** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime	No
Amount	form	decimal	No
Ref	form	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.

GET /api/ContractFullDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractFullDetailsResponse 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>
  <Contracts>
    <ContractInfo>
      <Acct>0</Acct>
      <AutoPayDeclined>false</AutoPayDeclined>
      <CardInfo>
        <CardType>String</CardType>
        <Expiration>String</Expiration>
        <LastFour>String</LastFour>
        <Primary>false</Primary>
        <ReasonOnFile>String</ReasonOnFile>
        <TokenPk>0</TokenPk>
        <TokenStr>String</TokenStr>
      </CardInfo>
      <ContractCalculatedFields>
        <AFeeLessTax>0</AFeeLessTax>
        <AmountDue>0</AmountDue>
        <CreditAmount>0</CreditAmount>
        <CurrentPlusNext>0</CurrentPlusNext>
        <DiscountedPayoff>0</DiscountedPayoff>
        <FinalPay>0</FinalPay>
        <MaintLessTax>0</MaintLessTax>
        <Notice>String</Notice>
        <Notice2>String</Notice2>
        <PayStream>0</PayStream>
        <PaymentTax>0</PaymentTax>
        <PaymentsAhead>0</PaymentsAhead>
        <PaymentsLate>0</PaymentsLate>
        <Payoff>0</Payoff>
        <PayoffDate>0001-01-01T00:00:00</PayoffDate>
        <PayoffInfo xmlns:d5p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Global">
          <d5p1:ContractValuesObject>
            <d5p1:Display>String</d5p1:Display>
            <d5p1:Position>0</d5p1:Position>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:ContractValuesObject>
        </PayoffInfo>
        <PrinLessTax>0</PrinLessTax>
        <RebateFc>0</RebateFc>
        <RentDueInfo xmlns:d5p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.Global">
          <d5p1:ContractValuesObject>
            <d5p1:Display>String</d5p1:Display>
            <d5p1:Position>0</d5p1:Position>
            <d5p1:Value>0</d5p1:Value>
          </d5p1:ContractValuesObject>
        </RentDueInfo>
        <Terms>0</Terms>
        <TotalLate>0</TotalLate>
        <TotalMaintOwed>0</TotalMaintOwed>
      </ContractCalculatedFields>
      <DefaultDesc>String</DefaultDesc>
      <District>String</District>
      <Inventory>
        <ContractInventoryInfo>
          <BeginDate>0001-01-01T00:00:00</BeginDate>
          <Cat>0</Cat>
          <Cost>0</Cost>
          <Description>String</Description>
          <Discount>0</Discount>
          <Dunn>String</Dunn>
          <EndDate>0001-01-01T00:00:00</EndDate>
          <Id>0</Id>
          <InvType>String</InvType>
          <Mfg>String</Mfg>
          <Notes>String</Notes>
          <OurPrice>0</OurPrice>
          <Qty>0</Qty>
          <ReceiptNotes>String</ReceiptNotes>
          <Serial>String</Serial>
          <Sku>String</Sku>
          <Sub>0</Sub>
          <Total>0</Total>
        </ContractInventoryInfo>
      </Inventory>
      <Payments xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:PaymentGeneric>
          <d4p1:Amount>0</d4p1:Amount>
          <d4p1:Date>0001-01-01T00:00:00</d4p1:Date>
          <d4p1:Ref>String</d4p1:Ref>
        </d4p1:PaymentGeneric>
      </Payments>
      <PayoffDesc>String</PayoffDesc>
      <Ref>String</Ref>
      <Rnt_afee>0</Rnt_afee>
      <Rnt_alatedbt>false</Rnt_alatedbt>
      <Rnt_amtfin>0</Rnt_amtfin>
      <Rnt_aofinchg>0</Rnt_aofinchg>
      <Rnt_apaydbt>false</Rnt_apaydbt>
      <Rnt_apaytyp>String</Rnt_apaytyp>
      <Rnt_atcode>0</Rnt_atcode>
      <Rnt_autopayhold>0001-01-01T00:00:00</Rnt_autopayhold>
      <Rnt_avacodefin>String</Rnt_avacodefin>
      <Rnt_avacodelate>String</Rnt_avacodelate>
      <Rnt_avacodelease>String</Rnt_avacodelease>
      <Rnt_avacodemaint>String</Rnt_avacodemaint>
      <Rnt_avacodeprin>String</Rnt_avacodeprin>
      <Rnt_avgbal>0</Rnt_avgbal>
      <Rnt_balance>0</Rnt_balance>
      <Rnt_billdays>0</Rnt_billdays>
      <Rnt_cdate>0001-01-01T00:00:00</Rnt_cdate>
      <Rnt_colagency>String</Rnt_colagency>
      <Rnt_colamt>0</Rnt_colamt>
      <Rnt_coupdate>0001-01-01T00:00:00</Rnt_coupdate>
      <Rnt_cramt>0</Rnt_cramt>
      <Rnt_crmo>0</Rnt_crmo>
      <Rnt_currafee>0</Rnt_currafee>
      <Rnt_currbal>0</Rnt_currbal>
      <Rnt_currfc>0</Rnt_currfc>
      <Rnt_currfeetax1>0</Rnt_currfeetax1>
      <Rnt_currfeetax2>0</Rnt_currfeetax2>
      <Rnt_currlte>0</Rnt_currlte>
      <Rnt_currma>0</Rnt_currma>
      <Rnt_curroth>0</Rnt_curroth>
      <Rnt_currprn>0</Rnt_currprn>
      <Rnt_currtax1>0</Rnt_currtax1>
      <Rnt_currtax2>0</Rnt_currtax2>
      <Rnt_dayslate>0</Rnt_dayslate>
      <Rnt_daystlst>0</Rnt_daystlst>
      <Rnt_deprcode>String</Rnt_deprcode>
      <Rnt_discount>0</Rnt_discount>
      <Rnt_downpay>0</Rnt_downpay>
      <Rnt_dunn>String</Rnt_dunn>
      <Rnt_edate>0001-01-01T00:00:00</Rnt_edate>
      <Rnt_exchnotes>String</Rnt_exchnotes>
      <Rnt_fdate>0001-01-01T00:00:00</Rnt_fdate>
      <Rnt_fee>0</Rnt_fee>
      <Rnt_finalpay>0</Rnt_finalpay>
      <Rnt_finchg>0</Rnt_finchg>
      <Rnt_freemos>0</Rnt_freemos>
      <Rnt_intdate>0001-01-01T00:00:00</Rnt_intdate>
      <Rnt_intrate>0</Rnt_intrate>
      <Rnt_irregular>false</Rnt_irregular>
      <Rnt_itcode>0</Rnt_itcode>
      <Rnt_lastpaid>0</Rnt_lastpaid>
      <Rnt_latefee>0</Rnt_latefee>
      <Rnt_latefreq>0</Rnt_latefreq>
      <Rnt_lateowed>0</Rnt_lateowed>
      <Rnt_ldate>0001-01-01T00:00:00</Rnt_ldate>
      <Rnt_ltcode>0</Rnt_ltcode>
      <Rnt_monma>0</Rnt_monma>
      <Rnt_mopayreq>false</Rnt_mopayreq>
      <Rnt_mtcode>0</Rnt_mtcode>
      <Rnt_ndate>0001-01-01T00:00:00</Rnt_ndate>
      <Rnt_nextpayamt>0</Rnt_nextpayamt>
      <Rnt_nextpaynum>0</Rnt_nextpaynum>
      <Rnt_notedate>0001-01-01T00:00:00</Rnt_notedate>
      <Rnt_notes>String</Rnt_notes>
      <Rnt_otherowed>0</Rnt_otherowed>
      <Rnt_payfreq>0</Rnt_payfreq>
      <Rnt_payfreqtype>0</Rnt_payfreqtype>
      <Rnt_payment>0</Rnt_payment>
      <Rnt_paystrm>0</Rnt_paystrm>
      <Rnt_pk>0</Rnt_pk>
      <Rnt_prevamt>0</Rnt_prevamt>
      <Rnt_prevmo>0</Rnt_prevmo>
      <Rnt_price>0</Rnt_price>
      <Rnt_rdate>0001-01-01T00:00:00</Rnt_rdate>
      <Rnt_scheduledreturndate>0001-01-01T00:00:00</Rnt_scheduledreturndate>
      <Rnt_scheduledreturnnotes>String</Rnt_scheduledreturnnotes>
      <Rnt_scheduledreturnoption>String</Rnt_scheduledreturnoption>
      <Rnt_scheduledreturnstatus>String</Rnt_scheduledreturnstatus>
      <Rnt_sdate>0001-01-01T00:00:00</Rnt_sdate>
      <Rnt_student>String</Rnt_student>
      <Rnt_sub>0</Rnt_sub>
      <Rnt_tax>0</Rnt_tax>
      <Rnt_taxrate1>0</Rnt_taxrate1>
      <Rnt_taxrate2>0</Rnt_taxrate2>
      <Rnt_taxrateorig1>0</Rnt_taxrateorig1>
      <Rnt_taxrateorig2>0</Rnt_taxrateorig2>
      <Rnt_tcode>0</Rnt_tcode>
      <Rnt_term>0</Rnt_term>
      <Rnt_timestamp>0001-01-01T00:00:00</Rnt_timestamp>
      <Rnt_tmaint>0</Rnt_tmaint>
      <Rnt_tradein>0</Rnt_tradein>
      <Rnt_typer>String</Rnt_typer>
      <School>String</School>
      <TaxLocation>String</TaxLocation>
    </ContractInfo>
  </Contracts>
  <RemainingRecords>0</RemainingRecords>
</ContractFullDetailsResponse>

AIM Web Services

ContractFullDetailsRequest

ContractFullDetails Requires active-e Contracts Service.

HTTP + XML

ContractFullDetails
Requires active-e Contracts Service.