Zip and Country Codes
Development
Reference Materials
View Customer
Description: Allows to view information about the selected customer.
New
|
Allows a quick creation of objects associated with the customer. |
Prev
|
Allows to move to the previous customer account available in the search result list. |
Next
|
Allows to move to the next customer account available in the search result list. |
Close
|
Closes the form without saving any changes. |
Personal |
Includes customer's personal information.
|
¦_ |
Customer Code
|
Secondary identifier, which can be used to cross-reference records between UniPay and integrated systems.
See Reference Code for additional information.
References: Customer Account.Reference Code
|
¦_ |
Edit
|
Allows to edit customer's code within the system. |
Title
|
Title of the customer.
References: Customer.Title
|
First Name
|
First name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the first name of the company's contact person.
References: Customer.First Name
|
Middle Name
|
Middle Name of the customer.
References: Customer.Middle Name
|
Last Name
|
Last name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the last name of the company's contact person.
References: Customer.Last Name
|
Suffix
|
Suffix of the customer.
References: Customer.Suffix
|
Account
|
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.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.
References: Customer Account.Merchant Account Code
|
Gender
|
Customer's gender. |
¦_ |
Male
|
Indicates that the customer is male. |
¦_ |
Female
|
Indicates that the customer is female. |
Birth Date
|
Birth date of the customer.
References: Customer.Birth Date
|
Social Security
|
Number of the customer's social security.
References: Customer.Social Security
|
Driver's License
|
Number of the customer's driver license.
References: Customer.Driver License Number
|
Primary Contact Info |
Include primary contact information of the selected customer.
|
¦_ |
First Name
|
First name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the first name of the company's contact person.
References: Customer.First Name
|
¦_ |
Last Name
|
Last name of the customer. This field is set for both person and organization types of customers. For organizations, this field is used for the last name of the company's contact person.
References: Customer.Last Name
|
¦_ |
Street
|
Street of customer's residence. |
¦_ |
Bad
|
If checked, the street is invalid. |
City
|
City of customer's residence. |
State
|
State of customer's residence. |
ZIP Code
|
Customer's zip code. |
Home Phone
|
Reference to the entity that represents number of the customer's home phone.
References: Customer.Default Home Phone FK
|
¦_ |
Bad
|
If checked, the home phone is invalid. |
Work Phone
|
Reference to the entity that represents number of the customer's work phone.
References: Customer.Default Work Phone FK
|
¦_ |
Bad
|
If checked, the work phone is invalid. |
Mobile Phone
|
Reference to the entity that represents number of the customer's cell phone.
References: Customer.Default Cell Phone FK
|
¦_ |
Bad
|
If checked, the mobile phone is invalid. |
E-mail
|
Reference to the entity that represents customer's email address.
References: Customer.Default Email FK
|
¦_ |
Bad
|
If checked, the email address is invalid. |
Collections Info |
Include information concerning third party collections.
|
¦_ |
Agent
|
Collections' agent responsible for this account. |
¦_ |
Priority
|
Reference to the entity that represents current (or selected) type of priority of the account within the collection process.
References: Customer Account.Collections Priority CL
|
¦_ |
Sent Date
|
The date when the account was sent to third party collections.
References: Customer Account.Sent Collections Date
|
¦_ |
day(s)
|
Number of days that the account has been in third party collections. |
Sent Balance
|
The balance that was sent to third party collections.
References: Customer Account.Sent Collections Balance
|
Last Action Date
|
The date when the last action was applied to the account.
References: Customer Account.Last Action Date
|
Last Action
|
Reference to the entity that represents last action that was taken on the account.
References: Customer Account.Last Action FK
|
Credit Agency
|
Reference to the entity that represents enumeration of possible policy for credit bureau reporting for this account.
References: Customer Account.Credit Agency Status CL
|
Credit Agency Dispute
|
Reference to the entity that represents enumeration of possible dispute information types that should be used during credit bureau reporting.
References: Customer Account.Credit Agency Dispute CL
|
Don't Call
|
Flag indicating that voice calls should not be made on this account. |
Don't Mail
|
Flag indicating that mail should not be sent to this account. |
Don't Email
|
Flag indicating that email should not be sent to this account. |
Detail |
Includes general information about customer's billing.
|
¦_ |
Create Date
|
Date when the record was created.
References: Customer Account.Create Date
|
¦_ |
Balance
|
Current balance of the customer's account.
References: Customer Account.Balance
|
¦_ |
Account Group
|
Reference to the entity that represents optional group that the account belongs to (for marketing purposes, etc.).
References: Customer Account.Account Group Code FK
|
¦_ |
First Billing
|
The date when the account was billed for the first time.
References: Customer Account.First Billing Date
|
¦_ |
Last Return
|
Response code of the last decline or ACH return received on the account.
References: Customer Account.Last Return Reason
|
¦_ |
Last Return Msg
|
Response message of the last decline or ACH return received on the account. |
¦_ |
Status
|
Reference to the entity that represents possible statuses of the customer account.
References: Customer Account.Status
|
¦_ |
Phase
|
The current phase of the customer. |
¦_ |
Is Active
|
Allows reactivating of previously deactivated customer.
Indicates whether the record is active in the system.
References: Customer Account.Is Active
|
¦_ |
Deactivation
|
Allows to see the reason of account deactivation. |
¦_ |
Bankruptcy
|
Deactivates the account due to customer's bankruptcy. |
¦_ |
Death
|
Deactivates the account due to customer being deceased. |
¦_ |
Deactivation
|
Deactivates the account due to business reasons. |
Is Reinstated
|
Indicates whether the account has been reinstated from collections.
References: Customer Account.Is Reinstated
|
Is Deceased
|
Indicates the owner of the account is deceased. |
Last Update
|
The date when the account was updated the last time.
References: Customer Account.Last Update Date
|
Last Payment
|
The date when the last successful payment was collected on the account.
References: Customer Account.Last Payment Date
|
Account Age
|
The current age of the unpaid balance on the account. |
Marketing Email Allowed
|
Flag indicating whether customer can be contacted with marketing offers over the email.
References: Customer.Is Marketing Email Allowed
|
Billing Email Allowed
|
Flag indicating whether customer can be contacted with billing issues over the email.
References: Customer.Is Billing Email Allowed
|
Marketing Call Allowed
|
Flag indicating whether customer can be contacted with marketing offers over the phone.
References: Customer.Is Marketing Call Allowed
|
Default Billing |
Includes default billing settings for the account.
|
¦_ |
Payment Option
|
Reference to the entity that represents default payment option to use to collect outstanding invoices that do not have implicit payment option.
References: Customer Account.Default Payment Option FK
|
¦_ |
Billing Date
|
Default payment option to use to collect outstanding invoices that do not have implicit billing date associated with the account. |
Skip Trace |
Includes various skip trace settings for the customer account.
|
¦_ |
Last Date
|
Last date when the skip trace occurred on this account. |
¦_ |
Mode
|
Enumeration of possible modes for skip trace operations.
References: Customer.Skip Trace Mode CL
|
¦_ |
Skip Trace Required
|
Flag indicating whether skip trace is required for this account.
References: Customer.Is Skip Trace Required
|
Account Flags |
Includes marker flags that are used during the collection's process.
|
¦_ |
Chargeback Requested
|
The customer has requested the chargeback.
References: Customer.Is Chargeback Requested
|
¦_ |
Legal Dispute
|
The customer is having a legal dispute with the merchant.
References: Customer.Is Legal Dispute
|
¦_ |
Bankruptcy Filed
|
The customer is bankrupt.
References: Customer.Is Bankruptcy Filed
|
¦_ |
Cancellation Dispute
|
The customer is having a cancellation dispute with the merchant.
References: Customer.Is Cancellation Dispute
|
Additional Info |
Includes additional information about customer.
|
¦_ |
To Be Current
|
Indicates that the customer is a current one. |
¦_ |
Contract Amount
|
Contract amount of the customer. |
¦_ |
Contract Balance
|
Contract prescribed balance amount of the customer. |
¦_ |
Late Fee
|
Amount of late fee for the customer. |
¦_ |
Return Fee
|
Amount of return fee for the customer. |
¦_ |
Monthly Payment
|
Prescribed monthly payment of the customer. |
¦_ |
Payment Count
|
Number of submitted payments. |
¦_ |
Last Payment Date
|
Date when the last successful payment was made. |
¦_ |
Emergency Info
|
Emergency information of the customer. |
¦_ |
Buyer Info
|
Information associated with a buyer. |
¦_ |
Additional Notes
|
Any additional information that can be provided about the customer. |
¦_ |
Save
|
Saves all changes on the form. |
¦_ |
Refresh
|
Allows to refresh all the provided information. |
Addresses |
Includes the list of addresses associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Address.Id
|
¦_ |
Create Date
|
Date when the record was created
References: Address.Create Date
|
¦_ |
Type
|
Represents the type of selected address.
References: Address.Address CL
|
¦_ |
Source
|
Represents the way the address information was obtained.
References: Address.Address Source CL
|
¦_ |
Street
|
Street address of the customer.
References: Address.Street 1
|
¦_ |
City
|
City of the customer.
References: Address.City
|
¦_ |
State
|
State of the customer.
References: Address.State
|
¦_ |
ZIP Code
|
ZIP or postal code of the customer.
References: Address.ZIP Code
|
¦_ |
Last Skip Date
|
The date when this address was skip traced for the last time.
References: Address.Last Skip Trace Date
|
¦_ |
Skips Allowed
|
Indicates whether skip tracing is allowed for this address.
References: Address.Is Skip TraceAllowed
|
¦_ |
Bad
|
If checked, the address is invalid.
References: Address.Is Bad
|
¦_ |
Modify Address
|
Opens a form where information associated with the address can be modified. Opens Form:
Modify Address
|
¦_ |
New
|
Allows to create a new address and add it to the list. Opens Form:
Modify Address
|
Phones |
Includes the list of phones associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Phone.Id
|
¦_ |
Create Date
|
Date when the record was created
References: Phone.Create Date
|
¦_ |
Type
|
Reference to the entity that represents the available types of current (or selected) phone number.
References: Phone.Phone CL
|
¦_ |
Source
|
Reference to the entity that represents information about obtaining the merchant's phone number.
References: Phone.Address Source CL
|
¦_ |
Phone #
|
Number of customer's phone.
References: Phone.Phone
|
¦_ |
Extension
|
Extension of the phone number.
References: Phone.Extention
|
¦_ |
Bad Reason
|
The reason why the phone was marked as invalid.
References: Phone.Bad Reason
|
¦_ |
Last Skip Date
|
The date when this phone was skip traced for the last time.
References: Phone.Last Skip Trace Date
|
¦_ |
Skips Allowed
|
Indcates whether skip tracing is allowed for this phone.
References: Phone.Is Skip Trace Allowed
|
¦_ |
Bad
|
Indicates whether the phone number is invalid.
References: Phone.Is Bad
|
¦_ |
Modify Phone
|
Allows to modify the selected phone record. Opens Form:
Modify Phone
|
¦_ |
New
|
Allows to add a new customer phone number. Opens Form:
Modify Phone
|
Email Addresses |
Includes the list of email addresses associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Email Address.Id
|
¦_ |
Create Date
|
Date when the record was created
References: Email Address.Create Date
|
¦_ |
Type
|
Represents current (or selected) type of the email address.
References: Email Address.Email CL
|
¦_ |
Source
|
Represents the way the email address information was obtained.
References: Email Address.Address Source CL
|
¦_ |
Email
|
Customer's email address.
References: Email Address.Email
|
¦_ |
Bad Reason
|
The reason why the email address was marked as invalid.
References: Email Address.Bad Reason
|
¦_ |
Bad
|
If checked, the email address is invalid.
References: Email Address.Is Bad
|
¦_ |
Modify Email Address
|
Allows to modify the selected email record. Opens Form:
Modify Email Address
|
¦_ |
New
|
Allows to create a new email record for the customer and add it to the list. Opens Form:
Modify Email Address
|
Notes |
Includes any notes associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Note.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Note.Create Date
|
¦_ |
Content
|
Content of the note.
References: Note.Description
|
¦_ |
Category
|
Category of the note. |
¦_ |
Creator
|
User that created the note.
References: Note.Creator Code
|
¦_ |
Modify Note
|
Allows to modify the selected note record. Opens Form:
Modify Note
|
¦_ |
New
|
Allows to create a new note about the customer and add it to the list. Opens Form:
Modify Note
|
Contracts |
Includes the list of contracts associated with the customer.
|
¦_ |
Code
|
Identifier of the object used for references; auto-incremented integer value.
References: Contract.Id
|
¦_ |
Name
|
Name of the contract.
References: Contract.Name
|
¦_ |
Type
|
Reference to the entity that represents available types of contracts.
References: Contract.Contract CL
|
¦_ |
Create Date
|
Date when the record was created.
References: Contract.Create Date
|
¦_ |
Effective Date
|
Date when the terms of the contract start.
References: Contract.Effective Date
|
¦_ |
Exp Date
|
Date when the terms of the contract end.
References: Contract.Expiration Date
|
¦_ |
Status
|
Reference to the entity that represents possible statuses of the contract.
References: Contract.Status CL
|
¦_ |
Modify Contract
|
Allows to see detailed information about the selected customer contract record. |
Payment Plans |
Includes the list of payment plans associated with the customer.
|
¦_ |
Hide
|
Allows to hide the selected record.
When the eye is closed, the record is not visible to the customer through the self-service portal. |
¦_ |
Payment Plan ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Payment Plan.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Payment Plan.Create Date
|
¦_ |
Last Billing
|
The date when the payment plan was billed for the last time. |
¦_ |
Next Billing
|
The date when the payment plan will be billed for the next time. |
¦_ |
Type
|
Enumeration of possible types of payment plans.
References: Payment Plan.Payment Plan CL
|
¦_ |
# Payments
|
Number of payments left on the payment plan. |
¦_ |
Amount
|
The amount of money charged every time billing occurs for this payment plan (e.g. amount of the transaction). Value must be submitted in cents without a decimal point.
References: Payment Plan.Amount
|
¦_ |
Value
|
Total value of the payment plan.
References: Payment Plan.Value
|
¦_ |
Renewal
|
Renewal amount on the payment plan.
References: Payment Plan.Renewal Amount
|
¦_ |
Tax
|
Tax charged on the payment plan's amount.
References: Payment Plan.Tax Amount
|
¦_ |
Payment Option
|
Reference to the entity that represents payment option used to collect money on the payment plan.
References: Payment Plan.Payment Option FK
|
¦_ |
Status
|
Represents current status of the payment plan.
The values can be the following:
- Deferred - indicates that no invoice will be generated in the upcoming billing associated with the payment plan.
- Current - indicates that the payment plan is active.
- Freeze - indicates that the payment plan is terminated. After the predefined number of freeze charges are passed, the payment plan will be reactivated automatically.
- Cancelled - indicates that the payment plan is cancelled.
- Expired - indicates that all payments associated with a payment plan are made; available only for a fixed payment plan.
- Unbilled - indicates that no billing occurred since the payment plan has been created.
- Suspended (deprecated) - indicates that the payment plan is set on hold by the system.
- Paused - indicates that the payment plan is set on hold by the user. A paused payment plan can be unpaused manually only.
|
¦_ |
Next Charge
|
Status of the next charge that is going to be applied to the payment plan.
The values can be the following:
- Deferred - indicates that no invoice will be generated in the upcoming billing associated with a payment plan.
- Fixed - indicates that the payment plan has fixed length and will expire after all charges in the plan are processed.
- Perpetual - indicates that the payment plan has no defined length and will be generating invoices until canceled.
- Complimentary - indicates that the payment plan has no defined length and every generated invoice will be automatically waived by issued adjustment.
- Freeze - indicates that the payment plan will be terminated.
|
¦_ |
View Payment Plan
|
Allows to view the selected payment plan. Opens Form:
View Payment Plan
|
¦_ |
New
|
Allows to create a new payment plan and add it to the list. Opens Form:
New Payment Plan
|
¦_ |
Cancel Payment Plan
|
Allows to cancel a payment plan. |
Scheduled Payments |
Includes the list of scheduled payments associated with the customer.
|
¦_ |
Code
|
Secondary identifier, which can be used to cross-reference records between UniPay and integrated systems.
See Reference Code for additional information.
References: Scheduled Payment.Reference Code
|
¦_ |
Create Date
|
Date when the record was created.
References: Scheduled Payment.Create Date
|
¦_ |
Due Date
|
Due date of scheduled payment.
References: Scheduled Payment.Due Date
|
¦_ |
Create Invoice
|
Indicates whether the creation of an invoice is required.
References: Scheduled Payment.Is Invoice Required
|
¦_ |
Amount
|
Amount of the scheduled payment. The amount element defines the amount of the transaction. Supply the value in cents without a decimal point.
References: Scheduled Payment.Amount
|
¦_ |
Creator
|
User that created the scheduled payment.
References: Scheduled Payment.Creator Code
|
¦_ |
Payment Option
|
Reference to the entity that represents payment option used to collect money on the scheduled payment.
References: Scheduled Payment.Payment Option FK
|
¦_ |
Status
|
Reference to the entity that represents enumeration of possible statuses of the scheduled payment.
References: Scheduled Payment.Status CL
|
¦_ |
Modify Scheduled Payment
|
Allows to modify the selected scheduled payment. Opens Form:
New Scheduled Payment
|
¦_ |
New
|
Allows to create a new scheduled payment and add it to the list. Opens Form:
New Scheduled Payment
|
Payment Options |
Includes the list of payment options associated with the customer.
|
¦_ |
Hide
|
When the eye is closed, the record is not visible to the customer through the self-service portal. |
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Payment Option.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Payment Option.Create Date
|
¦_ |
Number
|
Number of a payment card or bank account.
References: Payment Option.Number
|
¦_ |
Exp Date/Routing #
|
The date when the payment option ends. |
¦_ |
Active
|
Indicates whether the record is active in the system.
References: Payment Option.Is Active
|
¦_ |
Bank
|
Reference to the entity that represents information about the bank that holds the account.
References: Payment Option.Bank Info FK
|
¦_ |
Modify Credit Card
|
Allows to review and modify the selected credit card. Opens Form:
Modify Credit Card
|
¦_ |
Credit Card
|
Allows to add a new credit card to the list. Opens Form:
Modify Credit Card
|
Account Transactions |
Includes the list of account transactions associated with the customer.
|
¦_ |
Hide
|
Allows to hide the selected record.
When the eye is closed, the record is not visible to the customer through the self-service portal. |
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Account Transaction.Id
|
¦_ |
Create Date
|
Date when the record was created. |
¦_ |
Due Date
|
Date when the transaction becomes effective.
References: Account Transaction.Due Date
|
¦_ |
Type
|
Type of the account transaction. |
¦_ |
Description
|
Description of the transaction.
References: Account Transaction.Note
|
¦_ |
Amount
|
Amount of the transaction in cents (without a decimal point).
References: Account Transaction.Amount
|
¦_ |
Balance
|
Remaining balance of the transaction.
References: Account Transaction.Balance
|
¦_ |
Historical Balance
|
Outstanding balance resulting historically from this transaction.
References: Account Transaction.Historical Balance
|
¦_ |
Creator
|
Code of the user that created the account transaction.
References: Account Transaction.Ref Creator Code
|
¦_ |
Edit
|
Allows to edit the creator of the transaction. |
View Transaction
|
Allows to review and modify the selected transaction. Opens Form:
View Asset Transaction
|
Reverse
|
Allows to reverse the selected transaction. |
Payment
|
Allows to create a new payment. Opens Form:
New Payment
|
Refund
|
Allows to create a new refund. Opens Form:
New Refund
|
Credit
|
Allows to create a new credit transaction. Opens Form:
New Credit
|
Fee
|
Allows to create a new fee. Opens Form:
New Fee
|
Invoice
|
Allows to create a new invoice transaction. Opens Form:
New Invoice
|
Actions |
Includes the list of actions associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Action.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Action.Create Date
|
¦_ |
Category
|
Category of the action. |
¦_ |
Creator
|
User who created the action.
References: Action.Creator Code
|
¦_ |
Modify Action
|
Allows to modify the selected action. Opens Form:
Modify Action
|
Letters |
Includes the list of letters associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Letter.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Letter.Create Date
|
¦_ |
Category
|
Category of the letter. |
¦_ |
Status
|
Reference to the entity that represents enumeration of possible letter statuses.
References: Letter.Status CL
|
¦_ |
Creator
|
User who created the letter.
References: Letter.Creator Code
|
¦_ |
Modify Letter
|
Allows to modify the selected letter. Opens Form:
Modify Letter
|
¦_ |
New
|
Allows to create a new letter and add it to the list. Opens Form:
Modify Letter
|
Emails |
Includes the list of emails associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Email.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Email.Create Date
|
¦_ |
Category
|
Category of the email. |
¦_ |
Status
|
Enumerates the range of values of current email status.
References: Email.Status CL
|
¦_ |
Creator
|
User who created the email.
References: Email.Creator Code
|
¦_ |
View Email
|
Allows to review the selected email. Opens Form:
New Email
|
¦_ |
New
|
Allows to create a new email and add it to the list. Opens Form:
New Email
|
Documents |
Includes the list of documents associated with the customer.
|
¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Document.Id
|
¦_ |
Create Date
|
Date when the record was created.
References: Document.Create Date
|
¦_ |
Category
|
Category of the document. |
¦_ |
Description
|
Information related to the account transaction.
References: Document.Description
|
¦_ |
Creator
|
User who created the document.
References: Document.Creator Code
|
¦_ |
Modify Document
|
Allows to modify the selected document. Opens Form:
Modify Document
|
¦_ |
New
|
Allows to add a new document and add it to the list. Opens Form:
Modify Document
|
Audit Log |
Includes the list of audit logs associated with the customer.
|
¦_ |
Date
|
Date when the record was created
References: Audit Log.Create Date
|
|