AIM Web Services

<back to all web services

InvoiceDetailRequest

InvoiceDetail
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/InvoiceDetail
InvoiceDetailRequest Parameters:
NameParameterData TypeRequiredDescription
Acctqueryint?No
InvoiceStartDatequeryDateTime?No
InvoiceEndDatequeryDateTime?No
StartOffsetqueryintegerNoThe Starting Offset. Defaults to 0 if not sent.
RecordCountqueryintegerNoThe # of records to be returned. Defaults to 100 if not sent.
AIMRefquerystringNoThe Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
WebRefquerystringNoThe WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
BaseSecureRequest Parameters:
NameParameterData TypeRequiredDescription
TokenHeaderstringNo
DeviceIdHeaderstringNo
AppIdHeaderstringYes
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
ApiKeyheaderstringYesThis is your AIM API Key provided by Tri-Tech
OAuthTokenheaderstringNo
InvoiceDetailResponse Parameters:
NameParameterData TypeRequiredDescription
InvoicesformList<InvoiceInfo>No
RemainingRecordsformlongNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
StatusbodyBaseResponseResultNo
BaseResponseResult Parameters:
NameParameterData TypeRequiredDescription
StatusCodebodystringNo
LoginbodystringNo
ErrorCodebodystringNo
ErrorDisplayTextbodystringNo
ErrorMessagebodystringNo
DomainNamebodystringNo
IpAddressbodystringNo
InvoiceInfo Parameters:
NameParameterData TypeRequiredDescription
InvoiceNumberformstringNo
DateTimeformDateTimeNo
SoldToAcctformintNo
SoldToNameformstringNo
BillToAcctformintNo
BillToNameformstringNo
TypeformstringNo
POformstringNo
OriginalAmountformdecimalNo
BalanceformdecimalNo
LocationformstringNo
ShipToNameformstringNo
ShipToAddressformstringNo
ShipToIdformlong?No
LineItemsformList<InvoiceLineItem>No
PaymentsformList<InvoicePaymentItem>No
InvoiceLineItem Parameters:
NameParameterData TypeRequiredDescription
QuantityformdecimalNo
SkuformstringNo
DescriptionformstringNo
PriceEachformdecimalNo
ExtendedformdecimalNo
DiscountformdecimalNo
TotalformdecimalNo
OriginalRefformstringNo
NotesformstringNo
SourceformstringNo
InvoicePaymentItem Parameters:
NameParameterData TypeRequiredDescription
PayRefformstringNo
DateTimeformDateTimeNo
AmountformdecimalNo
NotesformstringNo
SourceformstringNo

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/InvoiceDetail HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Invoices":[{"InvoiceNumber":"String","SoldToAcct":0,"SoldToName":"String","BillToAcct":0,"BillToName":"String","Type":"String","PO":"String","OriginalAmount":0,"Balance":0,"Location":"String","ShipToName":"String","ShipToAddress":"String","ShipToId":0,"LineItems":[{"Quantity":0,"Sku":"String","Description":"String","PriceEach":0,"Extended":0,"Discount":0,"Total":0,"OriginalRef":"String","Notes":"String","Source":"String"}],"Payments":[{"PayRef":"String","Amount":0,"Notes":"String","Source":"String"}]}],"RemainingRecords":0,"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}