Trendsic Platform Service

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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FactFinderRequest
{
    open var FactFinderSheet:FactFinderSheetExtended? = null
    open var DataEntry:Boolean? = null
}

open class FactFinderSheetExtended
{
    open var Contact:Contact? = null
    open var FactFinderSheet:FactFinderSheet? = null
    open var Spouse:ContactSpouse? = null
    open var Children:ArrayList<ContactChild> = ArrayList<ContactChild>()
    open var IncomeSources:ArrayList<ContactRetirementIncome> = ArrayList<ContactRetirementIncome>()
    open var AdditionalNotes:String? = null
    open var Expenses:ArrayList<ContactExpense> = ArrayList<ContactExpense>()
    open var Referrals:ArrayList<ContactClientReferral> = ArrayList<ContactClientReferral>()
    open var LTAInfo:ArrayList<ContactLTAInfo> = ArrayList<ContactLTAInfo>()
    open var Pensions:ArrayList<ContactPension> = ArrayList<ContactPension>()
}

open class Contact
{
    open var ContactId:Int? = null
    open var ContactType:Int? = null
    open var FirstName:String? = null
    open var LastName:String? = null
    open var Name:String? = null
    open var Role:String? = null
    open var Title:String? = null
    open var EmailWork:String? = null
    open var EmailPersonal:String? = null
    open var District:String? = null
    open var DistrictID:Int? = null
    open var School:String? = null
    open var SchoolID:Long? = null
    open var State:String? = null
    open var StateName:String? = null
    open var StateID:Long? = null
    open var CountyID:Long? = null
    open var County:String? = null
    open var Phone:String? = null
    open var Department:String? = null
    open var Flow:String? = null
    open var LastContact:Date? = null
    open var DoNotContact:Boolean? = null
    open var Active:Boolean? = null
    open var AgentId:Int? = null
    open var PhoneAlt:String? = null
    open var PeraContactId:Int? = null
    open var RoomNumber:String? = null
    open var SourceTypeId:Int? = null
    open var SourceTypeDesc:String? = null
    open var SourceNote:String? = null
    open var ContactStatusId:Int? = null
    open var ContactStatusDesc:String? = null
    open var SSN:String? = null
    open var DateOfBirth:Date? = null
    open var Deleted:Boolean? = null
    open var IsShared:Boolean? = null
    open var address_line1:String? = null
    open var address_city:String? = null
    open var address_state:String? = null
    open var address_zip:String? = null
    open var DeletedBy:String? = null
    open var DeletedDateTimeUtc:Date? = null
    open var HasNBC:Boolean? = null
    open var HasFactFinderSheet:Boolean? = null
    open var MiddleInitial:String? = null
    open var Tags:String? = null
    open var DateCreated:Date? = null
    open var PhoneLabel:String? = null
    open var AltPhoneLabel:String? = null
    open var Carriers:String? = null
    open var ContactImage:String? = null
    open var CompanyAffiliation:String? = null
    open var AdditionalInformation:String? = null
    open var HasGiftCard:Boolean? = null
    open var ContactCategory:Int? = null
    open var WritingAgentId:Int? = null
    open var WritingAgentName:String? = null
    open var MaritalStatus:String? = null
    open var TotalDebtAmount:BigDecimal? = null
    open var NumberOfDebtAccounts:Int? = null
    open var FactFinderCodeId:Int? = null
    open var BusinessName:String? = null
    open var DBA:String? = null
    open var ContactGUID:UUID? = null
    open var ProjectEndDate:Date? = null
    open var Rate:Int? = null
    open var JobID:Int? = null
    open var JobName:String? = null
    open var JobCount:Int? = null
    open var Locked:Boolean? = null
    open var LockedByAgentId:Int? = null
    open var LockedTimestamp:Date? = null
    open var Initials:String? = null
    open var ContactCategoryName:String? = null
    open var SMSOptIn:Boolean? = null
}

open class FactFinderSheet
{
    open var FactFinderSheetId:Int? = null
    open var ContactId:Int? = null
    open var EmploymentYears:String? = null
    open var PastOccupations:String? = null
    open var ClientGrossMthlyIncome:BigDecimal? = null
    open var ClientNetMthlyIncome:BigDecimal? = null
    open var HouseholdGrossMthlyIncome:BigDecimal? = null
    open var HouseholdNetMthlyIncome:BigDecimal? = null
    open var EstimatedExpenses:BigDecimal? = null
    open var DiscretionaryIncome:BigDecimal? = null
    open var DesiredRetirementIncome:BigDecimal? = null
    open var RetirementGoals:String? = null
    open var EmergencyFundMthlyContrib:BigDecimal? = null
    open var EmergencyFundBalance:BigDecimal? = null
    open var EmergencyFundComplete:Boolean? = null
    open var WorkStatus:String? = null
    open var UnusedSickDays:BigDecimal? = null
    open var UnusedSickHours:BigDecimal? = null
    open var ContractBaseServPerYrDays:BigDecimal? = null
    open var ContractBaseServPerYrHours:BigDecimal? = null
    open var DaysPerWeek:BigDecimal? = null
    open var HoursPerWeek:BigDecimal? = null
    open var MonthsPerYear:BigDecimal? = null
    open var NumPreTaxChecksPerYr:Int? = null
    open var YearsWithOtherDistricts:BigDecimal? = null
    open var PrimaryLifeInsurance:Boolean? = null
    open var PLICarrier:String? = null
    open var PLIFaceAmount:BigDecimal? = null
    open var PLIIssueDate:Date? = null
    open var PLIPremium:BigDecimal? = null
    open var PLIType:String? = null
    open var PLITypeOf:String? = null
    open var PLICashValue:BigDecimal? = null
    open var SpouseLifeInsurance:Boolean? = null
    open var SLICarrier:String? = null
    open var SLIFaceAmount:BigDecimal? = null
    open var SLIIssueDate:Date? = null
    open var SLIPremium:BigDecimal? = null
    open var SLIType:String? = null
    open var SLITypeOf:String? = null
    open var SLICashValue:BigDecimal? = null
    open var PrimaryLTCInsurance:Boolean? = null
    open var PLTCPremium:BigDecimal? = null
    open var PrimaryDisabilityInsurance:Boolean? = null
    open var PDIPremium:BigDecimal? = null
    open var SpouseLTCInsurance:Boolean? = null
    open var SLTCPremium:BigDecimal? = null
    open var SpouseDisabilityInsurance:Boolean? = null
    open var SDIPremium:BigDecimal? = null
    open var HasRetirementSavings:Boolean? = null
    open var HasPriorEmploymentRetirementSavings:Boolean? = null
    open var HasDistributionPlan:Boolean? = null
}

open class ContactSpouse
{
    open var ContactSpouseId:Int? = null
    open var ContactId:Int? = null
    open var Name:String? = null
    open var DOB:Date? = null
    open var Cell:String? = null
    open var Employer:String? = null
    open var Years:BigDecimal? = null
    open var Position:String? = null
    open var Email:String? = null
    open var PastOccupations:String? = null
}

open class ContactChild
{
    open var ContactChildId:Int? = null
    open var ContactId:Int? = null
    open var Name:String? = null
    open var DOB:Date? = null
    open var Fund:String? = null
    open var Contribution:BigDecimal? = null
    open var Balance:BigDecimal? = null
}

open class ContactRetirementIncome
{
    open var ContactRetirementIncomeId:Int? = null
    open var ContactId:Int? = null
    open var AccountOwner:String? = null
    open var AccountType:String? = null
    open var Carrier:String? = null
    open var TotalValue:BigDecimal? = null
    open var SurrValue:BigDecimal? = null
    open var DateOfIssue:Date? = null
    open var Fees:BigDecimal? = null
    open var PolicyNum:String? = null
    open var Contrib:BigDecimal? = null
    open var EmpNotes:String? = null
    open var TaxCode:String? = null
    open var SurrCharge:BigDecimal? = null
    open var ThirdPrtyPprwrkOK:Boolean? = null
    open var AddlFormsReqd:Boolean? = null
    open var OriginalFormsReqd:Boolean? = null
    open var SignatureGuarReqd:Boolean? = null
    open var FaxAccepted:Boolean? = null
    open var FaxNumber:String? = null
    open var MailingAddr:String? = null
    open var MailingCity:String? = null
    open var MailingState:String? = null
    open var MailingZip:String? = null
    open var HasOutstandingLoans:Boolean? = null
}

open class ContactExpense
{
    open var ContactExpenseId:Int? = null
    open var ContactId:Int? = null
    open var ExpenseType:String? = null
    open var Description:String? = null
    open var Balance:BigDecimal? = null
    open var InterestRate:BigDecimal? = null
    open var MinimumPayment:BigDecimal? = null
    open var MonthlyPayment:BigDecimal? = null
}

open class ContactClientReferral
{
    open var ContactClientReferralId:Int? = null
    open var ContactId:Int? = null
    open var Name:String? = null
    open var Campus:String? = null
    open var Room:String? = null
    open var Phone:String? = null
}

open class ContactLTAInfo
{
    open var ContactLTAInfoId:Int? = null
    open var ContactId:Int? = null
    open var PlanType:String? = null
    open var Company:String? = null
    open var Contribution:BigDecimal? = null
    open var Balance:BigDecimal? = null
}

open class ContactPension
{
    open var ContactPensionId:Int? = null
    open var ContactId:Int? = null
    open var PensionSystem:String? = null
    open var PensionStartDate:Date? = null
    open var ServiceCredit:BigDecimal? = null
    open var ServiceCreditAsOfDate:Date? = null
    open var DesiredRetirementDate:Date? = null
    open var DesiredRetirementAge:Int? = null
    open var SpousalBenefitDesired:Boolean? = null
    open var FormulaPercent:BigDecimal? = null
    open var FormulaAt:BigDecimal? = null
    open var DefinedBenefitBalance:BigDecimal? = null
    open var DefinedBenefitSpouseBalance:BigDecimal? = null
}

Kotlin FactFinderRequest DTOs

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>