| GET | /api/InvoiceDetail |
|---|
namespace AIM.WebService
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponseResult() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
member val StatusCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
member val Login:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
member val ErrorCode:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
member val ErrorDisplayText:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
member val ErrorMessage:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
member val DomainName:String = null with get,set
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
member val IpAddress:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseResponse() =
///<summary>
///
///</summary>
[<DataMember>]
[<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
member val Status:BaseResponseResult = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type InvoiceLineItem() =
[<DataMember>]
member val Quantity:Decimal = new Decimal() with get,set
[<DataMember>]
member val Sku:String = null with get,set
[<DataMember>]
member val Description:String = null with get,set
[<DataMember>]
member val PriceEach:Decimal = new Decimal() with get,set
[<DataMember>]
member val Extended:Decimal = new Decimal() with get,set
[<DataMember>]
member val Discount:Decimal = new Decimal() with get,set
[<DataMember>]
member val Total:Decimal = new Decimal() with get,set
[<DataMember>]
member val OriginalRef:String = null with get,set
[<DataMember>]
member val Notes:String = null with get,set
[<DataMember>]
member val Source:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type InvoicePaymentItem() =
[<DataMember>]
member val PayRef:String = null with get,set
[<DataMember>]
member val DateTime:DateTime = new DateTime() with get,set
[<DataMember>]
member val Amount:Decimal = new Decimal() with get,set
[<DataMember>]
member val Notes:String = null with get,set
[<DataMember>]
member val Source:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type InvoiceInfo() =
[<DataMember>]
member val InvoiceNumber:String = null with get,set
[<DataMember>]
member val DateTime:DateTime = new DateTime() with get,set
[<DataMember>]
member val SoldToAcct:Int32 = new Int32() with get,set
[<DataMember>]
member val SoldToName:String = null with get,set
[<DataMember>]
member val BillToAcct:Int32 = new Int32() with get,set
[<DataMember>]
member val BillToName:String = null with get,set
[<DataMember>]
member val Type:String = null with get,set
[<DataMember>]
member val PO:String = null with get,set
[<DataMember>]
member val OriginalAmount:Decimal = new Decimal() with get,set
[<DataMember>]
member val Balance:Decimal = new Decimal() with get,set
[<DataMember>]
member val Location:String = null with get,set
[<DataMember>]
member val ShipToName:String = null with get,set
[<DataMember>]
member val ShipToAddress:String = null with get,set
[<DataMember>]
member val ShipToId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataMember>]
member val LineItems:ResizeArray<InvoiceLineItem> = new ResizeArray<InvoiceLineItem>() with get,set
[<DataMember>]
member val Payments:ResizeArray<InvoicePaymentItem> = new ResizeArray<InvoicePaymentItem>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type InvoiceDetailResponse() =
inherit BaseResponse()
[<DataMember>]
member val Invoices:ResizeArray<InvoiceInfo> = new ResizeArray<InvoiceInfo>() with get,set
[<DataMember>]
member val RemainingRecords:Int64 = new Int64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type 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")>]
member val ApiKey:String = null with get,set
///<summary>
///The OAuthToken token return by AeServices30
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")>]
member val OAuthToken:String = null with get,set
///<summary>
///The Device ID of the Mobile Device. Not used for non-mobile devices.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")>]
member val DeviceId:String = null with get,set
///<summary>
///An identifier for your integration
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")>]
member val AppId:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type BaseSecureRequest() =
inherit BaseRequest()
///<summary>
///The Login Token return by the Security API. Required for secured calls.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")>]
member val Token:String = null with get,set
///<summary>
///InvoiceDetailRequires active-e Customer Service.
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type InvoiceDetailRequest() =
inherit BaseSecureRequest()
[<DataMember>]
member val Acct:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val InvoiceStartDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember>]
member val InvoiceEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<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")>]
member val StartOffset:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val RecordCount:Nullable<Int64> = new Nullable<Int64>() with get,set
///<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")>]
member val AIMRef:String = null with get,set
///<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")>]
member val WebRef:String = null with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>