List Payments - API

API Name: TX_LIST_PAYMENT

Overview:
 This API is designed to give your customers the ability to view which how payments have been applied on their account. They can do this either by inquiring based on a check# or by an invoice#/finance charge. This API is also utilized by 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_CUST_N            Logged In Customer   The customer# for which the query is regarding.

 

    T_DOC_N                                  The invoice#, check#, or finance charge#.

 

    T_DOC_DATE                               The date of the document.

 

    T_TYPE                                   I = Invoice, P = Payment, F = Finance Charge

 

OUTPUT PARAMETERS:

 

  Parameter                 Comment

 

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

 

    T_TOTAL_PAID              The total payment amount.

 

    T_TOTAL_DISC              The total discount amount that was applied.

 

RECORD SETS:

 

Record Set: ARCH

 

    Document#                 The invoice#, check#, or finance charge#.

 

    Document Date             The date of the document.

 

    Document Type             I = Invoice, P = Payment, F = Finance Charge.

 

    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.

 

Topic Keyword: LIST_PAYMENTS