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
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService

Namespace Global

    Namespace AIM.WebService

        <DataContract>
        Public Partial Class BaseRequest
            '''<Summary>
            '''This is your AIM API Key provided by Tri-Tech
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="This is your AIM API Key provided by Tri-Tech", IsRequired:=true, Name:="ApiKey", ParameterType:="header")>
            Public Overridable Property ApiKey As String

            <DataMember>
            <ApiMember(DataType:="string", Name:="OAuthToken", ParameterType:="header")>
            Public Overridable Property OAuthToken As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        '''<Summary>
        '''InvoiceDetailRequires active-e Customer Service.
        '''</Summary>
        <DataContract>
        Public Partial Class InvoiceDetailRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Acct As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property InvoiceStartDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property InvoiceEndDate As Nullable(Of Date)

            '''<Summary>
            '''The Starting Offset. Defaults to 0 if not sent.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The Starting Offset. Defaults to 0 if not sent.", Format:="int64", Name:="StartOffset")>
            Public Overridable Property StartOffset As Nullable(Of Long)

            '''<Summary>
            '''The # of records to be returned. Defaults to 100 if not sent.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="The # of records to be returned. Defaults to 100 if not sent.", Format:="int64", Name:="RecordCount")>
            Public Overridable Property RecordCount As Nullable(Of Long)

            '''<Summary>
            '''The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount", Name:="AIMRef")>
            Public Overridable Property AIMRef As String

            '''<Summary>
            '''The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount", Name:="WebRef")>
            Public Overridable Property WebRef As String
        End Class

        <DataContract>
        Public Partial Class InvoiceDetailResponse
            Inherits BaseResponse
            Public Sub New()
                Invoices = New List(Of InvoiceInfo)
            End Sub

            <DataMember>
            Public Overridable Property Invoices As List(Of InvoiceInfo)

            <DataMember>
            Public Overridable Property RemainingRecords As Long
        End Class

        <DataContract>
        Public Partial Class InvoiceInfo
            Public Sub New()
                LineItems = New List(Of InvoiceLineItem)
                Payments = New List(Of InvoicePaymentItem)
            End Sub

            <DataMember>
            Public Overridable Property InvoiceNumber As String

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property SoldToAcct As Integer

            <DataMember>
            Public Overridable Property SoldToName As String

            <DataMember>
            Public Overridable Property BillToAcct As Integer

            <DataMember>
            Public Overridable Property BillToName As String

            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property PO As String

            <DataMember>
            Public Overridable Property OriginalAmount As Decimal

            <DataMember>
            Public Overridable Property Balance As Decimal

            <DataMember>
            Public Overridable Property Location As String

            <DataMember>
            Public Overridable Property ShipToName As String

            <DataMember>
            Public Overridable Property ShipToAddress As String

            <DataMember>
            Public Overridable Property ShipToId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property LineItems As List(Of InvoiceLineItem)

            <DataMember>
            Public Overridable Property Payments As List(Of InvoicePaymentItem)
        End Class

        <DataContract>
        Public Partial Class InvoiceLineItem
            <DataMember>
            Public Overridable Property Quantity As Decimal

            <DataMember>
            Public Overridable Property Sku As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property PriceEach As Decimal

            <DataMember>
            Public Overridable Property Extended As Decimal

            <DataMember>
            Public Overridable Property Discount As Decimal

            <DataMember>
            Public Overridable Property Total As Decimal

            <DataMember>
            Public Overridable Property OriginalRef As String

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Source As String
        End Class

        <DataContract>
        Public Partial Class InvoicePaymentItem
            <DataMember>
            Public Overridable Property PayRef As String

            <DataMember>
            Public Overridable Property DateTime As Date

            <DataMember>
            Public Overridable Property Amount As Decimal

            <DataMember>
            Public Overridable Property Notes As String

            <DataMember>
            Public Overridable Property Source As String
        End Class
    End Namespace
End Namespace

VB.NET InvoiceDetailRequest DTOs

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>