Aged Account Inquiry - API

API Name: TX_AGED_ACCOUNT_INQUIRY

Overview:
This API is designed to give your customers the ability to view activity on their account by selecting a specific aging period based on the number of days since the invoice date or due date.

It is similar to the Account Inquiry API.


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                                 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_ALL_SITES         N                    Y = No site validation.
                                             N = Document must be for the site# specified as T_SITE_N.
 
    T_SITE_N                                 Specific site# of the documents to be displayed when
                                             T_ALL_SITES = N.
 
    T_MONTH_END         Y                    Y = Age the account using the current month end.
                                             Example, if the current month end was February 28th,
                                             an invoice issued January 31st would be aged as 31-60 Days
                                             (with the rest of January invoices).
                                             N = Age the invoices according to invoice date.
                                             Example, if the current month end was February 28th,
                                             an invoice issued January 31st would be aged as Current.
 
    T_OUTSTANDING_ONLY  Y                    Y = Show only the current items outstanding
                                             (ie. outstanding invoices and unapplied payments only).
                                             N= Show all account activity (ie. paid and unpaid).
    T_FROM_DAYS         0
 
    T_TO_DAYS           9999999
 

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_ACCT_TOTAL              The total outstanding amount on account based on input parameters.
 
    T_LIMIT_EXCEEDED          If the total number of records that are to be listed exceeds the maximum
                              allowed as set in Presentation Themes, this will return
                              a non-blank value containing the limit that has been exceeded. (ie.100).
 
 

RECORD SETS:

 
Record Set: ARAR
 
  Column Names                 Comment
 
    Document Date             The date of the document.
 
    Due Date                  When the document is due to be paid.
 
    Document Type             I = Invoice, P = Payment, F = Finance Charge.
 
    Document#                 The invoice#, check#, or finance charge#.
 
    Invoice#                  Invoice# (if applicable).
 
    Check#                    Check# (if applicable).
 
    Finance Charge            Finance Charge# (if applicable).
 
    Currency                  Currency code of the document.
 
    Original Amount           The original amount of the document before any payments or discounts.
 
    Amount Paid               The total amount paid on an invoice, or applied from a payment.
 
    Discount Amount           Amount that has been discounted off of the document.
 
    Balance                   The remaining outstanding balance on the document.
 
    Purchase Order#           The purchase order# related to this document.
 
    Site#                     The site# related to this document.
 
    Site Name                 The site name associated with the site#.
 
    Division                  Division code associated to the document.
 
    Division Name             Name of the document division.
 
    Source Type               C = Contract, B = Cycle Billed Contract, O = Order,
                              L = Lease, S = Split Invoice, Y = Cylinder Invoice, W = Work Order.
 
    Source                    Source document#.
 
    Age In Days               The age of this document based on the T_MONTH_END parameter.

Topic Keyword: AGED_ACCOUNT_INQUIRY
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)