| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinder |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Contact:
contact_id: int = 0
contact_type: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
name: Optional[str] = None
role: Optional[str] = None
title: Optional[str] = None
email_work: Optional[str] = None
email_personal: Optional[str] = None
district: Optional[str] = None
district_i_d: int = 0
school: Optional[str] = None
school_i_d: int = 0
state: Optional[str] = None
state_name: Optional[str] = None
state_i_d: int = 0
county_i_d: int = 0
county: Optional[str] = None
phone: Optional[str] = None
department: Optional[str] = None
flow: Optional[str] = None
last_contact: datetime.datetime = datetime.datetime(1, 1, 1)
do_not_contact: bool = False
active: bool = False
agent_id: int = 0
phone_alt: Optional[str] = None
pera_contact_id: int = 0
room_number: Optional[str] = None
source_type_id: int = 0
source_type_desc: Optional[str] = None
source_note: Optional[str] = None
contact_status_id: int = 0
contact_status_desc: Optional[str] = None
ssn: Optional[str] = None
date_of_birth: datetime.datetime = datetime.datetime(1, 1, 1)
deleted: bool = False
is_shared: bool = False
address_line1: Optional[str] = None
address_city: Optional[str] = None
address_state: Optional[str] = None
address_zip: Optional[str] = None
deleted_by: Optional[str] = None
deleted_date_time_utc: Optional[datetime.datetime] = None
has_n_b_c: bool = False
has_fact_finder_sheet: bool = False
middle_initial: Optional[str] = None
tags: Optional[str] = None
date_created: datetime.datetime = datetime.datetime(1, 1, 1)
phone_label: Optional[str] = None
alt_phone_label: Optional[str] = None
carriers: Optional[str] = None
contact_image: Optional[str] = None
company_affiliation: Optional[str] = None
additional_information: Optional[str] = None
has_gift_card: bool = False
contact_category: int = 0
writing_agent_id: int = 0
writing_agent_name: Optional[str] = None
marital_status: Optional[str] = None
total_debt_amount: Decimal = decimal.Decimal(0)
number_of_debt_accounts: int = 0
fact_finder_code_id: int = 0
business_name: Optional[str] = None
dba: Optional[str] = None
contact_g_u_i_d: Optional[str] = None
project_end_date: datetime.datetime = datetime.datetime(1, 1, 1)
rate: int = 0
job_i_d: int = 0
job_name: Optional[str] = None
job_count: int = 0
locked: bool = False
locked_by_agent_id: int = 0
locked_timestamp: datetime.datetime = datetime.datetime(1, 1, 1)
initials: Optional[str] = None
contact_category_name: Optional[str] = None
sms_opt_in: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FactFinderSheet:
fact_finder_sheet_id: int = 0
contact_id: int = 0
employment_years: Optional[str] = None
past_occupations: Optional[str] = None
client_gross_mthly_income: Optional[Decimal] = None
client_net_mthly_income: Optional[Decimal] = None
household_gross_mthly_income: Optional[Decimal] = None
household_net_mthly_income: Optional[Decimal] = None
estimated_expenses: Optional[Decimal] = None
discretionary_income: Optional[Decimal] = None
desired_retirement_income: Optional[Decimal] = None
retirement_goals: Optional[str] = None
emergency_fund_mthly_contrib: Optional[Decimal] = None
emergency_fund_balance: Optional[Decimal] = None
emergency_fund_complete: Optional[bool] = None
work_status: Optional[str] = None
unused_sick_days: Optional[Decimal] = None
unused_sick_hours: Optional[Decimal] = None
contract_base_serv_per_yr_days: Optional[Decimal] = None
contract_base_serv_per_yr_hours: Optional[Decimal] = None
days_per_week: Optional[Decimal] = None
hours_per_week: Optional[Decimal] = None
months_per_year: Optional[Decimal] = None
num_pre_tax_checks_per_yr: Optional[int] = None
years_with_other_districts: Optional[Decimal] = None
primary_life_insurance: Optional[bool] = None
pli_carrier: Optional[str] = None
pli_face_amount: Optional[Decimal] = None
pli_issue_date: Optional[datetime.datetime] = None
pli_premium: Optional[Decimal] = None
pli_type: Optional[str] = None
pli_type_of: Optional[str] = None
pli_cash_value: Optional[Decimal] = None
spouse_life_insurance: Optional[bool] = None
sli_carrier: Optional[str] = None
sli_face_amount: Optional[Decimal] = None
sli_issue_date: Optional[datetime.datetime] = None
sli_premium: Optional[Decimal] = None
sli_type: Optional[str] = None
sli_type_of: Optional[str] = None
sli_cash_value: Optional[Decimal] = None
primary_l_t_c_insurance: Optional[bool] = None
pltc_premium: Optional[Decimal] = None
primary_disability_insurance: Optional[bool] = None
pdi_premium: Optional[Decimal] = None
spouse_l_t_c_insurance: Optional[bool] = None
sltc_premium: Optional[Decimal] = None
spouse_disability_insurance: Optional[bool] = None
sdi_premium: Optional[Decimal] = None
has_retirement_savings: Optional[bool] = None
has_prior_employment_retirement_savings: Optional[bool] = None
has_distribution_plan: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactSpouse:
contact_spouse_id: int = 0
contact_id: int = 0
name: Optional[str] = None
dob: Optional[datetime.datetime] = None
cell: Optional[str] = None
employer: Optional[str] = None
years: Optional[Decimal] = None
position: Optional[str] = None
email: Optional[str] = None
past_occupations: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactChild:
contact_child_id: int = 0
contact_id: int = 0
name: Optional[str] = None
dob: Optional[datetime.datetime] = None
fund: Optional[str] = None
contribution: Optional[Decimal] = None
balance: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactRetirementIncome:
contact_retirement_income_id: int = 0
contact_id: int = 0
account_owner: Optional[str] = None
account_type: Optional[str] = None
carrier: Optional[str] = None
total_value: Optional[Decimal] = None
surr_value: Optional[Decimal] = None
date_of_issue: Optional[datetime.datetime] = None
fees: Optional[Decimal] = None
policy_num: Optional[str] = None
contrib: Optional[Decimal] = None
emp_notes: Optional[str] = None
tax_code: Optional[str] = None
surr_charge: Optional[Decimal] = None
third_prty_pprwrk_o_k: Optional[bool] = None
addl_forms_reqd: Optional[bool] = None
original_forms_reqd: Optional[bool] = None
signature_guar_reqd: Optional[bool] = None
fax_accepted: Optional[bool] = None
fax_number: Optional[str] = None
mailing_addr: Optional[str] = None
mailing_city: Optional[str] = None
mailing_state: Optional[str] = None
mailing_zip: Optional[str] = None
has_outstanding_loans: Optional[bool] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactExpense:
contact_expense_id: int = 0
contact_id: int = 0
expense_type: Optional[str] = None
description: Optional[str] = None
balance: Optional[Decimal] = None
interest_rate: Optional[Decimal] = None
minimum_payment: Optional[Decimal] = None
monthly_payment: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactClientReferral:
contact_client_referral_id: int = 0
contact_id: int = 0
name: Optional[str] = None
campus: Optional[str] = None
room: Optional[str] = None
phone: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactLTAInfo:
contact_l_t_a_info_id: int = 0
contact_id: int = 0
plan_type: Optional[str] = None
company: Optional[str] = None
contribution: Optional[Decimal] = None
balance: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ContactPension:
contact_pension_id: int = 0
contact_id: int = 0
pension_system: Optional[str] = None
pension_start_date: Optional[datetime.datetime] = None
service_credit: Optional[Decimal] = None
service_credit_as_of_date: Optional[datetime.datetime] = None
desired_retirement_date: Optional[datetime.datetime] = None
desired_retirement_age: int = 0
spousal_benefit_desired: Optional[bool] = None
formula_percent: Optional[Decimal] = None
formula_at: Optional[Decimal] = None
defined_benefit_balance: Optional[Decimal] = None
defined_benefit_spouse_balance: Optional[Decimal] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FactFinderSheetExtended:
contact: Optional[Contact] = None
fact_finder_sheet: Optional[FactFinderSheet] = None
spouse: Optional[ContactSpouse] = None
children: List[ContactChild] = field(default_factory=list)
income_sources: List[ContactRetirementIncome] = field(default_factory=list)
additional_notes: Optional[str] = None
expenses: List[ContactExpense] = field(default_factory=list)
referrals: List[ContactClientReferral] = field(default_factory=list)
lta_info: List[ContactLTAInfo] = field(default_factory=list)
pensions: List[ContactPension] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class FactFinderRequest:
fact_finder_sheet: Optional[FactFinderSheetExtended] = None
data_entry: bool = False
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>