AIM Web Services

<back to all web services

GetCustomerHistoryRequest

GetCustomerHistory
Requires active-e Customer Service.

The following routes are available for this service:
POST, GET/api/GetCustomerHistory
"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 CustomerHistoryGeneric {
    /** @param {{Date?:string,DateStr?:string,Ref?:string,Desc?:string,Amount?:number,OrigAmount?:number,Late?:boolean,RefType?:string,PO?:string,EstReceivedDate?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {string} */
    DateStr;
    /** @type {string} */
    Ref;
    /** @type {string} */
    Desc;
    /** @type {number} */
    Amount;
    /** @type {number} */
    OrigAmount;
    /** @type {boolean} */
    Late;
    /** @type {string} */
    RefType;
    /** @type {string} */
    PO;
    /** @type {?string} */
    EstReceivedDate;
}
export class GetCustomerHistoryResponse extends BaseResponse {
    /** @param {{CustomerHistory?:CustomerHistoryGeneric[],Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {CustomerHistoryGeneric[]} */
    CustomerHistory;
}
export class GetCustomerHistoryRequest extends BaseSecureRequest {
    /** @param {{GetInvoices?:boolean,GetTickets?:boolean,GetProposals?:boolean,GetContracts?:boolean,GetOrders?:boolean,GetShortTermRentals?:boolean,GetWebPayments?:boolean,ShowClosed?:boolean,GetPaymentsDue?:boolean,DateFrom?:string,DateTo?:string,Acct?:number,GetMemberships?:boolean,GetPendingWebOrders?:boolean,GetFutureTeeTimes?:boolean,GetStationReservations?:boolean,GetPendingWebRentals?:boolean,GetValuePacks?:boolean,IncludeUninvoicedScheduling?:boolean,IncludeOnHold?:boolean,GetConsignments?:boolean,GetRecurringHeaderInfo?:boolean,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?boolean} */
    GetInvoices;
    /** @type {?boolean} */
    GetTickets;
    /** @type {?boolean} */
    GetProposals;
    /** @type {?boolean} */
    GetContracts;
    /** @type {?boolean} */
    GetOrders;
    /** @type {?boolean} */
    GetShortTermRentals;
    /** @type {?boolean} */
    GetWebPayments;
    /** @type {?boolean} */
    ShowClosed;
    /** @type {?boolean} */
    GetPaymentsDue;
    /** @type {string} */
    DateFrom;
    /** @type {string} */
    DateTo;
    /** @type {?number} */
    Acct;
    /** @type {?boolean} */
    GetMemberships;
    /** @type {?boolean} */
    GetPendingWebOrders;
    /** @type {?boolean} */
    GetFutureTeeTimes;
    /** @type {?boolean} */
    GetStationReservations;
    /** @type {?boolean} */
    GetPendingWebRentals;
    /** @type {?boolean} */
    GetValuePacks;
    /** @type {?boolean} */
    IncludeUninvoicedScheduling;
    /** @type {?boolean} */
    IncludeOnHold;
    /** @type {?boolean} */
    GetConsignments;
    /** @type {?boolean} */
    GetRecurringHeaderInfo;
}

JavaScript GetCustomerHistoryRequest 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.

POST /api/GetCustomerHistory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"GetInvoices":false,"GetTickets":false,"GetProposals":false,"GetContracts":false,"GetOrders":false,"GetShortTermRentals":false,"GetWebPayments":false,"ShowClosed":false,"GetPaymentsDue":false,"DateFrom":"String","DateTo":"String","Acct":0,"GetMemberships":false,"GetPendingWebOrders":false,"GetFutureTeeTimes":false,"GetStationReservations":false,"GetPendingWebRentals":false,"GetValuePacks":false,"IncludeUninvoicedScheduling":false,"IncludeOnHold":false,"GetConsignments":false,"GetRecurringHeaderInfo":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"CustomerHistory":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}