Method Loan List v3

Loan List Web Service attempts to input one or more report(s) in a structured format.

API Documentation
REST Method: https://catweb.sba.gov/rest/fta/LoanList/
SOAP Method: https://catweb.sba.gov/ftadistapps/1502gateway/ws/LoanListWS.wsdl
Keys of the Input Structure:
  • CLSUsername
    		•  Mandatory. CLS login’s username with update permissions in FTA Portal.
  • CLSPassword
    		•  Mandatory. CLS login’s password with update permissions in FTA Portal.
  • CLSPIN
    		•  Mandatory. PIN generated by Generate_PIN using the same login.
  • SoftwareVendorCode
    		•  Mandatory. A private code that authorizes use of SoftwareVendorName.
  • SoftwareVendorName
    		•  Mandatory. Value from Code Tables, Vendor Table.
  • FormatIn
    		•  Optional. Format of RequestData, if any. XML or JSON. See Format IN/OUT Defaults
  • FormatOut
    		•  Optional.“xml” is for XML return format and “json” is for JSON return format.
  • Version
    		•  Mandatory. "3" (version: 1 or 2)
  • ServiceName
    		•  Mandatory. LoanHeader, LoanPayment, LoanPaymentOriginator, LoanPaymentLender, Balance (only one option allowed)
  • LoanList
    		•  Mandatory. See Below for requirements based on ServiceName chosen
  • LoanHeader.
    		•
  • LoanPayment.
    		•
  • LoanPaymentOriginator. (Version 2 Only).
    		•
  • LoanPaymentLender. (Version 2 Only).
    		•
  • Balance (multiple values comma delimited).
    		•
  • PasswordUpdateRequired
    		•  Accepted Type: “Yes”, “No”
    Keys of the Output Structure:
  • ResponseData
    		•  XML or JSON determined with data type submitted.
  • ErrorMessageEnglish
    		•  Should be nullstring. If not, a generally-worded error message.
  • ErrorMessageTechnical
    		•  Should be nullstring. If not, a more helpful error message, but scarier to some users.
  • PasswordUpdateRequired
    		•  “Yes”, “No”. Indicate if this user needs to update the password
  • ServiceName: LoanHeader
    		•
  • SBALOANNUMBER returned type: STRING
    		•
  • LENDERNAME returned type: STRING
    		•
  • LOANNAME returned type: STRING
    		•
  • NAICSCODE returned type: STRING
    		•
  • SBAAPPROVALDATE returned type: DATE
    		•
  • GEOGRAPHYSTREET returned type: STRING
    		•
  • GEOGRAPHYCITY returned type: STRING
    		•
  • GEOGRAPHYSTATE returned type: STRING
    		•
  • GEOGRAPHYZIPCODE returned type: STRING
    		•
  • LOANSTATUS returned type: STRING
    		•
  • LOANSTATUSDATE returned type: DATE
    		•
  • LOANPAYOFFTYPE returned type: STRING
    		•
  • POOLNUMBER returned type: INTEGER
    		•
  • POOLISSUEDATE returned type: DATE
    		•
  • NOTEDATE returned type: DATE
    		•
  • MATURITYDATE returned type: DATE
    		•
  • SETTLEDATE returned type: DATE
    		•
  • CAPPCT returned type: DECIMAL
    		•
  • FLOORPCT returned type: DECIMAL
    		•
  • BASIS returned type: STRING
    		•
  • ORIGFACEAMTOFCERT returned type: DECIMAL
    		•
  • GICCERTIFICATENUMBER returned type: STRING
    		•
  • COOFCERTIFICATENUMBER returned type: STRING
    		•
  • INITIALGROSSRATEPCT returned type: DECIMAL
    		•
  • INITIALNETRATEPCT returned type: DECIMAL
    		•
  • SBAFEEPCT returned type: DECIMAL
    		•
  • FTAFEEPCT returned type: DECIMAL
    		•
  • INITIALLENDERFEEPCT returned type: DECIMAL
    		•
  • INITIALORIGINATORPCT returned type: DECIMAL
    		•
  • FLOATDATE returned type: DATE
    		•
  • PAYMENTFREQ returned type: STRING
    		•
  • ADJUSTMENTFREQUENCY returned type: STRING
    		•
  • PERMANENTLENDERFEEPCT returned type: DECIMAL
    		•
  • PERMANENTORIGINATORFEEPCT returned type: DECIMAL
    		•
  • CURRENTBASERATEPCT returned type: DECIMAL
    		•
  • CURRENTGROSSMARGINPCT returned type: DECIMAL
    		•
  • CURRENTGROSSRATEPCT returned type: DECIMAL
    		•
  • CURRENTNETMARGINPCT returned type: DECIMAL
    		•
  • CURRENTNETRATEPCT returned type: DECIMAL
    		•
  • BASERATEPCTPTD returned type: DECIMAL
    		•
  • GROSSMARGINPCTPTD returned type: DECIMAL
    		•
  • GROSSRATEPCTPTD returned type: DECIMAL
    		•
  • NETMARGINPCTPTD returned type: DECIMAL
    		•
  • NETRATEPCTPTD returned type: DECIMAL
    		•
  • PREPAYNOTICE returned type: STRING
    		•
  • PREPAYEXPIRATIONDATE returned type: DATE
    		•
  • ERRORCODE returned type: INTEGER
    		•
  • COMMENTS returned type: STRING
    		•
  • ServiceName: LoanPayment
    		•
  • GPNUMBER returned type: STRING
    		•
  • DATEPOSTED returned type: DATE
    		•
  • PAYOUTDATE returned type: DATE
    		•
  • INTERESTPAYMENT returned type: DECIMAL
  • PRINCIPALPAYMENT returned type: DECIMAL
  • TOTALPAYMENT returned type: DECIMAL
    		•
  • INTFROMDATE returned type: STRING
    		•
  • INTTODATE returned type: STRING
    		•
  • NUMBEROFDAYS returned type: INTEGER
    		•
  • OUTSTANDINGBALANCE returned type: DECIMAL
    		•
  • ERRORCODE returned type: INTEGER
  • COMMENTS returned type: STRING
  • ServiceName: LoanPaymentLender
    		•
  • GPNUMBER returned type: STRING
    		•
  • DATEPOSTED returned type: DATE
    		•
  • PAYOUTDATE returned type: DATE
    		•
  • INTERESTPAYMENT returned type: DECIMAL
  • PRINCIPALPAYMENT returned type: DECIMAL
  • TOTALPAYMENT returned type: DECIMAL
    		•
  • INTFROMDATE returned type: STRING
    		•
  • INTTODATE returned type: STRING
    		•
  • NUMBEROFDAYS returned type: INTEGER
    		•
  • OUTSTANDINGBALANCE returned type: DECIMAL
    		•
  • ERRORCODE returned type: INTEGER
  • COMMENTS returned type: STRING
  • ServiceName: LoanPaymentOriginator
    		•
  • GPNUMBER returned type: STRING
    		•
  • DATEPOSTED returned type: DATE
    		•
  • PAYOUTDATE returned type: DATE
    		•
  • ORIGINTFEE returned type: DECIMAL
  • INTFROMDATE returned type: STRING
    		•
  • INTTODATE returned type: STRING
    		•
  • NUMBEROFDAYS returned type: INTEGER
    		•
  • OUTSTANDINGBALANCE returned type: DECIMAL
    		•
  • ERRORCODE returned type: INTEGER
  • COMMENTS returned type: STRING
  • ServiceName: Balance
    		•
  • SBALOANNO returned type: STRING
    		•
  • DATEPOSTED returned type: DATE
    		•
  • PAIDDATE returned type: DATE
    		•
  • INTERESTPAIDTODATE returned type: STRING
    		•
  • CLOSINGBALANCEAMT returned type: DECIMAL
    		•
  • LENDERPCT returned type: DECIMAL
    		•
  • ERRORCODE returned type: INTEGER
    		•
  • ERRORMESSAGE returned type: STRING