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()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

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

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId: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

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken: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 .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}