AIM Web Services

InvoiceDetailRequest

InvoiceDetail
Requires active-e Customer Service.

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

**InvoiceDetailRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Acct	query	int?	No
InvoiceStartDate	query	DateTime?	No
InvoiceEndDate	query	DateTime?	No
StartOffset	query	integer	No	The Starting Offset. Defaults to 0 if not sent.
RecordCount	query	integer	No	The # of records to be returned. Defaults to 100 if not sent.
AIMRef	query	string	No	The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
WebRef	query	string	No	The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount

**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

**InvoiceDetailResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Invoices	form	List<InvoiceInfo>	No
RemainingRecords	form	long	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

**InvoiceInfo** Parameters:
Name	Parameter	Data Type	Required
InvoiceNumber	form	string	No
DateTime	form	DateTime	No
SoldToAcct	form	int	No
SoldToName	form	string	No
BillToAcct	form	int	No
BillToName	form	string	No
Type	form	string	No
PO	form	string	No
OriginalAmount	form	decimal	No
Balance	form	decimal	No
Location	form	string	No
ShipToName	form	string	No
ShipToAddress	form	string	No
ShipToId	form	long?	No
LineItems	form	List<InvoiceLineItem>	No
Payments	form	List<InvoicePaymentItem>	No

**InvoiceLineItem** Parameters:
Name	Parameter	Data Type	Required
Quantity	form	decimal	No
Sku	form	string	No
Description	form	string	No
PriceEach	form	decimal	No
Extended	form	decimal	No
Discount	form	decimal	No
Total	form	decimal	No
OriginalRef	form	string	No
Notes	form	string	No
Source	form	string	No

**InvoicePaymentItem** Parameters:
Name	Parameter	Data Type	Required
PayRef	form	string	No
DateTime	form	DateTime	No
Amount	form	decimal	No
Notes	form	string	No
Source	form	string	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/InvoiceDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InvoiceDetailResponse 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>
  <Invoices>
    <InvoiceInfo>
      <Balance>0</Balance>
      <BillToAcct>0</BillToAcct>
      <BillToName>String</BillToName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <InvoiceNumber>String</InvoiceNumber>
      <LineItems>
        <InvoiceLineItem>
          <Description>String</Description>
          <Discount>0</Discount>
          <Extended>0</Extended>
          <Notes>String</Notes>
          <OriginalRef>String</OriginalRef>
          <PriceEach>0</PriceEach>
          <Quantity>0</Quantity>
          <Sku>String</Sku>
          <Source>String</Source>
          <Total>0</Total>
        </InvoiceLineItem>
      </LineItems>
      <Location>String</Location>
      <OriginalAmount>0</OriginalAmount>
      <PO>String</PO>
      <Payments>
        <InvoicePaymentItem>
          <Amount>0</Amount>
          <DateTime>0001-01-01T00:00:00</DateTime>
          <Notes>String</Notes>
          <PayRef>String</PayRef>
          <Source>String</Source>
        </InvoicePaymentItem>
      </Payments>
      <ShipToAddress>String</ShipToAddress>
      <ShipToId>0</ShipToId>
      <ShipToName>String</ShipToName>
      <SoldToAcct>0</SoldToAcct>
      <SoldToName>String</SoldToName>
      <Type>String</Type>
    </InvoiceInfo>
  </Invoices>
  <RemainingRecords>0</RemainingRecords>
</InvoiceDetailResponse>

AIM Web Services

InvoiceDetailRequest

InvoiceDetail Requires active-e Customer Service.

HTTP + XML

InvoiceDetail
Requires active-e Customer Service.