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 java.io.InputStream
import net.servicestack.client.*


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

    @DataMember
    open var InvoiceStartDate:Date? = null

    @DataMember
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open 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")
    open var AppId:String? = null
}

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

    @DataMember
    open var RemainingRecords:Long? = null
}

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

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

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

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

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

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

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

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

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

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var SoldToAcct:Int? = null

    @DataMember
    open var SoldToName:String? = null

    @DataMember
    open var BillToAcct:Int? = null

    @DataMember
    open var BillToName:String? = null

    @DataMember
    open var Type:String? = null

    @DataMember
    open var PO:String? = null

    @DataMember
    open var OriginalAmount:BigDecimal? = null

    @DataMember
    open var Balance:BigDecimal? = null

    @DataMember
    open var Location:String? = null

    @DataMember
    open var ShipToName:String? = null

    @DataMember
    open var ShipToAddress:String? = null

    @DataMember
    open var ShipToId:Long? = null

    @DataMember
    open var LineItems:ArrayList<InvoiceLineItem>? = null

    @DataMember
    open var Payments:ArrayList<InvoicePaymentItem>? = null
}

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

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var PriceEach:BigDecimal? = null

    @DataMember
    open var Extended:BigDecimal? = null

    @DataMember
    open var Discount:BigDecimal? = null

    @DataMember
    open var Total:BigDecimal? = null

    @DataMember
    open var OriginalRef:String? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Source:String? = null
}

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

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var Amount:BigDecimal? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var Source:String? = null
}

Kotlin InvoiceDetailRequest DTOs

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"}}