| Doc. Number | Article Title | Effective Date | Version |
| FHC-XX | Insights Table Definitions | May 27, 2024 | 0.3 |
Table menu
Call Logs
|
Field Name |
Field Type |
Example Value |
Description |
|
Call ID |
Number |
194806655 |
The unique ID of the call in the system. |
|
Call Timestamp |
Date/Time |
12/24/2020, 03:18 PM |
Date and time in which the call was logged. |
|
Call Direction |
String |
Incoming/Outgoing |
Whether or not the call was an incoming call or an outgoing call. |
|
Duration (sec) |
Number |
120 |
The duration of the call in seconds. |
|
Event Type |
String |
Phone Call |
The type of event the call log represents. |
|
Dialer |
String |
Bluerock / Ytel / Five9 / Vicidial |
The phone system integration that logged the call. |
|
Status Change To |
String |
Follow Up / First Attempt / Second Attempt / Third Attempt |
The workflow status the contact record changed to when the call was logged. |
|
Disposition |
String |
Connected / Disconnected / No Answer |
The call log disposition that was saved on the call log. |
Campaigns
|
Field Name |
Field Type |
Example Value |
Description |
|
Created at Timestamp |
Date/Time |
12/25/2020 9:00 |
Date and time in which the campaign was created in the system. |
|
Campaign Name |
String |
Website Leads Campaign |
The name of the campaign in the system. |
|
Campaign Name - Extended |
String |
Website Leads Campaign (inactive) / Website Leads Campaign (deleted) |
The name of the campaign in the system including if the campaign is deleted or inactive. |
|
Campaign Cost |
Number |
10,000.00 |
The cost of the campaign in dollars. |
|
Leads Purchased |
Number |
2000 |
The number of leads purchased with this campaign. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the campaign is deleted in the system. |
|
Company Name |
String |
ABC Debt Settlement Co. |
The name of the company the campaign is assigned to in the system. |
|
Source Name |
String |
Leadgen Media |
The source of the campaign data. |
Client Fees
|
Field Name |
Field Type |
Example Value |
Description |
|
Transaction ID |
Number |
529729715 |
The unique ID of the transaction in the system. |
|
Created At |
Date/Time |
12/24/2020, 05:30 PM |
The date and time in which the transaction was created in the system. |
|
DEBT_ID |
Number |
90974544 |
The unique ID of the debt that the fee relates to. |
|
Trans Type |
String |
Earned Performance Fee / ACH Credit Fee |
The type of fee in the system. |
|
Amount |
Number |
500 |
The dollar value of the fee that is getting processed. |
|
Process Date |
Date |
12/25/2020 |
The date on which the fee is scheduled to be processed in the system. |
|
Cleared Date |
Date |
12/25/2020 |
The date on which the fee was cleared in the system. |
|
Is Active |
Enum |
Yes/No |
Whether or not the fee is marked as active in the system. |
|
Is Processed |
Enum |
Yes/No |
Whether or not the fee has been processed in the system. |
|
Is Cancelled |
Enum |
Yes/No |
Whether or not the fee is marked as canceled in the system. |
|
Memo |
String |
Earned Performance Fee - Chase |
The memo line of the fee. |
|
Sub-Type |
String |
Performance Fee / Settlement Fee |
An additional descriptor of the fee saved in the system. |
|
Processor |
String |
DebtPayGateway / Global Client Solutions / RAM / EPPS |
The payment gateway processes the fee. |
|
Payee |
String |
Example Company |
The entity that is getting compensated by the fee. |
|
Status |
String |
Open / Pending / Cleared / NSF Returned |
The status of the fee in the system. |
Contacts History
|
Field Name |
Field Type |
Example Value |
Description |
|
History ID |
Number |
1234643746 |
The unique ID of the history event saved in the system. |
|
History Timestamp |
Date/Time |
12/24/2020, 05:30 PM |
The date on which the history event was logged in the system. |
|
Created By |
Number |
2272121 |
The unique ID of the user who saved the history event. |
|
Type |
String |
General / Enrollment / Call / Transaction / Debt / Calendar / Task / Note |
The type of history event that was saved. |
Custom Field Dates
|
Field Name |
Field Type |
Example Value |
Description |
|
Field Name |
String |
Foreclosure Date |
The name of the custom field in the system. |
|
Field Value |
String |
3/4/2017 |
The value of the custom field in the system. |
Custom Field Numeric
|
Field Name |
Field Type |
Example Value |
Description |
|
Field Name |
String |
Est. Debt Amount |
The name of the custom field in the system. |
|
Field Value |
String |
5000 |
The numeric value of the custom field in the system |
Custom Fields Text
|
Field Name |
Field Type |
Example Value |
Description |
|
Field Name |
String |
Bankruptcy Type |
The name of the custom field in the system. |
|
Field Value |
String |
Chapter 7 |
The value of the custom field in the system. |
Credit Reports
|
Field Name |
Field Type |
Example Value |
Description |
|
Request ID |
Number |
2732945 |
The unique ID of the credit pull event in the system. |
|
Created At |
Date/Time |
12/24/2020, 05:30 PM |
The date and time in which the credit pull occurred in the system. |
|
Created_By |
Number |
2272121 |
The unique ID of th user that pulled the credit. |
|
Provider |
String |
Transunion / Trusted Credit File / Universal Credit |
The provider/integration the credit was pulled through. |
Debts
|
Field Name |
Field Type |
Example Value |
Description |
|
Debt ID |
Number |
83958926 |
The ID of the individual debt account. |
|
Settlement Offer Id |
Number |
3650222 |
The ID of a settlement offer linked to a debt account. |
|
Original Debt Amount |
Number |
500.00 |
The original amount of the enrolled debt. |
|
Current Debt Amount |
Number |
500.00 |
The Current amount of the enrolled debt. |
|
Verified Debt Amount |
Number |
600.00 |
The verified amount of the enrolled debt. |
|
Settlement Amount |
Number |
200.00 |
The agreed settlement amount of the debt. |
|
Whose Debt |
String |
Applicant/Co-Applicant/Joint |
Who the debt account belongs to among the primary applicant and the co-applicant. |
|
Is Enrolled |
Enum |
Yes/No |
Whether or not the debt is enrolled in the program. |
|
Is Settled |
Enum |
Yes/No |
Whether or not the debt has been settled. |
|
Is Legal |
Enum |
Yes/No |
Whether or not debt is marked as in summons/judgment. |
|
Settlement Date |
Date |
12/25/2020 |
The date in which a settlement agreement was reached and the debt was marked as settled in the system. |
|
Verified Date |
Date |
12/25/2020 |
The date in which the debt was last verified after it was enrolled in the program. |
|
Summons Date |
Date |
12/25/2020 |
The court summons date tied to the litigation process. |
|
Last Payment Date |
Date |
12/25/2020 |
The date in which a payment was last made on the debt. |
|
Opened Date |
Date |
12/25/2020 |
The opened date tied to the litigation process. |
|
Current Mnt Payment |
Number |
240.00 |
The current monthly payment being made on that debt account. |
|
POA sent date |
Date |
12/25/2020 |
The date a power of attorney document was sent. |
|
Answer Date |
Date |
12/25/2020 |
The answer date tied to the litigation process. |
|
Court Date |
Date |
12/25/2020 |
The court date tied to the litigation process. |
|
Service Date |
Date |
12/25/2020 |
The service date tied to the litigation process. |
|
Paperwork Date |
Date |
12/25/2020 |
The paperwork date tied to the litigation process. |
|
Lien Date |
Date |
12/25/2020 |
The lien date tied to the litigation process. |
|
Judgement Date |
Date |
12/25/2020 |
The judgement date tied to the litigation process. |
|
Charge-Off Date |
Date |
12/25/2020 |
The date in which the debt was marked as a charge-off. |
|
Current Interest Rate |
Number |
5.00 |
The current interest rate associated with the debt. |
|
Original Creditor |
String |
Discover |
Which creditor the debt originated with. |
|
Current Creditor |
String |
Community Bank |
The current creditor that debt is now associated with. |
|
Debt Type |
String |
Credit Card, Personal Loan, Mortgage, Collections, Autoloan. |
The type of debt the account represents. |
Doc Signings
|
Field Name |
Field Type |
Example Value |
Description |
|
Signing ID |
Number |
1930137 |
The unique identifier of the signing event in the system. |
|
Provider |
String |
E-Sign / Clixsign |
The service the document signature was initiated through. |
|
Doc Title |
String |
Enrollment Agreement |
The document template title that was sent for signature to the contact. |
|
Sent at Timestamp |
Date/Time |
12/24/2020, 05:30 PM |
The time stamp in which the document was sent to the contact at. |
|
Signing Status |
String |
Sent / Opened / Completed / Declined |
The status in the signature process that the document currently resides in. |
Doc Sign User
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Drafts
|
Field Name |
Field Type |
Example Value |
Description |
|
Transaction ID |
Integer |
529729715 |
The unique ID of the transaction in the system. |
|
Created at Timestamp |
Date/Time |
12/25/2020, 9:00 AM |
The date and time in which a transaction was created. |
|
CONTACT_ID |
Integer |
226403972 |
Unique ID of the contact record in the system a payment relates to. |
|
Amount |
Number |
350.00 |
The dollar amount value of the transaction. |
|
Process Date |
Date |
12/25/2020 |
The date in which the transaction is scheduled to process. |
|
Cleared Date |
Date |
12/25/2020 |
The date on which the transaction is registered as cleared in the system. |
|
Returned Date |
Date |
12/25/2020 |
The date on which the transaction is registered as returned in the system. |
|
Is Active |
Enum |
Yes/No |
Whether or not the transaction is marked as active in the system. |
|
Is Processed |
Enum |
Yes/No |
Whether or not the transaction has been processed in the system. |
|
Is Cancelled |
Enum |
Yes/No |
Whether or not the transaction is marked as canceled in the system. |
|
Memo |
String |
Monthly Program Draft |
The transaction memo's description related to the transaction. |
|
Return Code |
String |
R01 |
The return code relates to why a transaction is returned. |
|
Day of Month |
String |
15th |
The relative day of the month in which transactions are scheduled to be processed. Applicable in a monthly payment program. |
|
Day of Week |
String |
Wednesday |
Day of week in which a payment is drafted. |
|
Payment # |
Number |
5.00 |
The number of the payment in the program. |
|
Status |
String |
Open, Cleared, Returned / NSF, Cancelled. |
The status of the payment. |
|
Trans Type |
String |
Ach Client Debt, Credit Card Payment, Check. |
The type of payment drafting from the client. |
|
Processor |
String |
DebtPayGateway |
The payment gateway that is drafting the client. |
|
Sub Type |
String |
Check, 2nd Day Check, Check Overnight. |
An additional descriptor identifying the type or method of payment. |
Emails
|
Field Name |
Field Type |
Example Value |
Description |
|
Email ID |
Number |
243754877 |
The unique ID of the email that was sent. |
|
Email Sent At |
Date/Time |
12/24/2020, 05:30 PM |
The date and time in which the email was sent. |
|
Subject |
String |
John - Save $2,000 or more on your debt now! |
The subject line of the email message that was sent. |
|
Opened at Timestamp |
Date/Time |
12/24/2020, 05:35 PM |
The date and time when the contact opened the email. |
|
Was Opened |
Enum |
Yes/No |
Whether or not the email was opened. |
|
Time To Open (min) |
Number |
5 |
The time between the email was sent and when it was opened by the contact in minutes. |
Email Sent By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Enrollment Plan
|
Field Name |
Field Type |
Example Value |
Description |
|
Plan ID |
Number |
25877 |
The unique ID of the plan saved in the system. |
|
Fee 1 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee that is stored for the first fee in the system. |
|
Fee 1 Total |
Number |
2000 |
The total value of the first fee in the system that was saved on the contact record. |
|
Fee 2 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee that is stored for the second fee in the system. |
|
Fee 2 Total |
Number |
2000 |
The total value of the second fee in the system that was saved on the contact record. |
|
Fee 3 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee that is stored for the third fee in the system. |
|
Fee 3 Total |
Number |
2000 |
The total value of the third fee in the system that was saved on the contact record. |
|
Fee 4 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee is stored for the fourth fee in the system. |
|
Fee 4 Total |
Number |
2000 |
The total value of the fourth fee in the system saved on the contact record. |
|
Fee 5 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee that is stored for the fith fee in the system. |
|
Fee 5 Total |
Number |
2000 |
The total value of the first fee in the system that was saved on the contact record. |
|
Fee 6 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee that is stored for the sixth fee in the system. |
|
Fee 6 Total |
Number |
2000 |
The total value of the sixth fee in the system saved on the contact record. |
|
Fee 7 Name |
String |
Performance Fee / Monthly Fee / Escrow Fee. / Setup Fee |
The name of the fee is stored for the seventh fee in the system. |
|
Fee 7 Total |
Number |
2000 |
The total value of the seventh fee in the system saved on the contact record. |
|
Est. Sett % |
Number |
0.4 |
The estimated settlement percentage that was saved on the contact record. |
|
Program Months |
String |
48 |
The length of the program in months the contact is enrolled for. |
|
Payment Frequency |
String |
Monthly, Semi Monthly, Bi-Weekly, Weekly, Daily |
The frequency of payments in the system the contact is paying. |
|
Plan Name |
String |
Performance Plan/Standard Plan |
The name of the enrollment plan in the system that was saved on the contact record. |
Negotiator
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Note Created By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Notes
|
Field Name |
Field Type |
Example Value |
Description |
|
Note ID |
String |
N157938797 |
The unique identifier of the note in the system. |
|
Note Type |
String |
General/Creditor Correspondence/Accounting /Call/Sales |
The type of note in the system that was saved. |
|
Created at Timestamp |
Date/Time |
12/25/2020, 9:00 AM |
The date/time the note was saved on the contact record. |
Offer Created By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Offer Created By / Modified By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Offer Modified By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Program Summary
|
Field Name |
Field Type |
Example Value |
Description |
|
Months Enrolled |
Number |
48 |
The length of time in months the contact has been enrolled. |
|
Days Enrolled |
Number |
129 |
The length of time in days the contact has been enrolled. |
|
Draft Progress % |
Number |
0.44 |
The percentage represented as a decimal of the completion of drafts in the program. |
|
Balance |
Number |
5000 |
The total balance he contact has in escrow |
Report Pulled By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Secondary Assignments
|
Field Name |
Field Type |
Example Value |
Description |
|
Assignment Name |
String |
Lead Vendor / Marketing Company / Servicing Company / Law Firm |
The name of the assignment in the system. This is in terms of company or role. |
|
Assignment Type |
String |
Company / User Role |
The type of secondary assignment. |
|
Assigned To |
String |
Test Company / John Smith |
The company or individual user secondary assigned to the file. |
Settlement Offers
|
Field Name |
Field Type |
Example Value |
Description |
|
Offer ID |
Number |
3,650,222.00 |
The unique ID of the settlement offer saved in the system. |
|
Created at Timestamp |
Date/Time |
12/25/2020 9:00 |
The date and time the offer was created in the system. |
|
Modified at Timestamp |
Date/Time |
12/25/2020 9:00 |
The date and time the offer was last modified in the system. |
|
Offer Made By |
Enum |
Negotiator/Creditor |
Who made the offer between the negotiator and the creditor. |
|
Offer Valid Until |
Date/Time |
12/25/2020 |
The date in which the offer is valid until. |
|
Debt Amount at Settlement |
Number |
4,000.00 |
The amount of debt the user is settling at the time of settlement. |
|
Settlement amount |
Number |
1,800.00 |
The settlement amount that was agreed upon and accepted into the system. |
|
Settlement Fee |
Number |
800.00 |
The fee that was scheduled at the time of settlement. |
|
Offer Status |
String |
In Review/Accepted/Declined |
The status the offer currently resides in. |
Settlement Payments
|
Field Name |
Field Type |
Example Value |
Description |
|
Transaction ID |
Number |
529729715 |
The unique ID of the transaction in the system. |
|
Account ID |
Number |
2123 |
ID of the Account in the System |
|
Created At |
Date/Time |
12/24/2020, 06:16 AM |
The date and time in which a transaction was created. |
|
Created By |
Number |
2272121 |
Unique ID of the user who created the transaction. |
|
Contact ID |
Number |
226403972 |
The unique ID of the contact the settlement payment relates to. |
|
Debt ID |
Number |
90974544 |
The unique ID of the debt the settlement payment relates to |
|
Trans Type |
String |
Settlement Payment |
The type of payment the transaction represents. |
|
Gateway ID |
Number |
1 |
The unique ID of the payment gateway processing the settlement payment. |
|
Amount |
Number |
500 |
The dollar amount value of the settlement payment. |
|
Process Date |
Date |
12/25/2020 |
The date on which the settlement payment is scheduled to be processed in the system. |
|
Cleared Date |
Date |
12/25/2020 |
The date on which the settlement payment was cleared in the system. |
|
Returned Date |
Date |
12/25/2020 |
The date on which the settlement payment was returned in the system. |
|
Status ID |
Number |
3432432 |
The unique ID of the status in the system. |
|
Is Active |
Enum |
Yes/No |
Whether or not the settlement payment is marked as active in the system. |
|
Is Processed |
Enum |
Yes/No |
Whether or not the settlement payment has been processed in the system. |
|
Is Cancelled |
Enum |
Yes/No |
Whether or not the settlement payment is marked as cancelled in the system. |
|
Memo |
String |
Settlement Payment - Chase |
The memo line of the settlement payment. |
|
Return Code |
String |
R01 |
The return code that relates to why the settlement payment was returned. |
|
Paid To |
String |
323123 |
For Direct Pay transactions only - the unique ID of the creditor paid out on the transaction |
|
Sub Type |
String |
ACH / Check By Phone, Check, 2nd Day Check, Overnight Check, Direct Pay |
The sub-type of the settlement payment. This indicates the method by which the creditor is getting paid through the system. |
SMS
|
Field Name |
Field Type |
Example Value |
Description |
|
SMS ID |
Number |
34001011 |
The unique ID of the SMS message that was sent. |
|
LAUNCH_ID |
Number |
178623 |
The unique ID of the SMS campaign launch. |
|
SCHEDULE_ID |
Number |
25386 |
The Unique ID of the SMS campaign scheduled launch. |
|
COMPANY_ID |
Number |
50767 |
The company ID the SMS was sent under. |
|
SMS Timestamp |
Date/Time |
12/25/2020, 05:30 PM |
The date and time in which an SMS message transpired in. |
|
Direction |
Enum |
Incoming/Outgoing |
Whether the SMS was an incoming message or an outgoing one. |
|
Phone Number |
String |
15557779999 |
The phone number that transmitted or received the SMS message. |
|
Friendly Name |
String |
Customer Service Number |
The friendly name of the number that transmitted or received the SMS message. |
SMS Sent By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Status Change History
|
Field Name |
Field Type |
Example Value |
Description |
|
Status Change ID |
Number |
1234643657 |
The unique ID of the status change event that is logged. |
|
Contact ID |
Number |
300678828 |
The unique ID of the contact record the status change event occurred on |
|
Change Timestamp |
Date/Time |
12/24/2020, 05:30 PM |
The date and time on which the status change event occurred. |
|
Stage |
String |
Lead / Underwriting / Client / Inactive |
The stage in the system that the contact changed into. |
|
Status |
String |
New Lead / Follow Up / Submitted / Enrolled / Cancelled |
The status in the system of the contact changed. |
Tasks
|
Field Name |
Field Type |
Example Value |
Description |
|
Task ID |
Number |
1169977 |
The unique ID of the task in the system. |
|
Created At Timestamp |
Date/Time |
12/24/2020, 05:30 PM |
The date and time in which a task was created in the system. |
|
Task Name |
String |
Monthly Follow Up |
The name of the task in the system. |
|
Task Type |
String |
Template / Freeform |
Whether or not the task is a templated task or a freeform entry task. |
|
Assignment Type |
String |
User / Team / Contact |
Whether the task is assigned to a user, team, or contact. |
|
Is Completed |
Enum |
Yes/No |
Whether or not the task is completed in the system. |
|
Is Overdue |
Enum |
Yes/No |
Whether or not the task is overdue in the system. |
|
Due in Days |
Number |
1 |
The days in which the task is due from today's date. |
|
Completed in Days |
Number |
1 |
The number of days between the created date and the completed date of the task. |
|
Due Date |
Date |
12/25/2020 |
The due date of the task in the system. |
|
Completed Date |
Date/Time |
12/25/2020, 05:30 PM |
The date on which a task is completed in the system |
|
Assigned Team |
String |
Customer Service |
The name of a team the task is assigned to. |
|
Task Status |
String |
Incomplete / Completed / Overdue |
The status of the task in the system. |
Task Assigned By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Task Created By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
Company name the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Task Completed By
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
Username of a user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
The company name that the user belongs to. |
Users
|
Field Name |
Field Type |
Example Value |
Description |
|
Username |
String |
Jsmith |
The username of a user in the system |
|
Is Active |
Enum |
Yes/No |
Whether or not the user is active in the system. |
|
Is Deleted |
Enum |
Yes/No |
Whether or not the user is deleted in the system. |
|
Name |
String |
John Smith |
Full name of the user in the system. |
|
Name - Extended |
String |
John Smith (deleted)/John Smith (inactive) |
Full name of the user in the system with inactive/deleted appended if applicable to that user. |
|
Company |
String |
ABC Debt Relief Corp. |
A company name that the user belongs to. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
|
Role Name |
String |
Negotiator/Sales/Super Admin |
The user's assigned role in the system. |
Article Version History:
| Version | Effective Date | Description |
| Basic | 01/12/2021 | Initial Release |
| 0.1 | 09/23/2022 | Minor Updates |
| 0.2 | 03/20/2023 | Added header and version control footer; |
| 0.3 | 05/27/2024 | No subject matter updates; minor grammatical adjustments. |