AIM Web Services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET	/api/History360

**History360Request** Parameters:
Name	Parameter	Data Type	Required
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

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**History360Response** Parameters:
Name	Parameter	Data Type	Required
Invoices	form	List<Invoice360>	No
Orders	form	List<Order360>	No
WorkOrders	form	List<WorkOrder360>	No
Contracts	form	List<Contract360>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
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

**Invoice360** Parameters:
Name	Parameter	Data Type	Required
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

**Item360** Parameters:
Name	Parameter	Data Type	Required
PslrId	form	long?	No
Quantity	form	decimal	No
Price	form	decimal	No
TotalDiscountAmount	form	decimal	No
SerialNumber	form	string	No
Condition	form	string	No

**Order360** Parameters:
Name	Parameter	Data Type	Required
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

**WorkOrder360** Parameters:
Name	Parameter	Data Type	Required
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

**Job360** Parameters:
Name	Parameter	Data Type	Required
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

**Contract360** Parameters:
Name	Parameter	Data Type	Required
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 .xml suffix or ?format=xml

HTTP + 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>
      <PaymentDate>0001-01-01T00:00:00</PaymentDate>
      <StoreLocationId>0</StoreLocationId>
    </Contract360>
  </Contracts>
  <Invoices>
    <Invoice360>
      <AmountPaid>0</AmountPaid>
      <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>
      <PurchaseDate>0001-01-01T00:00:00</PurchaseDate>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
      <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>
      <Price>0</Price>
      <Status>String</Status>
      <StoreLocationId>0</StoreLocationId>
    </WorkOrder360>
  </WorkOrders>
</History360Response>

AIM Web Services

History360Request

History360 Requires active-e Customer Service.

HTTP + XML

History360
Requires active-e Customer Service.