List Contracts - API
API Name: TX_LIST_CONTRACTS also used for REQUEST_PICKUPS
Overview:
List one record per contract for one/all customer(s).
If only open contracts are requested via the active only Y/N flag, there needs to be at least one item outstanding.
If you wish to retrieve the data 1 page at a time, initially call the API with T_PAGE = 0 and T_LINES_PER_PAGE set. Any subsequent calls simply require you to update T_PAGE value.
If you wish to list contracts based on Product, Class, or Group simply set the T_SEARCH_BY = P or C or G and T_SEARCH_VALUE to the Product, Class, or Group.
If you wish to view a list of contracts for all customers call the API with T_CUST_N = ALL_CUSTOMERS. If T_CUST_N is not passed in or is passed in with a blank value, the customer number of the customer logged in will be used.
If you wish to use this API to request pickups, display the "Request Pickup" column
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_ACTIVE_ONLY B O = Open contracts, C = Closed contracts,
B = Both open and closed contracts.
T_INCLUDE_ARCHIVED N N = Only check the contracts that have not been
archived.
Y = Check all the contracts that are currently on the
system even if they have been archived.
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.
T_RETURN_STATUS_QTY N Y = Return On Rent, Returned, Off Rent columns if
specified as part of the design of the Output Record Set.
N = Even if On Rent, Returned, Off Rent columns are
requested as part of the record set they will be suppressed.
T_DETAIL_REPORT N
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)
T_WEB_VIEW
RECORD SETS:
Record Set: RSCH
Column Names Comment
Contract#
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
Reservation#
Date
Rental Subtotal
Sales Subtotal
Waiver Amt
Deposit
Service Subtotal
Total
Discounts
Return Date
Driver License
Driver Name
Product#
Product Desc
LTD Billing
Closed
Customer#
On Rent
Returned
Off Rent
Request Pickup
Topic Keyword: LIST CONTRACTS