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
"use strict";
export class BaseRequest {
    /** @param {{ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description This is your AIM API Key provided by Tri-Tech */
    ApiKey;
    /** @type {string} */
    OAuthToken;
}
export class BaseSecureRequest extends BaseRequest {
    /** @param {{Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    Token;
    /** @type {string} */
    DeviceId;
    /** @type {string} */
    AppId;
}
export class BaseResponseResult {
    /** @param {{StatusCode?:string,Login?:string,ErrorCode?:string,ErrorDisplayText?:string,ErrorMessage?:string,DomainName?:string,IpAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    StatusCode;
    /** @type {string} */
    Login;
    /** @type {string} */
    ErrorCode;
    /** @type {string} */
    ErrorDisplayText;
    /** @type {string} */
    ErrorMessage;
    /** @type {string} */
    DomainName;
    /** @type {string} */
    IpAddress;
}
export class BaseResponse {
    /** @param {{Status?:BaseResponseResult}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BaseResponseResult} */
    Status;
}
export class InvoiceLineItem {
    /** @param {{Quantity?:number,Sku?:string,Description?:string,PriceEach?:number,Extended?:number,Discount?:number,Total?:number,OriginalRef?:string,Notes?:string,Source?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Quantity;
    /** @type {string} */
    Sku;
    /** @type {string} */
    Description;
    /** @type {number} */
    PriceEach;
    /** @type {number} */
    Extended;
    /** @type {number} */
    Discount;
    /** @type {number} */
    Total;
    /** @type {string} */
    OriginalRef;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Source;
}
export class InvoicePaymentItem {
    /** @param {{PayRef?:string,DateTime?:string,Amount?:number,Notes?:string,Source?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    PayRef;
    /** @type {string} */
    DateTime;
    /** @type {number} */
    Amount;
    /** @type {string} */
    Notes;
    /** @type {string} */
    Source;
}
export class InvoiceInfo {
    /** @param {{InvoiceNumber?:string,DateTime?:string,SoldToAcct?:number,SoldToName?:string,BillToAcct?:number,BillToName?:string,Type?:string,PO?:string,OriginalAmount?:number,Balance?:number,Location?:string,ShipToName?:string,ShipToAddress?:string,ShipToId?:number,LineItems?:InvoiceLineItem[],Payments?:InvoicePaymentItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InvoiceNumber;
    /** @type {string} */
    DateTime;
    /** @type {number} */
    SoldToAcct;
    /** @type {string} */
    SoldToName;
    /** @type {number} */
    BillToAcct;
    /** @type {string} */
    BillToName;
    /** @type {string} */
    Type;
    /** @type {string} */
    PO;
    /** @type {number} */
    OriginalAmount;
    /** @type {number} */
    Balance;
    /** @type {string} */
    Location;
    /** @type {string} */
    ShipToName;
    /** @type {string} */
    ShipToAddress;
    /** @type {?number} */
    ShipToId;
    /** @type {InvoiceLineItem[]} */
    LineItems;
    /** @type {InvoicePaymentItem[]} */
    Payments;
}
export class InvoiceDetailResponse extends BaseResponse {
    /** @param {{Invoices?:InvoiceInfo[],RemainingRecords?:number,Status?:BaseResponseResult}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {InvoiceInfo[]} */
    Invoices;
    /** @type {number} */
    RemainingRecords;
}
export class InvoiceDetailRequest extends BaseSecureRequest {
    /** @param {{Acct?:number,InvoiceStartDate?:string,InvoiceEndDate?:string,StartOffset?:number,RecordCount?:number,AIMRef?:string,WebRef?:string,Token?:string,DeviceId?:string,AppId?:string,ApiKey?:string,OAuthToken?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {?number} */
    Acct;
    /** @type {?string} */
    InvoiceStartDate;
    /** @type {?string} */
    InvoiceEndDate;
    /**
     * @type {?number}
     * @description The Starting Offset. Defaults to 0 if not sent. */
    StartOffset;
    /**
     * @type {?number}
     * @description The # of records to be returned. Defaults to 100 if not sent. */
    RecordCount;
    /**
     * @type {string}
     * @description The Invoice Ref# to be looked up. If sent, do not send WebRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount */
    AIMRef;
    /**
     * @type {string}
     * @description The WebRef to be looked up. If sent, do not send AIMRef, Acct, InvoiceStartDate, InvoiceEndDate, StartOffset, or RecordCount */
    WebRef;
}

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