GET | /api/History360 |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerAccount | query | int | No | |
IncludeInvoices | query | bool | No | |
IncludeOrders | query | bool | No | |
IncludeWorkOrders | query | bool | No | |
IncludeContracts | query | bool | No | |
IncludeClosed | query | bool | No | |
ClosedStartDate | query | DateTime? | 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 |
---|---|---|---|---|
Invoices | form | List<Invoice360> | No | |
Orders | form | List<Order360> | No | |
WorkOrders | form | List<WorkOrder360> | No | |
Contracts | form | List<Contract360> | 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 |
---|---|---|---|---|
Id | form | string | No | |
DueDate | form | DateTime? | No | |
Total | form | decimal | No | |
Status | form | string | No | |
AmountPaid | form | decimal | No | |
LateFeeAmount | form | decimal | No | |
PurchaseDate | form | DateTime | No | |
StoreLocationId | form | int? | No | |
Items | form | List<Item360> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PslrId | form | long? | No | |
Quantity | form | decimal | No | |
Price | form | decimal | No | |
TotalDiscountAmount | form | decimal | No | |
SerialNumber | form | string | No | |
Condition | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
Date | form | DateTime | No | |
Discount | form | decimal | No | |
PaymentType | form | string | No | |
SubTotal | form | decimal | No | |
Tax | form | decimal | No | |
ShippingAmount | form | decimal | No | |
Total | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
Status | form | string | No | |
Deposit | form | decimal | No | |
StoreLocationId | form | int? | No | |
CreationDate | form | DateTime | No | |
CompletedDate | form | DateTime? | No | |
Price | form | decimal | No | |
Jobs | form | List<Job360> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ItemId | form | string | No | |
ItemType | form | string | No | |
Title | form | string | No | |
Quantity | form | decimal | No | |
Price | form | decimal | No | |
TotalDiscountAmount | form | decimal | No | |
SerialNumber | form | string | No | |
Condition | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | string | No | |
PaymentDate | form | DateTime | No | |
StoreLocationId | form | int? | No | |
AmountDue | form | decimal | No | |
LateFee | form | decimal | No | |
ContractStatus | form | string | No | |
Amount | form | decimal | No | |
ContractItems | form | List<Item360> | 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.
GET /api/History360 HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"Invoices":[{"Id":"String","DueDate":"0001-01-01T00:00:00.0000000","Total":0,"Status":"String","AmountPaid":0,"LateFeeAmount":0,"StoreLocationId":0,"Items":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Orders":[{"Id":0,"Discount":0,"PaymentType":"String","SubTotal":0,"Tax":0,"ShippingAmount":0,"Total":0}],"WorkOrders":[{"Id":"String","Status":"String","Deposit":0,"StoreLocationId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","Price":0,"Jobs":[{"ItemId":"String","ItemType":"String","Title":"String","Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Contracts":[{"Id":"String","StoreLocationId":0,"AmountDue":0,"LateFee":0,"ContractStatus":"String","Amount":0,"ContractItems":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}