<back to all web services
FactFinderRequest
Requires Authentication
| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
The following routes are available for this service:| POST,PUT,OPTIONS | /v1/FactFinder | | |
|---|
FactFinderRequest Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| FactFinderSheet | body | FactFinderSheetExtended | No | |
| DataEntry | body | bool | No | |
FactFinderSheetExtended Parameters:| 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 | |
Contact Parameters:| 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 | |
FactFinderSheet Parameters:| 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 | |
ContactSpouse Parameters:| 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 | |
| Email | form | string | No | |
| PastOccupations | form | string | No | |
ContactChild Parameters:| 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 | |
ContactRetirementIncome Parameters:| 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 | |
ContactExpense Parameters:| 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 | |
ContactClientReferral Parameters:| 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 | |
ContactLTAInfo Parameters:| 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 | |
ContactPension Parameters:| 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 .xml suffix or ?format=xml
HTTP + XML
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: application/xml
Content-Type: application/xml
Content-Length: length
<FactFinderRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DataEntry>false</DataEntry>
<FactFinderSheet>
<AdditionalNotes>String</AdditionalNotes>
<Children>
<ContactChild>
<Balance>0</Balance>
<ContactChildId>0</ContactChildId>
<ContactId>0</ContactId>
<Contribution>0</Contribution>
<DOB>0001-01-01T00:00:00</DOB>
<Fund>String</Fund>
<Name>String</Name>
</ContactChild>
</Children>
<Contact>
<Active>false</Active>
<AdditionalInformation>String</AdditionalInformation>
<AgentId>0</AgentId>
<AltPhoneLabel>String</AltPhoneLabel>
<BusinessName>String</BusinessName>
<Carriers>String</Carriers>
<CompanyAffiliation>String</CompanyAffiliation>
<ContactCategory>0</ContactCategory>
<ContactCategoryName>String</ContactCategoryName>
<ContactGUID>00000000-0000-0000-0000-000000000000</ContactGUID>
<ContactId>0</ContactId>
<ContactImage>String</ContactImage>
<ContactStatusDesc>String</ContactStatusDesc>
<ContactStatusId>0</ContactStatusId>
<ContactType>0</ContactType>
<County>String</County>
<CountyID>0</CountyID>
<DBA>String</DBA>
<DateCreated>0001-01-01T00:00:00</DateCreated>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Deleted>false</Deleted>
<DeletedBy>String</DeletedBy>
<DeletedDateTimeUtc>0001-01-01T00:00:00</DeletedDateTimeUtc>
<Department>String</Department>
<District>String</District>
<DistrictID>0</DistrictID>
<DoNotContact>false</DoNotContact>
<EmailPersonal>String</EmailPersonal>
<EmailWork>String</EmailWork>
<FactFinderCodeId>0</FactFinderCodeId>
<FirstName>String</FirstName>
<Flow>String</Flow>
<HasFactFinderSheet>false</HasFactFinderSheet>
<HasGiftCard>false</HasGiftCard>
<HasNBC>false</HasNBC>
<Initials>String</Initials>
<IsShared>false</IsShared>
<JobCount>0</JobCount>
<JobID>0</JobID>
<JobName>String</JobName>
<LastContact>0001-01-01T00:00:00</LastContact>
<LastName>String</LastName>
<Locked>false</Locked>
<LockedByAgentId>0</LockedByAgentId>
<LockedTimestamp>0001-01-01T00:00:00</LockedTimestamp>
<MaritalStatus>String</MaritalStatus>
<MiddleInitial>String</MiddleInitial>
<Name>String</Name>
<NumberOfDebtAccounts>0</NumberOfDebtAccounts>
<PeraContactId>0</PeraContactId>
<Phone>String</Phone>
<PhoneAlt>String</PhoneAlt>
<PhoneLabel>String</PhoneLabel>
<ProjectEndDate>0001-01-01T00:00:00</ProjectEndDate>
<Rate>0</Rate>
<Role>String</Role>
<RoomNumber>String</RoomNumber>
<SMSOptIn>false</SMSOptIn>
<SSN>String</SSN>
<School>String</School>
<SchoolID>0</SchoolID>
<SourceNote>String</SourceNote>
<SourceTypeDesc>String</SourceTypeDesc>
<SourceTypeId>0</SourceTypeId>
<State>String</State>
<StateID>0</StateID>
<StateName>String</StateName>
<Tags>String</Tags>
<Title>String</Title>
<TotalDebtAmount>0</TotalDebtAmount>
<WritingAgentId>0</WritingAgentId>
<WritingAgentName>String</WritingAgentName>
<address_city>String</address_city>
<address_line1>String</address_line1>
<address_state>String</address_state>
<address_zip>String</address_zip>
</Contact>
<Expenses>
<ContactExpense>
<Balance>0</Balance>
<ContactExpenseId>0</ContactExpenseId>
<ContactId>0</ContactId>
<Description>String</Description>
<ExpenseType>String</ExpenseType>
<InterestRate>0</InterestRate>
<MinimumPayment>0</MinimumPayment>
<MonthlyPayment>0</MonthlyPayment>
</ContactExpense>
</Expenses>
<FactFinderSheet>
<ClientGrossMthlyIncome>0</ClientGrossMthlyIncome>
<ClientNetMthlyIncome>0</ClientNetMthlyIncome>
<ContactId>0</ContactId>
<ContractBaseServPerYrDays>0</ContractBaseServPerYrDays>
<ContractBaseServPerYrHours>0</ContractBaseServPerYrHours>
<DaysPerWeek>0</DaysPerWeek>
<DesiredRetirementIncome>0</DesiredRetirementIncome>
<DiscretionaryIncome>0</DiscretionaryIncome>
<EmergencyFundBalance>0</EmergencyFundBalance>
<EmergencyFundComplete>false</EmergencyFundComplete>
<EmergencyFundMthlyContrib>0</EmergencyFundMthlyContrib>
<EmploymentYears>String</EmploymentYears>
<EstimatedExpenses>0</EstimatedExpenses>
<FactFinderSheetId>0</FactFinderSheetId>
<HasDistributionPlan>false</HasDistributionPlan>
<HasPriorEmploymentRetirementSavings>false</HasPriorEmploymentRetirementSavings>
<HasRetirementSavings>false</HasRetirementSavings>
<HoursPerWeek>0</HoursPerWeek>
<HouseholdGrossMthlyIncome>0</HouseholdGrossMthlyIncome>
<HouseholdNetMthlyIncome>0</HouseholdNetMthlyIncome>
<MonthsPerYear>0</MonthsPerYear>
<NumPreTaxChecksPerYr>0</NumPreTaxChecksPerYr>
<PDIPremium>0</PDIPremium>
<PLICarrier>String</PLICarrier>
<PLICashValue>0</PLICashValue>
<PLIFaceAmount>0</PLIFaceAmount>
<PLIIssueDate>0001-01-01T00:00:00</PLIIssueDate>
<PLIPremium>0</PLIPremium>
<PLIType>String</PLIType>
<PLITypeOf>String</PLITypeOf>
<PLTCPremium>0</PLTCPremium>
<PastOccupations>String</PastOccupations>
<PrimaryDisabilityInsurance>false</PrimaryDisabilityInsurance>
<PrimaryLTCInsurance>false</PrimaryLTCInsurance>
<PrimaryLifeInsurance>false</PrimaryLifeInsurance>
<RetirementGoals>String</RetirementGoals>
<SDIPremium>0</SDIPremium>
<SLICarrier>String</SLICarrier>
<SLICashValue>0</SLICashValue>
<SLIFaceAmount>0</SLIFaceAmount>
<SLIIssueDate>0001-01-01T00:00:00</SLIIssueDate>
<SLIPremium>0</SLIPremium>
<SLIType>String</SLIType>
<SLITypeOf>String</SLITypeOf>
<SLTCPremium>0</SLTCPremium>
<SpouseDisabilityInsurance>false</SpouseDisabilityInsurance>
<SpouseLTCInsurance>false</SpouseLTCInsurance>
<SpouseLifeInsurance>false</SpouseLifeInsurance>
<UnusedSickDays>0</UnusedSickDays>
<UnusedSickHours>0</UnusedSickHours>
<WorkStatus>String</WorkStatus>
<YearsWithOtherDistricts>0</YearsWithOtherDistricts>
</FactFinderSheet>
<IncomeSources>
<ContactRetirementIncome>
<AccountOwner>String</AccountOwner>
<AccountType>String</AccountType>
<AddlFormsReqd>false</AddlFormsReqd>
<Carrier>String</Carrier>
<ContactId>0</ContactId>
<ContactRetirementIncomeId>0</ContactRetirementIncomeId>
<Contrib>0</Contrib>
<DateOfIssue>0001-01-01T00:00:00</DateOfIssue>
<EmpNotes>String</EmpNotes>
<FaxAccepted>false</FaxAccepted>
<FaxNumber>String</FaxNumber>
<Fees>0</Fees>
<HasOutstandingLoans>false</HasOutstandingLoans>
<MailingAddr>String</MailingAddr>
<MailingCity>String</MailingCity>
<MailingState>String</MailingState>
<MailingZip>String</MailingZip>
<OriginalFormsReqd>false</OriginalFormsReqd>
<PolicyNum>String</PolicyNum>
<SignatureGuarReqd>false</SignatureGuarReqd>
<SurrCharge>0</SurrCharge>
<SurrValue>0</SurrValue>
<TaxCode>String</TaxCode>
<ThirdPrtyPprwrkOK>false</ThirdPrtyPprwrkOK>
<TotalValue>0</TotalValue>
</ContactRetirementIncome>
</IncomeSources>
<LTAInfo>
<ContactLTAInfo>
<Balance>0</Balance>
<Company>String</Company>
<ContactId>0</ContactId>
<ContactLTAInfoId>0</ContactLTAInfoId>
<Contribution>0</Contribution>
<PlanType>String</PlanType>
</ContactLTAInfo>
</LTAInfo>
<Pensions>
<ContactPension>
<ContactId>0</ContactId>
<ContactPensionId>0</ContactPensionId>
<DefinedBenefitBalance>0</DefinedBenefitBalance>
<DefinedBenefitSpouseBalance>0</DefinedBenefitSpouseBalance>
<DesiredRetirementAge>0</DesiredRetirementAge>
<DesiredRetirementDate>0001-01-01T00:00:00</DesiredRetirementDate>
<FormulaAt>0</FormulaAt>
<FormulaPercent>0</FormulaPercent>
<PensionStartDate>0001-01-01T00:00:00</PensionStartDate>
<PensionSystem>String</PensionSystem>
<ServiceCredit>0</ServiceCredit>
<ServiceCreditAsOfDate>0001-01-01T00:00:00</ServiceCreditAsOfDate>
<SpousalBenefitDesired>false</SpousalBenefitDesired>
</ContactPension>
</Pensions>
<Referrals>
<ContactClientReferral>
<Campus>String</Campus>
<ContactClientReferralId>0</ContactClientReferralId>
<ContactId>0</ContactId>
<Name>String</Name>
<Phone>String</Phone>
<Room>String</Room>
</ContactClientReferral>
</Referrals>
<Spouse>
<Cell>String</Cell>
<ContactId>0</ContactId>
<ContactSpouseId>0</ContactSpouseId>
<DOB>0001-01-01T00:00:00</DOB>
<Email>String</Email>
<Employer>String</Employer>
<Name>String</Name>
<PastOccupations>String</PastOccupations>
<Position>String</Position>
<Years>0</Years>
</Spouse>
</FactFinderSheet>
</FactFinderRequest>