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
// @ts-nocheck

// @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;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId?: string;

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

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token?: 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 InvoiceLineItem
{
    // @DataMember
    public Quantity: number;

    // @DataMember
    public Sku?: string;

    // @DataMember
    public Description?: string;

    // @DataMember
    public PriceEach: number;

    // @DataMember
    public Extended: number;

    // @DataMember
    public Discount: number;

    // @DataMember
    public Total: number;

    // @DataMember
    public OriginalRef?: string;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public Source?: string;

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

// @DataContract
export class InvoicePaymentItem
{
    // @DataMember
    public PayRef?: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public Amount: number;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public Source?: string;

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

// @DataContract
export class InvoiceInfo
{
    // @DataMember
    public InvoiceNumber?: string;

    // @DataMember
    public DateTime: string;

    // @DataMember
    public SoldToAcct: number;

    // @DataMember
    public SoldToName?: string;

    // @DataMember
    public BillToAcct: number;

    // @DataMember
    public BillToName?: string;

    // @DataMember
    public Type?: string;

    // @DataMember
    public PO?: string;

    // @DataMember
    public OriginalAmount: number;

    // @DataMember
    public Balance: number;

    // @DataMember
    public Location?: string;

    // @DataMember
    public ShipToName?: string;

    // @DataMember
    public ShipToAddress?: string;

    // @DataMember
    public ShipToId?: number;

    // @DataMember
    public LineItems?: InvoiceLineItem[];

    // @DataMember
    public Payments?: InvoicePaymentItem[];

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

// @DataContract
export class InvoiceDetailResponse extends BaseResponse
{
    // @DataMember
    public Invoices?: InvoiceInfo[];

    // @DataMember
    public RemainingRecords: number;

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

/** @description InvoiceDetailRequires active-e Customer Service. */
// @DataContract
export class InvoiceDetailRequest extends BaseSecureRequest
{
    // @DataMember
    public Acct?: number;

    // @DataMember
    public InvoiceStartDate?: string;

    // @DataMember
    public InvoiceEndDate?: string;

    /** @description 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")
    public StartOffset?: number;

    /** @description 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")
    public RecordCount?: number;

    /** @description 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")
    public AIMRef?: string;

    /** @description 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")
    public WebRef?: string;

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

TypeScript 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"}}