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 .jsv suffix or ?format=jsv

HTTP + 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
}