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

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

<GetCustomerHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <DateFrom>String</DateFrom>
  <DateTo>String</DateTo>
  <GetConsignments>false</GetConsignments>
  <GetContracts>false</GetContracts>
  <GetFutureTeeTimes>false</GetFutureTeeTimes>
  <GetInvoices>false</GetInvoices>
  <GetMemberships>false</GetMemberships>
  <GetOrders>false</GetOrders>
  <GetPaymentsDue>false</GetPaymentsDue>
  <GetPendingWebOrders>false</GetPendingWebOrders>
  <GetPendingWebRentals>false</GetPendingWebRentals>
  <GetProposals>false</GetProposals>
  <GetRecurringHeaderInfo>false</GetRecurringHeaderInfo>
  <GetShortTermRentals>false</GetShortTermRentals>
  <GetStationReservations>false</GetStationReservations>
  <GetTickets>false</GetTickets>
  <GetValuePacks>false</GetValuePacks>
  <GetWebPayments>false</GetWebPayments>
  <IncludeOnHold>false</IncludeOnHold>
  <IncludeUninvoicedScheduling>false</IncludeUninvoicedScheduling>
  <ShowClosed>false</ShowClosed>
</GetCustomerHistoryRequest>

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

<GetCustomerHistoryResponse 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>
  <CustomerHistory xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:CustomerHistoryGeneric i:nil="true" />
  </CustomerHistory>
</GetCustomerHistoryResponse>