Documentation
for developers and administrators
Home
APIs
Processing
Billing
Management
Webhooks
Manuals
Terminology
User Guides
User Interface Reference
How-To Tutorials
Lessons
Data Dictionaries
UniCore
UniCharge
UniBill
Build
Properties Definition
Resources (Directory Structure)
Zip and Country Codes
Development
Log Files
Permissions
JNDI Names
Job Queues
Reference Materials
Supported Providers (Banks & Networks)
UniPay Codes & Code Mappings
Integrated 3rd Party Libraries
Diagrams and Documents
Entire website
This section only
Lead
Added On:
08/16/12
SQL Table:
LEAD
Module:
UniSell
Type:
Entity
Status:
Active
Java Class:
Lead
Represents a sales lead.
Available Fields:
Birth Date
Cell Phone
City
Create Date
Customer Account Code
Email
First Name
Gender CL
Home Phone
Id
Last Name
Merchant Account Code
Middle Name
Prospector Code
Reference Code
State
Street1
Street2
Work Phone
ZIP Code
Birth Date
Added On:
08/16/12
SQL Column:
BIRTH_DATE
Java Field:
birthDate
Status:
Active
SQL Type:
datetime
Java Type:
Date
Attributes:
Birth date of the lead object.
Cell Phone
Added On:
08/16/12
SQL Column:
CELL_PHONE
Java Field:
cellPhone
Status:
Active
SQL Type:
varchar(20)
Java Type:
String
Attributes:
Cell phone of the lead object.
City
Added On:
08/16/12
SQL Column:
CITY
Java Field:
city
Status:
Active
SQL Type:
varchar(100)
Java Type:
String
Attributes:
City associated with the lead object.
Create Date
Added On:
08/16/12
SQL Column:
CREATE_DATE
Java Field:
createDate
Status:
Active
SQL Type:
datetime
Java Type:
Date
Attributes:
Date when the record was created
Customer Account Code
Added On:
08/16/12
SQL Column:
CUSTOMER_ACCOUNT_CODE
Java Field:
customerAccountCode
Status:
Active
SQL Type:
varchar(20)
Java Type:
String
Attributes:
Unique identifier of the customer record associated with this lead.
The customer might exist before the lead is created or it might be created as part of the sales process converted the lead into a customer.
Email
Added On:
08/16/12
SQL Column:
EMAIL
Java Field:
email
Status:
Active
SQL Type:
varchar(100)
Java Type:
String
Attributes:
Email of the lead object.
First Name
Added On:
08/16/12
SQL Column:
FIRST_NAME
Java Field:
firstName
Status:
Active
SQL Type:
varchar(50)
Java Type:
String
Attributes:
First name of the lead object.
Gender CL
Added On:
08/16/12
SQL Column:
GENDER_CL
Java Field:
genderCl
Status:
Active
SQL Type:
varchar(1)
Java Type:
String
References
Gender Classifier
Attributes:
Gender of the lead object.
The values can be the following:
'M' - male
'F' - female
'X' - gender is unknown
Home Phone
Added On:
08/16/12
SQL Column:
HOME_PHONE
Java Field:
homePhone
Status:
Active
SQL Type:
varchar(20)
Java Type:
String
Attributes:
Home phone of the customer associated with the lead.
Id
Added On:
08/16/12
SQL Column:
ID
Java Field:
id
Status:
Active
SQL Type:
bigint(20)
Java Type:
Long
Identifier / Primary Key
Attributes:
Unique, Required, CreateOnly, ReadOnly
Identifier of the object used for references; auto-incremented integer value.
Last Name
Added On:
08/16/12
SQL Column:
LAST_NAME
Java Field:
lastName
Status:
Active
SQL Type:
varchar(50)
Java Type:
String
Attributes:
Last name of the lead object.
Merchant Account Code
Added On:
08/16/12
SQL Column:
MERCHANT_ACCOUNT_CODE
Java Field:
merchantAccountCode
Status:
Active
SQL Type:
int(11)
Java Type:
Integer
Attributes:
Required, CreateOnly
Code of
Merchant Account
to which instance of this object is attributed to.
Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
Middle Name
Added On:
08/16/12
SQL Column:
MIDDLE_NAME
Java Field:
middleName
Status:
Active
SQL Type:
varchar(50)
Java Type:
String
Attributes:
Middle name or initial of the lead object.
Prospector Code
Added On:
02/17/14
SQL Column:
PROSPECTOR_CODE
Java Field:
prospectorCode
Status:
Active
SQL Type:
varchar(60)
Java Type:
String
Attributes:
Unique identifier of the prospector.
Reference Code
Added On:
08/16/12
SQL Column:
REF_CODE
Java Field:
refCode
Status:
Active
SQL Type:
varchar(60)
Java Type:
String
Attributes:
Identifier which is used to cross-reference records between UniPay and integrated systems.
See
Reference Code
definition for additional information.
State
Added On:
08/16/12
SQL Column:
STATE
Java Field:
state
Status:
Active
SQL Type:
varchar(2)
Java Type:
String
Attributes:
State associated with the lead object.
Street1
Added On:
08/16/12
SQL Column:
STREET1
Java Field:
street1
Status:
Active
SQL Type:
varchar(100)
Java Type:
String
Attributes:
Street (line 1) associated with the lead object.
Street2
Added On:
08/16/12
SQL Column:
STREET2
Java Field:
street2
Status:
Active
SQL Type:
varchar(100)
Java Type:
String
Attributes:
Street (line 2) associated with the lead object.
Work Phone
Added On:
08/16/12
SQL Column:
WORK_PHONE
Java Field:
workPhone
Status:
Active
SQL Type:
varchar(20)
Java Type:
String
Attributes:
Work phone of the lead object.
ZIP Code
Added On:
08/16/12
SQL Column:
ZIP_CODE
Java Field:
zipCode
Status:
Active
SQL Type:
varchar(10)
Java Type:
String
Attributes:
ZIP code associated with the lead object.