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 | The Login Token return by the Security API. Required for secured calls. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ApiKey | Header | string | Yes | This is your AIM API Key provided by Tri-Tech |
OAuthToken | Header | string | Yes | The OAuthToken token return by AeServices30 |
DeviceId | Header | string | No | The Device ID of the Mobile Device. Not used for non-mobile devices. |
AppId | Header | string | Yes | An identifier for your integration |
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 | |
PaymentType | form | string | No | |
LateFeeAmount | form | decimal | No | |
PurchaseDate | form | DateTime | No | |
StoreLocationId | form | int? | No | |
Discount | form | decimal | No | |
Tax | form | decimal | No | |
Shipping | form | decimal | 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 | |
LocationName | form | string | 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 | |
LocationName | form | string | No | |
ContractItems | form | List<Item360> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <History360Response 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> <Contracts> <Contract360> <Amount>0</Amount> <AmountDue>0</AmountDue> <ContractItems> <Item360> <Condition>String</Condition> <Price>0</Price> <PslrId>0</PslrId> <Quantity>0</Quantity> <SerialNumber>String</SerialNumber> <TotalDiscountAmount>0</TotalDiscountAmount> </Item360> </ContractItems> <ContractStatus>String</ContractStatus> <Id>String</Id> <LateFee>0</LateFee> <LocationName>String</LocationName> <PaymentDate>0001-01-01T00:00:00</PaymentDate> <StoreLocationId>0</StoreLocationId> </Contract360> </Contracts> <Invoices> <Invoice360> <AmountPaid>0</AmountPaid> <Discount>0</Discount> <DueDate>0001-01-01T00:00:00</DueDate> <Id>String</Id> <Items> <Item360> <Condition>String</Condition> <Price>0</Price> <PslrId>0</PslrId> <Quantity>0</Quantity> <SerialNumber>String</SerialNumber> <TotalDiscountAmount>0</TotalDiscountAmount> </Item360> </Items> <LateFeeAmount>0</LateFeeAmount> <PaymentType>String</PaymentType> <PurchaseDate>0001-01-01T00:00:00</PurchaseDate> <Shipping>0</Shipping> <Status>String</Status> <StoreLocationId>0</StoreLocationId> <Tax>0</Tax> <Total>0</Total> </Invoice360> </Invoices> <Orders> <Order360> <Date>0001-01-01T00:00:00</Date> <Discount>0</Discount> <Id>0</Id> <PaymentType>String</PaymentType> <ShippingAmount>0</ShippingAmount> <SubTotal>0</SubTotal> <Tax>0</Tax> <Total>0</Total> </Order360> </Orders> <WorkOrders> <WorkOrder360> <CompletedDate>0001-01-01T00:00:00</CompletedDate> <CreationDate>0001-01-01T00:00:00</CreationDate> <Deposit>0</Deposit> <Id>String</Id> <Jobs> <Job360> <Condition>String</Condition> <ItemId>String</ItemId> <ItemType>String</ItemType> <Price>0</Price> <Quantity>0</Quantity> <SerialNumber>String</SerialNumber> <Title>String</Title> <TotalDiscountAmount>0</TotalDiscountAmount> </Job360> </Jobs> <LocationName>String</LocationName> <Price>0</Price> <Status>String</Status> <StoreLocationId>0</StoreLocationId> </WorkOrder360> </WorkOrders> </History360Response>