| 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 .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/FactFinderDebt HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FactFinderDebtRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactId>0</ContactId>
<DataEntry>false</DataEntry>
<FactFinderDebt>
<AdditionalNotes>String</AdditionalNotes>
<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>
<Creditors>
<ContactCreditor>
<AccountNumber>String</AccountNumber>
<ContactCreditorId>0</ContactCreditorId>
<ContactId>0</ContactId>
<CreditorName>String</CreditorName>
<CurrentBalance>0</CurrentBalance>
<HasCoSigner>false</HasCoSigner>
<MinimumPayment>0</MinimumPayment>
<NameOnAccount>String</NameOnAccount>
</ContactCreditor>
</Creditors>
<FactFinderDebt>
<AutoExpenseGasExpense>0</AutoExpenseGasExpense>
<AutoInsuranceExpense>0</AutoInsuranceExpense>
<BankDebt>false</BankDebt>
<BoatRv>false</BoatRv>
<BoatRvValue>0</BoatRvValue>
<CableInternetExpense>0</CableInternetExpense>
<CarPaymentFirstExpense>0</CarPaymentFirstExpense>
<CarPaymentSecondExpense>0</CarPaymentSecondExpense>
<ChildAlimonySupport>false</ChildAlimonySupport>
<ChildAlimonySupportValue>0</ChildAlimonySupportValue>
<ChildcareRelated>false</ChildcareRelated>
<ChildcareRelatedValue>0</ChildcareRelatedValue>
<ContactId>0</ContactId>
<CreditUnion>false</CreditUnion>
<EntertainmentExpense>0</EntertainmentExpense>
<FactFinderDebtId>0</FactFinderDebtId>
<FamilyFriendLoansExpense>0</FamilyFriendLoansExpense>
<FirstCar>false</FirstCar>
<FirstCarValue>0</FirstCarValue>
<GasElectricityExpense>0</GasElectricityExpense>
<GroceriesExpense>0</GroceriesExpense>
<HomeInsuranceExpense>0</HomeInsuranceExpense>
<HomeRentInsurance>false</HomeRentInsurance>
<HomeRentInsuranceValue>0</HomeRentInsuranceValue>
<HomeValue>0</HomeValue>
<LifeInsurance>false</LifeInsurance>
<LifeInsuranceCostExpense>0</LifeInsuranceCostExpense>
<LifeInsuranceMonthly>0</LifeInsuranceMonthly>
<LifePolicyAmount>0</LifePolicyAmount>
<MedicalExpense>0</MedicalExpense>
<MiscellaneousExpense>0</MiscellaneousExpense>
<MortgageRentExpense>0</MortgageRentExpense>
<OtherProperty>false</OtherProperty>
<OtherPropertyValue>0</OtherPropertyValue>
<OwnHome>false</OwnHome>
<PropertyTaxExpense>0</PropertyTaxExpense>
<RVPaymentExpense>0</RVPaymentExpense>
<SavingsPaymentExpense>0</SavingsPaymentExpense>
<SecondCar>false</SecondCar>
<SecondCarValue>0</SecondCarValue>
<Stocks401kOther>false</Stocks401kOther>
<Stocks401kOtherValue>0</Stocks401kOtherValue>
<TelephoneCellExpense>0</TelephoneCellExpense>
<WaterTrashSewerExpense>0</WaterTrashSewerExpense>
<WhatBank>String</WhatBank>
</FactFinderDebt>
<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>
</FactFinderDebt>
</FactFinderDebtRequest>