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

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 virtual string ApiKey { 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")]
        public virtual string OAuthToken { 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")]
        public virtual string? DeviceId { 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")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult? Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string? StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string? Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string? ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string? ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string? ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string? DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string? IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : 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")]
        public virtual string? Token { get; set; }
    }

    ///<summary>
    ///InvoiceDetailRequires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class InvoiceDetailRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int? Acct { get; set; }

        [DataMember]
        public virtual DateTime? InvoiceStartDate { get; set; }

        [DataMember]
        public virtual DateTime? InvoiceEndDate { 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")]
        public virtual long? StartOffset { 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")]
        public virtual long? RecordCount { 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")]
        public virtual string? AIMRef { 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")]
        public virtual string? WebRef { get; set; }
    }

    [DataContract]
    public partial class InvoiceDetailResponse
        : BaseResponse
    {
        [DataMember]
        public virtual List<InvoiceInfo>? Invoices { get; set; }

        [DataMember]
        public virtual long RemainingRecords { get; set; }
    }

    [DataContract]
    public partial class InvoiceInfo
    {
        [DataMember]
        public virtual string? InvoiceNumber { get; set; }

        [DataMember]
        public virtual DateTime DateTime { get; set; }

        [DataMember]
        public virtual int SoldToAcct { get; set; }

        [DataMember]
        public virtual string? SoldToName { get; set; }

        [DataMember]
        public virtual int BillToAcct { get; set; }

        [DataMember]
        public virtual string? BillToName { get; set; }

        [DataMember]
        public virtual string? Type { get; set; }

        [DataMember]
        public virtual string? PO { get; set; }

        [DataMember]
        public virtual decimal OriginalAmount { get; set; }

        [DataMember]
        public virtual decimal Balance { get; set; }

        [DataMember]
        public virtual string? Location { get; set; }

        [DataMember]
        public virtual string? ShipToName { get; set; }

        [DataMember]
        public virtual string? ShipToAddress { get; set; }

        [DataMember]
        public virtual long? ShipToId { get; set; }

        [DataMember]
        public virtual List<InvoiceLineItem>? LineItems { get; set; }

        [DataMember]
        public virtual List<InvoicePaymentItem>? Payments { get; set; }
    }

    [DataContract]
    public partial class InvoiceLineItem
    {
        [DataMember]
        public virtual decimal Quantity { get; set; }

        [DataMember]
        public virtual string? Sku { get; set; }

        [DataMember]
        public virtual string? Description { get; set; }

        [DataMember]
        public virtual decimal PriceEach { get; set; }

        [DataMember]
        public virtual decimal Extended { get; set; }

        [DataMember]
        public virtual decimal Discount { get; set; }

        [DataMember]
        public virtual decimal Total { get; set; }

        [DataMember]
        public virtual string? OriginalRef { get; set; }

        [DataMember]
        public virtual string? Notes { get; set; }

        [DataMember]
        public virtual string? Source { get; set; }
    }

    [DataContract]
    public partial class InvoicePaymentItem
    {
        [DataMember]
        public virtual string? PayRef { get; set; }

        [DataMember]
        public virtual DateTime DateTime { get; set; }

        [DataMember]
        public virtual decimal Amount { get; set; }

        [DataMember]
        public virtual string? Notes { get; set; }

        [DataMember]
        public virtual string? Source { get; set; }
    }

}

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