| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| POST,PUT,OPTIONS | /v1/FactFinderDebt | ||
|---|---|---|---|
| GET | /v1/FactFinderDebt/{ContactId}/Validate |
"use strict";
export class Contact {
/** @param {{ContactId?:number,ContactType?:number,FirstName?:string,LastName?:string,Name?:string,Role?:string,Title?:string,EmailWork?:string,EmailPersonal?:string,District?:string,DistrictID?:number,School?:string,SchoolID?:number,State?:string,StateName?:string,StateID?:number,CountyID?:number,County?:string,Phone?:string,Department?:string,Flow?:string,LastContact?:string,DoNotContact?:boolean,Active?:boolean,AgentId?:number,PhoneAlt?:string,PeraContactId?:number,RoomNumber?:string,SourceTypeId?:number,SourceTypeDesc?:string,SourceNote?:string,ContactStatusId?:number,ContactStatusDesc?:string,SSN?:string,DateOfBirth?:string,Deleted?:boolean,IsShared?:boolean,address_line1?:string,address_city?:string,address_state?:string,address_zip?:string,DeletedBy?:string,DeletedDateTimeUtc?:string,HasNBC?:boolean,HasFactFinderSheet?:boolean,MiddleInitial?:string,Tags?:string,DateCreated?:string,PhoneLabel?:string,AltPhoneLabel?:string,Carriers?:string,ContactImage?:string,CompanyAffiliation?:string,AdditionalInformation?:string,HasGiftCard?:boolean,ContactCategory?:number,WritingAgentId?:number,WritingAgentName?:string,MaritalStatus?:string,TotalDebtAmount?:number,NumberOfDebtAccounts?:number,FactFinderCodeId?:number,BusinessName?:string,DBA?:string,ContactGUID?:string,ProjectEndDate?:string,Rate?:number,JobID?:number,JobName?:string,JobCount?:number,Locked?:boolean,LockedByAgentId?:number,LockedTimestamp?:string,Initials?:string,ContactCategoryName?:string,SMSOptIn?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactId;
/** @type {number} */
ContactType;
/** @type {string} */
FirstName;
/** @type {string} */
LastName;
/** @type {string} */
Name;
/** @type {string} */
Role;
/** @type {string} */
Title;
/** @type {string} */
EmailWork;
/** @type {string} */
EmailPersonal;
/** @type {string} */
District;
/** @type {number} */
DistrictID;
/** @type {string} */
School;
/** @type {number} */
SchoolID;
/** @type {string} */
State;
/** @type {string} */
StateName;
/** @type {number} */
StateID;
/** @type {number} */
CountyID;
/** @type {string} */
County;
/** @type {string} */
Phone;
/** @type {string} */
Department;
/** @type {string} */
Flow;
/** @type {string} */
LastContact;
/** @type {boolean} */
DoNotContact;
/** @type {boolean} */
Active;
/** @type {number} */
AgentId;
/** @type {string} */
PhoneAlt;
/** @type {number} */
PeraContactId;
/** @type {string} */
RoomNumber;
/** @type {number} */
SourceTypeId;
/** @type {string} */
SourceTypeDesc;
/** @type {string} */
SourceNote;
/** @type {number} */
ContactStatusId;
/** @type {string} */
ContactStatusDesc;
/** @type {string} */
SSN;
/** @type {string} */
DateOfBirth;
/** @type {boolean} */
Deleted;
/** @type {boolean} */
IsShared;
/** @type {string} */
address_line1;
/** @type {string} */
address_city;
/** @type {string} */
address_state;
/** @type {string} */
address_zip;
/** @type {string} */
DeletedBy;
/** @type {?string} */
DeletedDateTimeUtc;
/** @type {boolean} */
HasNBC;
/** @type {boolean} */
HasFactFinderSheet;
/** @type {string} */
MiddleInitial;
/** @type {string} */
Tags;
/** @type {string} */
DateCreated;
/** @type {string} */
PhoneLabel;
/** @type {string} */
AltPhoneLabel;
/** @type {string} */
Carriers;
/** @type {string} */
ContactImage;
/** @type {string} */
CompanyAffiliation;
/** @type {string} */
AdditionalInformation;
/** @type {boolean} */
HasGiftCard;
/** @type {number} */
ContactCategory;
/** @type {number} */
WritingAgentId;
/** @type {string} */
WritingAgentName;
/** @type {string} */
MaritalStatus;
/** @type {number} */
TotalDebtAmount;
/** @type {number} */
NumberOfDebtAccounts;
/** @type {number} */
FactFinderCodeId;
/** @type {string} */
BusinessName;
/** @type {string} */
DBA;
/** @type {string} */
ContactGUID;
/** @type {string} */
ProjectEndDate;
/** @type {number} */
Rate;
/** @type {number} */
JobID;
/** @type {string} */
JobName;
/** @type {number} */
JobCount;
/** @type {boolean} */
Locked;
/** @type {number} */
LockedByAgentId;
/** @type {string} */
LockedTimestamp;
/** @type {string} */
Initials;
/** @type {string} */
ContactCategoryName;
/** @type {boolean} */
SMSOptIn;
}
export class FactFinderDebt {
/** @param {{FactFinderDebtId?:number,ContactId?:number,OwnHome?:boolean,HomeValue?:number,OtherProperty?:boolean,OtherPropertyValue?:number,FirstCar?:boolean,FirstCarValue?:number,SecondCar?:boolean,SecondCarValue?:number,BoatRv?:boolean,BoatRvValue?:number,Stocks401kOther?:boolean,Stocks401kOtherValue?:number,HomeRentInsurance?:boolean,HomeRentInsuranceValue?:number,ChildAlimonySupport?:boolean,ChildAlimonySupportValue?:number,ChildcareRelated?:boolean,ChildcareRelatedValue?:number,LifeInsurance?:boolean,LifePolicyAmount?:number,LifeInsuranceMonthly?:number,MortgageRentExpense?:number,PropertyTaxExpense?:number,CarPaymentFirstExpense?:number,CarPaymentSecondExpense?:number,RVPaymentExpense?:number,SavingsPaymentExpense?:number,HomeInsuranceExpense?:number,GroceriesExpense?:number,EntertainmentExpense?:number,LifeInsuranceCostExpense?:number,GasElectricityExpense?:number,WaterTrashSewerExpense?:number,TelephoneCellExpense?:number,CableInternetExpense?:number,AutoExpenseGasExpense?:number,AutoInsuranceExpense?:number,MedicalExpense?:number,MiscellaneousExpense?:number,FamilyFriendLoansExpense?:number,WhatBank?:string,BankDebt?:boolean,CreditUnion?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
FactFinderDebtId;
/** @type {number} */
ContactId;
/** @type {?boolean} */
OwnHome;
/** @type {?number} */
HomeValue;
/** @type {?boolean} */
OtherProperty;
/** @type {?number} */
OtherPropertyValue;
/** @type {?boolean} */
FirstCar;
/** @type {?number} */
FirstCarValue;
/** @type {?boolean} */
SecondCar;
/** @type {?number} */
SecondCarValue;
/** @type {?boolean} */
BoatRv;
/** @type {?number} */
BoatRvValue;
/** @type {?boolean} */
Stocks401kOther;
/** @type {?number} */
Stocks401kOtherValue;
/** @type {?boolean} */
HomeRentInsurance;
/** @type {?number} */
HomeRentInsuranceValue;
/** @type {?boolean} */
ChildAlimonySupport;
/** @type {?number} */
ChildAlimonySupportValue;
/** @type {?boolean} */
ChildcareRelated;
/** @type {?number} */
ChildcareRelatedValue;
/** @type {?boolean} */
LifeInsurance;
/** @type {?number} */
LifePolicyAmount;
/** @type {?number} */
LifeInsuranceMonthly;
/** @type {?number} */
MortgageRentExpense;
/** @type {?number} */
PropertyTaxExpense;
/** @type {?number} */
CarPaymentFirstExpense;
/** @type {?number} */
CarPaymentSecondExpense;
/** @type {?number} */
RVPaymentExpense;
/** @type {?number} */
SavingsPaymentExpense;
/** @type {?number} */
HomeInsuranceExpense;
/** @type {?number} */
GroceriesExpense;
/** @type {?number} */
EntertainmentExpense;
/** @type {?number} */
LifeInsuranceCostExpense;
/** @type {?number} */
GasElectricityExpense;
/** @type {?number} */
WaterTrashSewerExpense;
/** @type {?number} */
TelephoneCellExpense;
/** @type {?number} */
CableInternetExpense;
/** @type {?number} */
AutoExpenseGasExpense;
/** @type {?number} */
AutoInsuranceExpense;
/** @type {?number} */
MedicalExpense;
/** @type {?number} */
MiscellaneousExpense;
/** @type {?number} */
FamilyFriendLoansExpense;
/** @type {string} */
WhatBank;
/** @type {?boolean} */
BankDebt;
/** @type {?boolean} */
CreditUnion;
}
export class ContactSpouse {
/** @param {{ContactSpouseId?:number,ContactId?:number,Name?:string,DOB?:string,Cell?:string,Employer?:string,Years?:number,Position?:string,Email?:string,PastOccupations?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactSpouseId;
/** @type {number} */
ContactId;
/** @type {string} */
Name;
/** @type {?string} */
DOB;
/** @type {string} */
Cell;
/** @type {string} */
Employer;
/** @type {?number} */
Years;
/** @type {string} */
Position;
/** @type {string} */
Email;
/** @type {string} */
PastOccupations;
}
export class ContactCreditor {
/** @param {{ContactCreditorId?:number,ContactId?:number,CreditorName?:string,NameOnAccount?:string,AccountNumber?:string,CurrentBalance?:number,MinimumPayment?:number,HasCoSigner?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
ContactCreditorId;
/** @type {number} */
ContactId;
/** @type {string} */
CreditorName;
/** @type {string} */
NameOnAccount;
/** @type {string} */
AccountNumber;
/** @type {?number} */
CurrentBalance;
/** @type {?number} */
MinimumPayment;
/** @type {boolean} */
HasCoSigner;
}
export class FactFinderDebtExtended {
/** @param {{Contact?:Contact,FactFinderDebt?:FactFinderDebt,Spouse?:ContactSpouse,Creditors?:ContactCreditor[],AdditionalNotes?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {Contact} */
Contact;
/** @type {FactFinderDebt} */
FactFinderDebt;
/** @type {ContactSpouse} */
Spouse;
/** @type {ContactCreditor[]} */
Creditors = [];
/** @type {string} */
AdditionalNotes;
}
export class FactFinderDebtRequest {
/** @param {{FactFinderDebt?:FactFinderDebtExtended,DataEntry?:boolean,ContactId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {FactFinderDebtExtended} */
FactFinderDebt;
/** @type {boolean} */
DataEntry;
/** @type {number} */
ContactId;
}
JavaScript FactFinderDebtRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/FactFinderDebt HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FactFinderDebt":{"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-01T00:00:00.0000000","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-01T00:00:00.0000000","Deleted":false,"IsShared":false,"address_line1":"String","address_city":"String","address_state":"String","address_zip":"String","DeletedBy":"String","DeletedDateTimeUtc":"0001-01-01T00:00:00.0000000","HasNBC":false,"HasFactFinderSheet":false,"MiddleInitial":"String","Tags":"String","DateCreated":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","Rate":0,"JobID":0,"JobName":"String","JobCount":0,"Locked":false,"LockedByAgentId":0,"LockedTimestamp":"0001-01-01T00:00:00.0000000","Initials":"String","ContactCategoryName":"String","SMSOptIn":false},"FactFinderDebt":{"FactFinderDebtId":0,"ContactId":0,"OwnHome":false,"HomeValue":0,"OtherProperty":false,"OtherPropertyValue":0,"FirstCar":false,"FirstCarValue":0,"SecondCar":false,"SecondCarValue":0,"BoatRv":false,"BoatRvValue":0,"Stocks401kOther":false,"Stocks401kOtherValue":0,"HomeRentInsurance":false,"HomeRentInsuranceValue":0,"ChildAlimonySupport":false,"ChildAlimonySupportValue":0,"ChildcareRelated":false,"ChildcareRelatedValue":0,"LifeInsurance":false,"LifePolicyAmount":0,"LifeInsuranceMonthly":0,"MortgageRentExpense":0,"PropertyTaxExpense":0,"CarPaymentFirstExpense":0,"CarPaymentSecondExpense":0,"RVPaymentExpense":0,"SavingsPaymentExpense":0,"HomeInsuranceExpense":0,"GroceriesExpense":0,"EntertainmentExpense":0,"LifeInsuranceCostExpense":0,"GasElectricityExpense":0,"WaterTrashSewerExpense":0,"TelephoneCellExpense":0,"CableInternetExpense":0,"AutoExpenseGasExpense":0,"AutoInsuranceExpense":0,"MedicalExpense":0,"MiscellaneousExpense":0,"FamilyFriendLoansExpense":0,"WhatBank":"String","BankDebt":false,"CreditUnion":false},"Spouse":{"ContactSpouseId":0,"ContactId":0,"Name":"String","DOB":"0001-01-01T00:00:00.0000000","Cell":"String","Employer":"String","Years":0,"Position":"String","Email":"String","PastOccupations":"String"},"Creditors":[{"ContactCreditorId":0,"ContactId":0,"CreditorName":"String","NameOnAccount":"String","AccountNumber":"String","CurrentBalance":0,"MinimumPayment":0,"HasCoSigner":false}],"AdditionalNotes":"String"},"DataEntry":false,"ContactId":0}