AIM Web Services

<back to all web services

History360Request

History360
Requires active-e Customer Service.

The following routes are available for this service:
GET/api/History360
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; }
    }

    [DataContract]
    public partial class Contract360
    {
        [DataMember]
        public virtual string? Id { get; set; }

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

        [DataMember]
        public virtual int? StoreLocationId { get; set; }

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

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

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

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

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

        [DataMember]
        public virtual List<Item360>? ContractItems { get; set; }
    }

    ///<summary>
    ///History360Requires active-e Customer Service.
    ///</summary>
    [DataContract]
    public partial class History360Request
        : BaseSecureRequest
    {
        [DataMember]
        public virtual int CustomerAccount { get; set; }

        [DataMember]
        public virtual bool IncludeInvoices { get; set; }

        [DataMember]
        public virtual bool IncludeOrders { get; set; }

        [DataMember]
        public virtual bool IncludeWorkOrders { get; set; }

        [DataMember]
        public virtual bool IncludeContracts { get; set; }

        [DataMember]
        public virtual bool IncludeClosed { get; set; }

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

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

        [DataMember]
        public virtual List<Order360>? Orders { get; set; }

        [DataMember]
        public virtual List<WorkOrder360>? WorkOrders { get; set; }

        [DataMember]
        public virtual List<Contract360>? Contracts { get; set; }
    }

    [DataContract]
    public partial class Invoice360
    {
        [DataMember]
        public virtual string? Id { get; set; }

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

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

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

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

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

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

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

        [DataMember]
        public virtual int? StoreLocationId { get; set; }

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

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

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

        [DataMember]
        public virtual List<Item360>? Items { get; set; }
    }

    [DataContract]
    public partial class Item360
    {
        [DataMember]
        public virtual long? PslrId { get; set; }

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

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

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

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

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

    [DataContract]
    public partial class Job360
    {
        [DataMember]
        public virtual string? ItemId { get; set; }

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

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

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

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

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

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

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

    [DataContract]
    public partial class Order360
    {
        [DataMember]
        public virtual int Id { get; set; }

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

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

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

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

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

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

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

    [DataContract]
    public partial class WorkOrder360
    {
        [DataMember]
        public virtual string? Id { get; set; }

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

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

        [DataMember]
        public virtual int? StoreLocationId { get; set; }

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

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

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

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

        [DataMember]
        public virtual List<Job360>? Jobs { get; set; }
    }

}

C# History360Request 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/History360 HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Invoices":[{"Id":"String","DueDate":"0001-01-01T00:00:00.0000000","Total":0,"Status":"String","AmountPaid":0,"PaymentType":"String","LateFeeAmount":0,"StoreLocationId":0,"Discount":0,"Tax":0,"Shipping":0,"Items":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Orders":[{"Id":0,"Discount":0,"PaymentType":"String","SubTotal":0,"Tax":0,"ShippingAmount":0,"Total":0}],"WorkOrders":[{"Id":"String","Status":"String","Deposit":0,"StoreLocationId":0,"CompletedDate":"0001-01-01T00:00:00.0000000","Price":0,"LocationName":"String","Jobs":[{"ItemId":"String","ItemType":"String","Title":"String","Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Contracts":[{"Id":"String","StoreLocationId":0,"AmountDue":0,"LateFee":0,"ContractStatus":"String","Amount":0,"LocationName":"String","ContractItems":[{"PslrId":0,"Quantity":0,"Price":0,"TotalDiscountAmount":0,"SerialNumber":"String","Condition":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}