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
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* InvoiceDetailRequires active-e Customer Service.
*/
@DataContract
open class InvoiceDetailRequest : BaseSecureRequest()
{
    @DataMember
    var Acct:Int? = null

    @DataMember
    var InvoiceStartDate:Date? = null

    @DataMember
    var InvoiceEndDate:Date? = null

    /**
    * The Starting Offset. Defaults to 0 if not sent.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The Starting Offset. Defaults to 0 if not sent.", Format="int64", Name="StartOffset")
    var StartOffset:Long? = null

    /**
    * The # of records to be returned. Defaults to 100 if not sent.
    */
    @DataMember
    @ApiMember(DataType="integer", Description="The # of records to be returned. Defaults to 100 if not sent.", Format="int64", Name="RecordCount")
    var RecordCount:Long? = null

    /**
    * The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
    */
    @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")
    var AIMRef:String? = null

    /**
    * The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount
    */
    @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")
    var WebRef:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * The Login Token return by the Security API. Required for secured calls.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")
    var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    var OAuthToken:String? = null

    /**
    * The Device ID of the Mobile Device. Not used for non-mobile devices.
    */
    @DataMember
    @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class InvoiceDetailResponse : BaseResponse()
{
    @DataMember
    var Invoices:ArrayList<InvoiceInfo> = ArrayList<InvoiceInfo>()

    @DataMember
    var RemainingRecords:Long? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class InvoiceInfo
{
    @DataMember
    var InvoiceNumber:String? = null

    @DataMember
    var DateTime:Date? = null

    @DataMember
    var SoldToAcct:Int? = null

    @DataMember
    var SoldToName:String? = null

    @DataMember
    var BillToAcct:Int? = null

    @DataMember
    var BillToName:String? = null

    @DataMember
    var Type:String? = null

    @DataMember
    var PO:String? = null

    @DataMember
    var OriginalAmount:BigDecimal? = null

    @DataMember
    var Balance:BigDecimal? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var ShipToName:String? = null

    @DataMember
    var ShipToAddress:String? = null

    @DataMember
    var ShipToId:Long? = null

    @DataMember
    var LineItems:ArrayList<InvoiceLineItem> = ArrayList<InvoiceLineItem>()

    @DataMember
    var Payments:ArrayList<InvoicePaymentItem> = ArrayList<InvoicePaymentItem>()
}

@DataContract
open class InvoiceLineItem
{
    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var PriceEach:BigDecimal? = null

    @DataMember
    var Extended:BigDecimal? = null

    @DataMember
    var Discount:BigDecimal? = null

    @DataMember
    var Total:BigDecimal? = null

    @DataMember
    var OriginalRef:String? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Source:String? = null
}

@DataContract
open class InvoicePaymentItem
{
    @DataMember
    var PayRef:String? = null

    @DataMember
    var DateTime:Date? = null

    @DataMember
    var Amount:BigDecimal? = null

    @DataMember
    var Notes:String? = null

    @DataMember
    var Source:String? = null
}

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