AIM Web Services

<back to all web services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/History360
History360Request Parameters:
NameParameterData TypeRequiredDescription
CustomerAccountqueryintNo
IncludeInvoicesqueryboolNo
IncludeOrdersqueryboolNo
IncludeWorkOrdersqueryboolNo
IncludeContractsqueryboolNo
IncludeClosedqueryboolNo
ClosedStartDatequeryDateTime?No
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
History360Response Parameters:
NameParameterData TypeRequiredDescription
InvoicesformList<Invoice360>No
OrdersformList<Order360>No
WorkOrdersformList<WorkOrder360>No
ContractsformList<Contract360>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
Invoice360 Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DueDateformDateTime?No
TotalformdecimalNo
StatusformstringNo
AmountPaidformdecimalNo
LateFeeAmountformdecimalNo
PurchaseDateformDateTimeNo
StoreLocationIdformint?No
ItemsformList<Item360>No
Item360 Parameters:
NameParameterData TypeRequiredDescription
PslrIdformlong?No
QuantityformdecimalNo
PriceformdecimalNo
TotalDiscountAmountformdecimalNo
SerialNumberformstringNo
ConditionformstringNo
Order360 Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
DateformDateTimeNo
DiscountformdecimalNo
PaymentTypeformstringNo
SubTotalformdecimalNo
TaxformdecimalNo
ShippingAmountformdecimalNo
TotalformdecimalNo
WorkOrder360 Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
StatusformstringNo
DepositformdecimalNo
StoreLocationIdformint?No
CreationDateformDateTimeNo
CompletedDateformDateTime?No
PriceformdecimalNo
JobsformList<Job360>No
Job360 Parameters:
NameParameterData TypeRequiredDescription
ItemIdformstringNo
ItemTypeformstringNo
TitleformstringNo
QuantityformdecimalNo
PriceformdecimalNo
TotalDiscountAmountformdecimalNo
SerialNumberformstringNo
ConditionformstringNo
Contract360 Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
PaymentDateformDateTimeNo
StoreLocationIdformint?No
AmountDueformdecimalNo
LateFeeformdecimalNo
ContractStatusformstringNo
AmountformdecimalNo
ContractItemsformList<Item360>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + 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"}}