| POST, GET | /api/GetCustomerHistory |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GetInvoices | body | bool? | No | |
| GetTickets | body | bool? | No | |
| GetProposals | body | bool? | No | |
| GetContracts | body | bool? | No | |
| GetOrders | body | bool? | No | |
| GetShortTermRentals | body | bool? | No | |
| GetWebPayments | body | bool? | No | |
| ShowClosed | body | bool? | No | |
| GetPaymentsDue | body | bool? | No | |
| DateFrom | body | string | No | |
| DateTo | body | string | No | |
| Acct | body | int? | No | |
| GetMemberships | body | bool? | No | |
| GetPendingWebOrders | body | bool? | No | |
| GetFutureTeeTimes | body | bool? | No | |
| GetStationReservations | body | bool? | No | |
| GetPendingWebRentals | body | bool? | No | |
| GetValuePacks | body | bool? | No | |
| IncludeUninvoicedScheduling | body | bool? | No | |
| IncludeOnHold | body | bool? | No | |
| GetConsignments | body | bool? | No | |
| GetRecurringHeaderInfo | body | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Token | Header | string | No | |
| DeviceId | Header | string | No | |
| AppId | Header | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ApiKey | header | string | Yes | This is your AIM API Key provided by Tri-Tech |
| OAuthToken | header | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CustomerHistory | form | List<CustomerHistoryGeneric> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Status | body | BaseResponseResult | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| 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 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Date | form | DateTime | No | |
| DateStr | form | string | No | |
| Ref | form | string | No | |
| Desc | form | string | No | |
| Amount | form | decimal | No | |
| OrigAmount | form | decimal | No | |
| Late | form | bool | No | |
| RefType | form | string | No | |
| PO | form | string | No | |
| EstReceivedDate | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: text/jsonl
Content-Length: length
{"CustomerHistory":[{}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}