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

// @DataContract
export class BaseRequest
{
    /** @description 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")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Item360
{
    // @DataMember
    public PslrId?: number;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public TotalDiscountAmount: number;

    // @DataMember
    public SerialNumber: string;

    // @DataMember
    public Condition: string;

    public constructor(init?: Partial<Item360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Invoice360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public DueDate?: string;

    // @DataMember
    public Total: number;

    // @DataMember
    public Status: string;

    // @DataMember
    public AmountPaid: number;

    // @DataMember
    public LateFeeAmount: number;

    // @DataMember
    public PurchaseDate: string;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public Items: Item360[];

    public constructor(init?: Partial<Invoice360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Order360
{
    // @DataMember
    public Id: number;

    // @DataMember
    public Date: string;

    // @DataMember
    public Discount: number;

    // @DataMember
    public PaymentType: string;

    // @DataMember
    public SubTotal: number;

    // @DataMember
    public Tax: number;

    // @DataMember
    public ShippingAmount: number;

    // @DataMember
    public Total: number;

    public constructor(init?: Partial<Order360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Job360
{
    // @DataMember
    public ItemId: string;

    // @DataMember
    public ItemType: string;

    // @DataMember
    public Title: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public Price: number;

    // @DataMember
    public TotalDiscountAmount: number;

    // @DataMember
    public SerialNumber: string;

    // @DataMember
    public Condition: string;

    public constructor(init?: Partial<Job360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class WorkOrder360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public Status: string;

    // @DataMember
    public Deposit: number;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public CreationDate: string;

    // @DataMember
    public CompletedDate?: string;

    // @DataMember
    public Price: number;

    // @DataMember
    public Jobs: Job360[];

    public constructor(init?: Partial<WorkOrder360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Contract360
{
    // @DataMember
    public Id: string;

    // @DataMember
    public PaymentDate: string;

    // @DataMember
    public StoreLocationId?: number;

    // @DataMember
    public AmountDue: number;

    // @DataMember
    public LateFee: number;

    // @DataMember
    public ContractStatus: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public ContractItems: Item360[];

    public constructor(init?: Partial<Contract360>) { (Object as any).assign(this, init); }
}

// @DataContract
export class History360Response extends BaseResponse
{
    // @DataMember
    public Invoices: Invoice360[];

    // @DataMember
    public Orders: Order360[];

    // @DataMember
    public WorkOrders: WorkOrder360[];

    // @DataMember
    public Contracts: Contract360[];

    public constructor(init?: Partial<History360Response>) { super(init); (Object as any).assign(this, init); }
}

/** @description History360Requires active-e Customer Service. */
// @DataContract
export class History360Request extends BaseSecureRequest
{
    // @DataMember
    public CustomerAccount: number;

    // @DataMember
    public IncludeInvoices: boolean;

    // @DataMember
    public IncludeOrders: boolean;

    // @DataMember
    public IncludeWorkOrders: boolean;

    // @DataMember
    public IncludeContracts: boolean;

    // @DataMember
    public IncludeClosed: boolean;

    // @DataMember
    public ClosedStartDate?: string;

    public constructor(init?: Partial<History360Request>) { super(init); (Object as any).assign(this, init); }
}

TypeScript 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,"LateFeeAmount":0,"StoreLocationId":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,"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,"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"}}