| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinder |
|---|
export class Contact
{
public ContactId: number;
public ContactType: number;
public FirstName: string;
public LastName: string;
public Name: string;
public Role: string;
public Title: string;
public EmailWork: string;
public EmailPersonal: string;
public District: string;
public DistrictID: number;
public School: string;
public SchoolID: number;
public State: string;
public StateName: string;
public StateID: number;
public CountyID: number;
public County: string;
public Phone: string;
public Department: string;
public Flow: string;
public LastContact: string;
public DoNotContact: boolean;
public Active: boolean;
public AgentId: number;
public PhoneAlt: string;
public PeraContactId: number;
public RoomNumber: string;
public SourceTypeId: number;
public SourceTypeDesc: string;
public SourceNote: string;
public ContactStatusId: number;
public ContactStatusDesc: string;
public SSN: string;
public DateOfBirth: string;
public Deleted: boolean;
public IsShared: boolean;
public address_line1: string;
public address_city: string;
public address_state: string;
public address_zip: string;
public DeletedBy: string;
public DeletedDateTimeUtc?: string;
public HasNBC: boolean;
public HasFactFinderSheet: boolean;
public MiddleInitial: string;
public Tags: string;
public DateCreated: string;
public PhoneLabel: string;
public AltPhoneLabel: string;
public Carriers: string;
public ContactImage: string;
public CompanyAffiliation: string;
public AdditionalInformation: string;
public HasGiftCard: boolean;
public ContactCategory: number;
public WritingAgentId: number;
public WritingAgentName: string;
public MaritalStatus: string;
public TotalDebtAmount: number;
public NumberOfDebtAccounts: number;
public FactFinderCodeId: number;
public BusinessName: string;
public DBA: string;
public ContactGUID: string;
public ProjectEndDate: string;
public Rate: number;
public JobID: number;
public JobName: string;
public JobCount: number;
public Locked: boolean;
public LockedByAgentId: number;
public LockedTimestamp: string;
public Initials: string;
public ContactCategoryName: string;
public SMSOptIn: boolean;
public constructor(init?: Partial<Contact>) { (Object as any).assign(this, init); }
}
export class FactFinderSheet
{
public FactFinderSheetId: number;
public ContactId: number;
public EmploymentYears: string;
public PastOccupations: string;
public ClientGrossMthlyIncome?: number;
public ClientNetMthlyIncome?: number;
public HouseholdGrossMthlyIncome?: number;
public HouseholdNetMthlyIncome?: number;
public EstimatedExpenses?: number;
public DiscretionaryIncome?: number;
public DesiredRetirementIncome?: number;
public RetirementGoals: string;
public EmergencyFundMthlyContrib?: number;
public EmergencyFundBalance?: number;
public EmergencyFundComplete?: boolean;
public WorkStatus: string;
public UnusedSickDays?: number;
public UnusedSickHours?: number;
public ContractBaseServPerYrDays?: number;
public ContractBaseServPerYrHours?: number;
public DaysPerWeek?: number;
public HoursPerWeek?: number;
public MonthsPerYear?: number;
public NumPreTaxChecksPerYr?: number;
public YearsWithOtherDistricts?: number;
public PrimaryLifeInsurance?: boolean;
public PLICarrier: string;
public PLIFaceAmount?: number;
public PLIIssueDate?: string;
public PLIPremium?: number;
public PLIType: string;
public PLITypeOf: string;
public PLICashValue?: number;
public SpouseLifeInsurance?: boolean;
public SLICarrier: string;
public SLIFaceAmount?: number;
public SLIIssueDate?: string;
public SLIPremium?: number;
public SLIType: string;
public SLITypeOf: string;
public SLICashValue?: number;
public PrimaryLTCInsurance?: boolean;
public PLTCPremium?: number;
public PrimaryDisabilityInsurance?: boolean;
public PDIPremium?: number;
public SpouseLTCInsurance?: boolean;
public SLTCPremium?: number;
public SpouseDisabilityInsurance?: boolean;
public SDIPremium?: number;
public HasRetirementSavings?: boolean;
public HasPriorEmploymentRetirementSavings?: boolean;
public HasDistributionPlan?: boolean;
public constructor(init?: Partial<FactFinderSheet>) { (Object as any).assign(this, init); }
}
export class ContactSpouse
{
public ContactSpouseId: number;
public ContactId: number;
public Name: string;
public DOB?: string;
public Cell: string;
public Employer: string;
public Years?: number;
public Position: string;
public Email: string;
public PastOccupations: string;
public constructor(init?: Partial<ContactSpouse>) { (Object as any).assign(this, init); }
}
export class ContactChild
{
public ContactChildId: number;
public ContactId: number;
public Name: string;
public DOB?: string;
public Fund: string;
public Contribution?: number;
public Balance?: number;
public constructor(init?: Partial<ContactChild>) { (Object as any).assign(this, init); }
}
export class ContactRetirementIncome
{
public ContactRetirementIncomeId: number;
public ContactId: number;
public AccountOwner: string;
public AccountType: string;
public Carrier: string;
public TotalValue?: number;
public SurrValue?: number;
public DateOfIssue?: string;
public Fees?: number;
public PolicyNum: string;
public Contrib?: number;
public EmpNotes: string;
public TaxCode: string;
public SurrCharge?: number;
public ThirdPrtyPprwrkOK?: boolean;
public AddlFormsReqd?: boolean;
public OriginalFormsReqd?: boolean;
public SignatureGuarReqd?: boolean;
public FaxAccepted?: boolean;
public FaxNumber: string;
public MailingAddr: string;
public MailingCity: string;
public MailingState: string;
public MailingZip: string;
public HasOutstandingLoans?: boolean;
public constructor(init?: Partial<ContactRetirementIncome>) { (Object as any).assign(this, init); }
}
export class ContactExpense
{
public ContactExpenseId: number;
public ContactId: number;
public ExpenseType: string;
public Description: string;
public Balance?: number;
public InterestRate?: number;
public MinimumPayment?: number;
public MonthlyPayment?: number;
public constructor(init?: Partial<ContactExpense>) { (Object as any).assign(this, init); }
}
export class ContactClientReferral
{
public ContactClientReferralId: number;
public ContactId: number;
public Name: string;
public Campus: string;
public Room: string;
public Phone: string;
public constructor(init?: Partial<ContactClientReferral>) { (Object as any).assign(this, init); }
}
export class ContactLTAInfo
{
public ContactLTAInfoId: number;
public ContactId: number;
public PlanType: string;
public Company: string;
public Contribution?: number;
public Balance?: number;
public constructor(init?: Partial<ContactLTAInfo>) { (Object as any).assign(this, init); }
}
export class ContactPension
{
public ContactPensionId: number;
public ContactId: number;
public PensionSystem: string;
public PensionStartDate?: string;
public ServiceCredit?: number;
public ServiceCreditAsOfDate?: string;
public DesiredRetirementDate?: string;
public DesiredRetirementAge: number;
public SpousalBenefitDesired?: boolean;
public FormulaPercent?: number;
public FormulaAt?: number;
public DefinedBenefitBalance?: number;
public DefinedBenefitSpouseBalance?: number;
public constructor(init?: Partial<ContactPension>) { (Object as any).assign(this, init); }
}
export class FactFinderSheetExtended
{
public Contact: Contact;
public FactFinderSheet: FactFinderSheet;
public Spouse: ContactSpouse;
public Children: ContactChild[] = [];
public IncomeSources: ContactRetirementIncome[] = [];
public AdditionalNotes: string;
public Expenses: ContactExpense[] = [];
public Referrals: ContactClientReferral[] = [];
public LTAInfo: ContactLTAInfo[] = [];
public Pensions: ContactPension[] = [];
public constructor(init?: Partial<FactFinderSheetExtended>) { (Object as any).assign(this, init); }
}
export class FactFinderRequest
{
public FactFinderSheet: FactFinderSheetExtended;
public DataEntry: boolean;
public constructor(init?: Partial<FactFinderRequest>) { (Object as any).assign(this, init); }
}
TypeScript FactFinderRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>