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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * GetCustomerHistoryRequires active-e Customer Service.
    */
    @DataContract
    public static class GetCustomerHistoryRequest extends BaseSecureRequest
    {
        @DataMember
        public Boolean GetInvoices = null;

        @DataMember
        public Boolean GetTickets = null;

        @DataMember
        public Boolean GetProposals = null;

        @DataMember
        public Boolean GetContracts = null;

        @DataMember
        public Boolean GetOrders = null;

        @DataMember
        public Boolean GetShortTermRentals = null;

        @DataMember
        public Boolean GetWebPayments = null;

        @DataMember
        public Boolean ShowClosed = null;

        @DataMember
        public Boolean GetPaymentsDue = null;

        @DataMember
        public String DateFrom = null;

        @DataMember
        public String DateTo = null;

        @DataMember
        public Integer Acct = null;

        @DataMember
        public Boolean GetMemberships = null;

        @DataMember
        public Boolean GetPendingWebOrders = null;

        @DataMember
        public Boolean GetFutureTeeTimes = null;

        @DataMember
        public Boolean GetStationReservations = null;

        @DataMember
        public Boolean GetPendingWebRentals = null;

        @DataMember
        public Boolean GetValuePacks = null;

        @DataMember
        public Boolean IncludeUninvoicedScheduling = null;

        @DataMember
        public Boolean IncludeOnHold = null;

        @DataMember
        public Boolean GetConsignments = null;

        @DataMember
        public Boolean GetRecurringHeaderInfo = null;
        
        public Boolean isGetInvoices() { return GetInvoices; }
        public GetCustomerHistoryRequest setGetInvoices(Boolean value) { this.GetInvoices = value; return this; }
        public Boolean isGetTickets() { return GetTickets; }
        public GetCustomerHistoryRequest setGetTickets(Boolean value) { this.GetTickets = value; return this; }
        public Boolean isGetProposals() { return GetProposals; }
        public GetCustomerHistoryRequest setGetProposals(Boolean value) { this.GetProposals = value; return this; }
        public Boolean isGetContracts() { return GetContracts; }
        public GetCustomerHistoryRequest setGetContracts(Boolean value) { this.GetContracts = value; return this; }
        public Boolean isGetOrders() { return GetOrders; }
        public GetCustomerHistoryRequest setGetOrders(Boolean value) { this.GetOrders = value; return this; }
        public Boolean isGetShortTermRentals() { return GetShortTermRentals; }
        public GetCustomerHistoryRequest setGetShortTermRentals(Boolean value) { this.GetShortTermRentals = value; return this; }
        public Boolean isGetWebPayments() { return GetWebPayments; }
        public GetCustomerHistoryRequest setGetWebPayments(Boolean value) { this.GetWebPayments = value; return this; }
        public Boolean isShowClosed() { return ShowClosed; }
        public GetCustomerHistoryRequest setShowClosed(Boolean value) { this.ShowClosed = value; return this; }
        public Boolean isGetPaymentsDue() { return GetPaymentsDue; }
        public GetCustomerHistoryRequest setGetPaymentsDue(Boolean value) { this.GetPaymentsDue = value; return this; }
        public String getDateFrom() { return DateFrom; }
        public GetCustomerHistoryRequest setDateFrom(String value) { this.DateFrom = value; return this; }
        public String getDateTo() { return DateTo; }
        public GetCustomerHistoryRequest setDateTo(String value) { this.DateTo = value; return this; }
        public Integer getAcct() { return Acct; }
        public GetCustomerHistoryRequest setAcct(Integer value) { this.Acct = value; return this; }
        public Boolean isGetMemberships() { return GetMemberships; }
        public GetCustomerHistoryRequest setGetMemberships(Boolean value) { this.GetMemberships = value; return this; }
        public Boolean isGetPendingWebOrders() { return GetPendingWebOrders; }
        public GetCustomerHistoryRequest setGetPendingWebOrders(Boolean value) { this.GetPendingWebOrders = value; return this; }
        public Boolean isGetFutureTeeTimes() { return GetFutureTeeTimes; }
        public GetCustomerHistoryRequest setGetFutureTeeTimes(Boolean value) { this.GetFutureTeeTimes = value; return this; }
        public Boolean isGetStationReservations() { return GetStationReservations; }
        public GetCustomerHistoryRequest setGetStationReservations(Boolean value) { this.GetStationReservations = value; return this; }
        public Boolean isGetPendingWebRentals() { return GetPendingWebRentals; }
        public GetCustomerHistoryRequest setGetPendingWebRentals(Boolean value) { this.GetPendingWebRentals = value; return this; }
        public Boolean isGetValuePacks() { return GetValuePacks; }
        public GetCustomerHistoryRequest setGetValuePacks(Boolean value) { this.GetValuePacks = value; return this; }
        public Boolean isIncludeUninvoicedScheduling() { return IncludeUninvoicedScheduling; }
        public GetCustomerHistoryRequest setIncludeUninvoicedScheduling(Boolean value) { this.IncludeUninvoicedScheduling = value; return this; }
        public Boolean isIncludeOnHold() { return IncludeOnHold; }
        public GetCustomerHistoryRequest setIncludeOnHold(Boolean value) { this.IncludeOnHold = value; return this; }
        public Boolean isGetConsignments() { return GetConsignments; }
        public GetCustomerHistoryRequest setGetConsignments(Boolean value) { this.GetConsignments = value; return this; }
        public Boolean isGetRecurringHeaderInfo() { return GetRecurringHeaderInfo; }
        public GetCustomerHistoryRequest setGetRecurringHeaderInfo(Boolean value) { this.GetRecurringHeaderInfo = value; return this; }
    }

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

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

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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 String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class GetCustomerHistoryResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<CustomerHistoryGeneric> CustomerHistory = null;
        
        public ArrayList<CustomerHistoryGeneric> getCustomerHistory() { return CustomerHistory; }
        public GetCustomerHistoryResponse setCustomerHistory(ArrayList<CustomerHistoryGeneric> value) { this.CustomerHistory = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class CustomerHistoryGeneric
    {
        @DataMember
        public Date Date = null;

        @DataMember
        public String DateStr = null;

        @DataMember
        public String Ref = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public BigDecimal Amount = null;

        @DataMember
        public BigDecimal OrigAmount = null;

        @DataMember
        public Boolean Late = null;

        @DataMember
        public String RefType = null;

        @DataMember
        public String PO = null;

        @DataMember
        public Date EstReceivedDate = null;
        
        public Date getDate() { return Date; }
        public CustomerHistoryGeneric setDate(Date value) { this.Date = value; return this; }
        public String getDateStr() { return DateStr; }
        public CustomerHistoryGeneric setDateStr(String value) { this.DateStr = value; return this; }
        public String getRef() { return Ref; }
        public CustomerHistoryGeneric setRef(String value) { this.Ref = value; return this; }
        public String getDesc() { return Desc; }
        public CustomerHistoryGeneric setDesc(String value) { this.Desc = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public CustomerHistoryGeneric setAmount(BigDecimal value) { this.Amount = value; return this; }
        public BigDecimal getOrigAmount() { return OrigAmount; }
        public CustomerHistoryGeneric setOrigAmount(BigDecimal value) { this.OrigAmount = value; return this; }
        public Boolean isLate() { return Late; }
        public CustomerHistoryGeneric setLate(Boolean value) { this.Late = value; return this; }
        public String getRefType() { return RefType; }
        public CustomerHistoryGeneric setRefType(String value) { this.RefType = value; return this; }
        public String getPo() { return PO; }
        public CustomerHistoryGeneric setPo(String value) { this.PO = value; return this; }
        public Date getEstReceivedDate() { return EstReceivedDate; }
        public CustomerHistoryGeneric setEstReceivedDate(Date value) { this.EstReceivedDate = value; return this; }
    }

}

Java 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"}}