AIM Web Services

<back to all web services

GetContractDetailsRequest

GetContractDetails
Requires active-e Contracts Service or active-e Customer Service

The following routes are available for this service:
POST, GET/api/GetContractDetails
"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 InventoryGeneric {
    /** @param {{Model?:string,Item?:string,Sku?:string,Serial?:string,Desc?:string,Mfg?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Model;
    /** @type {string} */
    Item;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Serial;
    /** @type {string} */
    Desc;
    /** @type {string} */
    Mfg;
}
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 GetContractDetailsResponse extends BaseResponse {
    /** @param {{AccountSub?:string,NextDueDate?:string,PaymentAmount?:number,PastDueAmount?:number,LateCharges?:number,OtherCharges?:number,TotalDue?:number,AccumulatedCredit?:number,StudentName?:string,SchoolName?:string,Topic?:string,Inventory?:InventoryGeneric[],Payments?:PaymentGeneric[],PaymentAmt?:number,PastDueAmt?:number,CurrentBalance?:number,TotalPayoff?:number,DiscountedPayoff?:number,PayoffDate?:string,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AccountSub;
    /** @type {string} */
    NextDueDate;
    /** @type {number} */
    PaymentAmount;
    /** @type {number} */
    PastDueAmount;
    /** @type {number} */
    LateCharges;
    /** @type {number} */
    OtherCharges;
    /** @type {number} */
    TotalDue;
    /** @type {number} */
    AccumulatedCredit;
    /** @type {string} */
    StudentName;
    /** @type {string} */
    SchoolName;
    /** @type {string} */
    Topic;
    /** @type {InventoryGeneric[]} */
    Inventory;
    /** @type {PaymentGeneric[]} */
    Payments;
    /** @type {number} */
    PaymentAmt;
    /** @type {number} */
    PastDueAmt;
    /** @type {number} */
    CurrentBalance;
    /** @type {number} */
    TotalPayoff;
    /** @type {?number} */
    DiscountedPayoff;
    /** @type {string} */
    PayoffDate;
}
export class GetContractDetailsRequest extends BaseSecureRequest {
    /** @param {{Ref?:string,Sub?:number,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Ref;
    /** @type {?number} */
    Sub;
}

JavaScript GetContractDetailsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/GetContractDetails HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Ref":"String","Sub":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"AccountSub":"String","PaymentAmount":0,"PastDueAmount":0,"LateCharges":0,"OtherCharges":0,"TotalDue":0,"AccumulatedCredit":0,"StudentName":"String","SchoolName":"String","Topic":"String","Inventory":[{"Model":"String","Item":"String","Sku":"String","Serial":"String","Desc":"String","Mfg":"String"}],"Payments":[{"Amount":0,"Ref":"String"}],"PaymentAmt":0,"PastDueAmt":0,"CurrentBalance":0,"TotalPayoff":0,"DiscountedPayoff":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}