List Invoices - API

API Name: TX_LIST_INVOICES

Overview:
This inquiry lists the customer’s invoices on the screen with the defined output information.

INPUT PARAMETERS:

   Parameter          Default Value         Comment

    T_WEB_ID                                 The unique Web Identification value

                                             returned by the Customer Login API.

    T_INDEX_ID          default              The Index ID associated with this API that

                                             defines the Modes and Fields available.

    T_LINES_PER_PAGE                         If you wish to limit the number of records

                                             returned as part of the record set, enter the

                                             maximum number of lines to be returned when a page

                                             is requested.

                                             If there is no limit required enter 0.

    T_PAGE                                   This parameter is to be used with the T_LINES_PER_PAGE

                                             parameter to determine which data is to be passed in

                                             the record set.  Pass 0 or blank for the initial call

                                             to build record set.

    T_CUST_N            Logged In Customer   The customer# for which the query is regarding.

    T_FROM_DATE         January 1, 1901      Part of the date range in which the document must be

                                             between.

    T_TO_DATE           December 31, 2199    Part of the date range in which the document must be

                                             between.

    T_INCLUDE_HISTORY   N

    T_SEARCH_BY                              P = Search by product number, C = Search by product class,

                                             G = Search by product group, blank = Do not filter result                           
                                             based on contract details.

    T_SEARCH_VALUE                           The Product or Class or Group that the contract detail

                                             filter is based on.

                                             Blank means there is no filter.

OUTPUT PARAMETERS:

  Parameter                 Comment

    T_ERROR                   If an error is encountered this will be returned as a non-blank value.

    T_NUM_PAGES               This will return the total number of pages generated based on the

                              T_LINES_PER_PAGE parameter which was passed in.

    T_PAGE                    The current page of data that has been returned in the record set.

    T_LIMIT_EXCEEDED          If the total number of records which are required to be listed exceed

                              the maximum allowed as set in Presentation Themes this will

                              return a non-blank value contain what limit has been exceeded. (ie.100)

RECORD SETS:

Record Set: RSIH

  Column Names                 Comment

    Invoice#

    Div Code

    Div Name

    Site#

    Site Name

    Bill Name

    Bill Addr1

    Bill Addr2

    Bill City

    Bill Prov

    Bill Postal

    Bill Phone

    Ship Name

    Ship Addr1

    Ship Addr2

    Ship City

    Ship Prov

    Ship Postal

    Ship Phone

    Ship Via

    Purchase Order#

    Clerk ID

    Clerk Name

    Identification

    Reference

    Date

    Rental Subtotal

    Sales Subtotal

    Waiver Amt

    Deposit

    Service Subtotal

    Total

    Discounts

    Product#

    Product Desc

    Customer#