| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinder |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FactFinderSheet | body | FactFinderSheetExtended | No | |
| DataEntry | body | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Contact | form | Contact | No | |
| FactFinderSheet | form | FactFinderSheet | No | |
| Spouse | form | ContactSpouse | No | |
| Children | form | List<ContactChild> | No | |
| IncomeSources | form | List<ContactRetirementIncome> | No | |
| AdditionalNotes | form | string | No | |
| Expenses | form | List<ContactExpense> | No | |
| Referrals | form | List<ContactClientReferral> | No | |
| LTAInfo | form | List<ContactLTAInfo> | No | |
| Pensions | form | List<ContactPension> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactId | form | int | No | |
| ContactType | form | int | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Name | form | string | No | |
| Role | form | string | No | |
| Title | form | string | No | |
| EmailWork | form | string | No | |
| EmailPersonal | form | string | No | |
| District | form | string | No | |
| DistrictID | form | int | No | |
| School | form | string | No | |
| SchoolID | form | long | No | |
| State | form | string | No | |
| StateName | form | string | No | |
| StateID | form | long | No | |
| CountyID | form | long | No | |
| County | form | string | No | |
| Phone | form | string | No | |
| Department | form | string | No | |
| Flow | form | string | No | |
| LastContact | form | DateTime | No | |
| DoNotContact | form | bool | No | |
| Active | form | bool | No | |
| AgentId | form | int | No | |
| PhoneAlt | form | string | No | |
| PeraContactId | form | int | No | |
| RoomNumber | form | string | No | |
| SourceTypeId | form | int | No | |
| SourceTypeDesc | form | string | No | |
| SourceNote | form | string | No | |
| ContactStatusId | form | int | No | |
| ContactStatusDesc | form | string | No | |
| SSN | form | string | No | |
| DateOfBirth | form | DateTime | No | |
| Deleted | form | bool | No | |
| IsShared | form | bool | No | |
| address_line1 | form | string | No | |
| address_city | form | string | No | |
| address_state | form | string | No | |
| address_zip | form | string | No | |
| DeletedBy | form | string | No | |
| DeletedDateTimeUtc | form | DateTime? | No | |
| HasNBC | form | bool | No | |
| HasFactFinderSheet | form | bool | No | |
| MiddleInitial | form | string | No | |
| Tags | form | string | No | |
| DateCreated | form | DateTime | No | |
| PhoneLabel | form | string | No | |
| AltPhoneLabel | form | string | No | |
| Carriers | form | string | No | |
| ContactImage | form | string | No | |
| CompanyAffiliation | form | string | No | |
| AdditionalInformation | form | string | No | |
| HasGiftCard | form | bool | No | |
| ContactCategory | form | int | No | |
| WritingAgentId | form | int | No | |
| WritingAgentName | form | string | No | |
| MaritalStatus | form | string | No | |
| TotalDebtAmount | form | decimal | No | |
| NumberOfDebtAccounts | form | int | No | |
| FactFinderCodeId | form | int | No | |
| BusinessName | form | string | No | |
| DBA | form | string | No | |
| ContactGUID | form | Guid | No | |
| ProjectEndDate | form | DateTime | No | |
| Rate | form | int | No | |
| JobID | form | int | No | |
| JobName | form | string | No | |
| JobCount | form | int | No | |
| Locked | form | bool | No | |
| LockedByAgentId | form | int | No | |
| LockedTimestamp | form | DateTime | No | |
| Initials | form | string | No | |
| ContactCategoryName | form | string | No | |
| SMSOptIn | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FactFinderSheetId | form | int | No | |
| ContactId | form | int | No | |
| EmploymentYears | form | string | No | |
| PastOccupations | form | string | No | |
| ClientGrossMthlyIncome | form | decimal? | No | |
| ClientNetMthlyIncome | form | decimal? | No | |
| HouseholdGrossMthlyIncome | form | decimal? | No | |
| HouseholdNetMthlyIncome | form | decimal? | No | |
| EstimatedExpenses | form | decimal? | No | |
| DiscretionaryIncome | form | decimal? | No | |
| DesiredRetirementIncome | form | decimal? | No | |
| RetirementGoals | form | string | No | |
| EmergencyFundMthlyContrib | form | decimal? | No | |
| EmergencyFundBalance | form | decimal? | No | |
| EmergencyFundComplete | form | bool? | No | |
| WorkStatus | form | string | No | |
| UnusedSickDays | form | decimal? | No | |
| UnusedSickHours | form | decimal? | No | |
| ContractBaseServPerYrDays | form | decimal? | No | |
| ContractBaseServPerYrHours | form | decimal? | No | |
| DaysPerWeek | form | decimal? | No | |
| HoursPerWeek | form | decimal? | No | |
| MonthsPerYear | form | decimal? | No | |
| NumPreTaxChecksPerYr | form | int? | No | |
| YearsWithOtherDistricts | form | decimal? | No | |
| PrimaryLifeInsurance | form | bool? | No | |
| PLICarrier | form | string | No | |
| PLIFaceAmount | form | decimal? | No | |
| PLIIssueDate | form | DateTime? | No | |
| PLIPremium | form | decimal? | No | |
| PLIType | form | string | No | |
| PLITypeOf | form | string | No | |
| PLICashValue | form | decimal? | No | |
| SpouseLifeInsurance | form | bool? | No | |
| SLICarrier | form | string | No | |
| SLIFaceAmount | form | decimal? | No | |
| SLIIssueDate | form | DateTime? | No | |
| SLIPremium | form | decimal? | No | |
| SLIType | form | string | No | |
| SLITypeOf | form | string | No | |
| SLICashValue | form | decimal? | No | |
| PrimaryLTCInsurance | form | bool? | No | |
| PLTCPremium | form | decimal? | No | |
| PrimaryDisabilityInsurance | form | bool? | No | |
| PDIPremium | form | decimal? | No | |
| SpouseLTCInsurance | form | bool? | No | |
| SLTCPremium | form | decimal? | No | |
| SpouseDisabilityInsurance | form | bool? | No | |
| SDIPremium | form | decimal? | No | |
| HasRetirementSavings | form | bool? | No | |
| HasPriorEmploymentRetirementSavings | form | bool? | No | |
| HasDistributionPlan | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactSpouseId | form | int | No | |
| ContactId | form | int | No | |
| Name | form | string | No | |
| DOB | form | DateTime? | No | |
| Cell | form | string | No | |
| Employer | form | string | No | |
| Years | form | decimal? | No | |
| Position | form | string | No | |
| form | string | No | ||
| PastOccupations | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactChildId | form | int | No | |
| ContactId | form | int | No | |
| Name | form | string | No | |
| DOB | form | DateTime? | No | |
| Fund | form | string | No | |
| Contribution | form | decimal? | No | |
| Balance | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactRetirementIncomeId | form | int | No | |
| ContactId | form | int | No | |
| AccountOwner | form | string | No | |
| AccountType | form | string | No | |
| Carrier | form | string | No | |
| TotalValue | form | decimal? | No | |
| SurrValue | form | decimal? | No | |
| DateOfIssue | form | DateTime? | No | |
| Fees | form | decimal? | No | |
| PolicyNum | form | string | No | |
| Contrib | form | decimal? | No | |
| EmpNotes | form | string | No | |
| TaxCode | form | string | No | |
| SurrCharge | form | decimal? | No | |
| ThirdPrtyPprwrkOK | form | bool? | No | |
| AddlFormsReqd | form | bool? | No | |
| OriginalFormsReqd | form | bool? | No | |
| SignatureGuarReqd | form | bool? | No | |
| FaxAccepted | form | bool? | No | |
| FaxNumber | form | string | No | |
| MailingAddr | form | string | No | |
| MailingCity | form | string | No | |
| MailingState | form | string | No | |
| MailingZip | form | string | No | |
| HasOutstandingLoans | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactExpenseId | form | int | No | |
| ContactId | form | int | No | |
| ExpenseType | form | string | No | |
| Description | form | string | No | |
| Balance | form | decimal? | No | |
| InterestRate | form | decimal? | No | |
| MinimumPayment | form | decimal? | No | |
| MonthlyPayment | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactClientReferralId | form | int | No | |
| ContactId | form | int | No | |
| Name | form | string | No | |
| Campus | form | string | No | |
| Room | form | string | No | |
| Phone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactLTAInfoId | form | int | No | |
| ContactId | form | int | No | |
| PlanType | form | string | No | |
| Company | form | string | No | |
| Contribution | form | decimal? | No | |
| Balance | form | decimal? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ContactPensionId | form | int | No | |
| ContactId | form | int | No | |
| PensionSystem | form | string | No | |
| PensionStartDate | form | DateTime? | No | |
| ServiceCredit | form | decimal? | No | |
| ServiceCreditAsOfDate | form | DateTime? | No | |
| DesiredRetirementDate | form | DateTime? | No | |
| DesiredRetirementAge | form | int | No | |
| SpousalBenefitDesired | form | bool? | No | |
| FormulaPercent | form | decimal? | No | |
| FormulaAt | form | decimal? | No | |
| DefinedBenefitBalance | form | decimal? | No | |
| DefinedBenefitSpouseBalance | form | decimal? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FactFinder HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
FactFinderSheet:
{
Contact:
{
ContactId: 0,
ContactType: 0,
FirstName: String,
LastName: String,
Name: String,
Role: String,
Title: String,
EmailWork: String,
EmailPersonal: String,
District: String,
DistrictID: 0,
School: String,
SchoolID: 0,
State: String,
StateName: String,
StateID: 0,
CountyID: 0,
County: String,
Phone: String,
Department: String,
Flow: String,
LastContact: 0001-01-01,
DoNotContact: False,
Active: False,
AgentId: 0,
PhoneAlt: String,
PeraContactId: 0,
RoomNumber: String,
SourceTypeId: 0,
SourceTypeDesc: String,
SourceNote: String,
ContactStatusId: 0,
ContactStatusDesc: String,
SSN: String,
DateOfBirth: 0001-01-01,
Deleted: False,
IsShared: False,
address_line1: String,
address_city: String,
address_state: String,
address_zip: String,
DeletedBy: String,
DeletedDateTimeUtc: 0001-01-01,
HasNBC: False,
HasFactFinderSheet: False,
MiddleInitial: String,
Tags: String,
DateCreated: 0001-01-01,
PhoneLabel: String,
AltPhoneLabel: String,
Carriers: String,
ContactImage: String,
CompanyAffiliation: String,
AdditionalInformation: String,
HasGiftCard: False,
ContactCategory: 0,
WritingAgentId: 0,
WritingAgentName: String,
MaritalStatus: String,
TotalDebtAmount: 0,
NumberOfDebtAccounts: 0,
FactFinderCodeId: 0,
BusinessName: String,
DBA: String,
ContactGUID: 00000000000000000000000000000000,
ProjectEndDate: 0001-01-01,
Rate: 0,
JobID: 0,
JobName: String,
JobCount: 0,
Locked: False,
LockedByAgentId: 0,
LockedTimestamp: 0001-01-01,
Initials: String,
ContactCategoryName: String,
SMSOptIn: False
},
FactFinderSheet:
{
FactFinderSheetId: 0,
ContactId: 0,
EmploymentYears: String,
PastOccupations: String,
ClientGrossMthlyIncome: 0,
ClientNetMthlyIncome: 0,
HouseholdGrossMthlyIncome: 0,
HouseholdNetMthlyIncome: 0,
EstimatedExpenses: 0,
DiscretionaryIncome: 0,
DesiredRetirementIncome: 0,
RetirementGoals: String,
EmergencyFundMthlyContrib: 0,
EmergencyFundBalance: 0,
EmergencyFundComplete: False,
WorkStatus: String,
UnusedSickDays: 0,
UnusedSickHours: 0,
ContractBaseServPerYrDays: 0,
ContractBaseServPerYrHours: 0,
DaysPerWeek: 0,
HoursPerWeek: 0,
MonthsPerYear: 0,
NumPreTaxChecksPerYr: 0,
YearsWithOtherDistricts: 0,
PrimaryLifeInsurance: False,
PLICarrier: String,
PLIFaceAmount: 0,
PLIIssueDate: 0001-01-01,
PLIPremium: 0,
PLIType: String,
PLITypeOf: String,
PLICashValue: 0,
SpouseLifeInsurance: False,
SLICarrier: String,
SLIFaceAmount: 0,
SLIIssueDate: 0001-01-01,
SLIPremium: 0,
SLIType: String,
SLITypeOf: String,
SLICashValue: 0,
PrimaryLTCInsurance: False,
PLTCPremium: 0,
PrimaryDisabilityInsurance: False,
PDIPremium: 0,
SpouseLTCInsurance: False,
SLTCPremium: 0,
SpouseDisabilityInsurance: False,
SDIPremium: 0,
HasRetirementSavings: False,
HasPriorEmploymentRetirementSavings: False,
HasDistributionPlan: False
},
Spouse:
{
ContactSpouseId: 0,
ContactId: 0,
Name: String,
DOB: 0001-01-01,
Cell: String,
Employer: String,
Years: 0,
Position: String,
Email: String,
PastOccupations: String
},
Children:
[
{
ContactChildId: 0,
ContactId: 0,
Name: String,
DOB: 0001-01-01,
Fund: String,
Contribution: 0,
Balance: 0
}
],
IncomeSources:
[
{
ContactRetirementIncomeId: 0,
ContactId: 0,
AccountOwner: String,
AccountType: String,
Carrier: String,
TotalValue: 0,
SurrValue: 0,
DateOfIssue: 0001-01-01,
Fees: 0,
PolicyNum: String,
Contrib: 0,
EmpNotes: String,
TaxCode: String,
SurrCharge: 0,
ThirdPrtyPprwrkOK: False,
AddlFormsReqd: False,
OriginalFormsReqd: False,
SignatureGuarReqd: False,
FaxAccepted: False,
FaxNumber: String,
MailingAddr: String,
MailingCity: String,
MailingState: String,
MailingZip: String,
HasOutstandingLoans: False
}
],
AdditionalNotes: String,
Expenses:
[
{
ContactExpenseId: 0,
ContactId: 0,
ExpenseType: String,
Description: String,
Balance: 0,
InterestRate: 0,
MinimumPayment: 0,
MonthlyPayment: 0
}
],
Referrals:
[
{
ContactClientReferralId: 0,
ContactId: 0,
Name: String,
Campus: String,
Room: String,
Phone: String
}
],
LTAInfo:
[
{
ContactLTAInfoId: 0,
ContactId: 0,
PlanType: String,
Company: String,
Contribution: 0,
Balance: 0
}
],
Pensions:
[
{
ContactPensionId: 0,
ContactId: 0,
PensionSystem: String,
PensionStartDate: 0001-01-01,
ServiceCredit: 0,
ServiceCreditAsOfDate: 0001-01-01,
DesiredRetirementDate: 0001-01-01,
DesiredRetirementAge: 0,
SpousalBenefitDesired: False,
FormulaPercent: 0,
FormulaAt: 0,
DefinedBenefitBalance: 0,
DefinedBenefitSpouseBalance: 0
}
]
},
DataEntry: False
}