GET 17.0/database/contacts/defaultmodel

Description

Get a Contacts model with default values

URI Parameters

None.

None.

None.

Contacts
Name Description Type Additional information
ID

integer

None.
LastName

string

String length: inclusive between 0 and 50
FirstNames

string

String length: inclusive between 0 and 30
Salutation

string

String length: inclusive between 0 and 50
TitleID

integer

None.
TypeID

integer

None.
StatusID

integer

None.
StatusDate

date

None.
SourceID

integer

None.
ProfessionID

integer

None.
AddedDate

date

None.
UpdatedDate

date

None.
UserID

integer

None.
AssignedUserID

integer

None.
SiteID

integer

None.
BirthDate

date

None.
PrimaryContact

byte

None.
LinkedTo

integer

None.
Email

string

String length: inclusive between 0 and 50
EmailAlt

string

String length: inclusive between 0 and 50
WebPage

string

String length: inclusive between 0 and 50
MobileTelephone

string

String length: inclusive between 0 and 30
CardID

string

String length: inclusive between 0 and 50
CardRequired

byte

None.
TelephoneList

byte

None.
EmailingList

byte

None.
MailingList

byte

None.
SMSList

byte

None.
MailingAddress

byte

None.
MailingCheckedDate

date

None.
MailingRenewalDate

date

None.
HomeCountryCode

integer

None.
HomeProperty

string

String length: inclusive between 0 and 50
HomeStreet

string

String length: inclusive between 0 and 50
HomeLocality

string

String length: inclusive between 0 and 30
HomeTown

string

String length: inclusive between 0 and 30
HomePostcode

string

String length: inclusive between 0 and 30
HomeRegion

string

String length: inclusive between 0 and 30
HomeCountry

string

String length: inclusive between 0 and 30
HomeTelephone

string

String length: inclusive between 0 and 30
HomeTelephoneAlt

string

String length: inclusive between 0 and 50
HomeFax

string

String length: inclusive between 0 and 30
BusinessCompany

string

String length: inclusive between 0 and 100
BusinessJobTitle

string

String length: inclusive between 0 and 50
BusinessCountryCode

integer

None.
BusinessProperty

string

String length: inclusive between 0 and 50
BusinessStreet

string

String length: inclusive between 0 and 50
BusinessLocality

string

String length: inclusive between 0 and 30
BusinessTown

string

String length: inclusive between 0 and 30
BusinessPostcode

string

String length: inclusive between 0 and 30
BusinessRegion

string

String length: inclusive between 0 and 30
BusinessCountry

string

String length: inclusive between 0 and 30
BusinessTelephone

string

String length: inclusive between 0 and 30
BusinessFax

string

String length: inclusive between 0 and 30
BusinessDepartment

string

String length: inclusive between 0 and 50
BusinessQualifications

string

String length: inclusive between 0 and 100
BusinessDX

string

String length: inclusive between 0 and 30
OverseasTaxMethod

byte

None.
DeductTaxRateID

integer

None.
FICOApprovalNumber

string

String length: inclusive between 0 and 30
FICOApprovalDate

date

None.
PreferredDeliveryMethod

integer

None.
NINumber

string

String length: inclusive between 0 and 30
PreferredRentDemandMethod

byte

None.
ManagementTypeID

integer

None.
PropertyManagementType

integer

None.
PropertyIntroductionFee

decimal number

None.
PropertyIntroductionPercentage

decimal number

None.
PropertyManagementFee

decimal number

None.
PropertyManagementPercentage

decimal number

None.
ProcessOutlookEmails

byte

None.
PreferredFeedbackMethod

byte

None.
PreferredFeedbackReportMethod

byte

None.
InvoiceFeesSeparately

byte

None.
PassDataTo3rdParties

byte

None.
PassDataToIFA

byte

None.
PassDataToConveyancer

byte

None.
LocalAuthorityLLRegistration

byte

None.
GuarantorID

integer

None.
CustomBankAccounts

byte

None.
ClientBankAccountID

integer

None.
DepositBankAccountID

integer

None.
UploadData

byte

None.
ConsolidatedPayments

byte

None.
PaymentDay

integer

None.
ConsolidatedFloat

decimal number

None.
PassportNumber

string

String length: inclusive between 0 and 44
DrivingLicenceNumber

string

String length: inclusive between 0 and 30
MarketingPreferencesSentDate

date

None.
MarketingPreferencesConfirmedDate

date

None.
TaxReferenceNumber

string

String length: inclusive between 0 and 30
WorkOrderCommissionFee

decimal number

None.
WorkOrderCommissionPercentage

decimal number

None.
PausePaymentRun

byte

None.

application/json, text/json
Sample: 
{
  "id": 1,
  "lastName": "sample string 2",
  "firstNames": "sample string 3",
  "salutation": "sample string 4",
  "titleID": 5,
  "typeID": 6,
  "statusID": 7,
  "statusDate": "2025-01-09T20:48",
  "sourceID": 9,
  "professionID": 10,
  "addedDate": "2025-01-09T20:48",
  "updatedDate": "2025-01-09T20:48",
  "userID": 13,
  "assignedUserID": 14,
  "siteID": 15,
  "birthDate": "2025-01-09T20:48",
  "primaryContact": 64,
  "linkedTo": 18,
  "email": "sample string 19",
  "emailAlt": "sample string 20",
  "webPage": "sample string 21",
  "mobileTelephone": "sample string 22",
  "cardID": "sample string 23",
  "cardRequired": 64,
  "telephoneList": 64,
  "emailingList": 64,
  "mailingList": 64,
  "smsList": 64,
  "mailingAddress": 64,
  "mailingCheckedDate": "2025-01-09T20:48",
  "mailingRenewalDate": "2025-01-09T20:48",
  "homeCountryCode": 32,
  "homeProperty": "sample string 33",
  "homeStreet": "sample string 34",
  "homeLocality": "sample string 35",
  "homeTown": "sample string 36",
  "homePostcode": "sample string 37",
  "homeRegion": "sample string 38",
  "homeCountry": "sample string 39",
  "homeTelephone": "sample string 40",
  "homeTelephoneAlt": "sample string 41",
  "homeFax": "sample string 42",
  "businessCompany": "sample string 43",
  "businessJobTitle": "sample string 44",
  "businessCountryCode": 45,
  "businessProperty": "sample string 46",
  "businessStreet": "sample string 47",
  "businessLocality": "sample string 48",
  "businessTown": "sample string 49",
  "businessPostcode": "sample string 50",
  "businessRegion": "sample string 51",
  "businessCountry": "sample string 52",
  "businessTelephone": "sample string 53",
  "businessFax": "sample string 54",
  "businessDepartment": "sample string 55",
  "businessQualifications": "sample string 56",
  "businessDX": "sample string 57",
  "overseasTaxMethod": 64,
  "deductTaxRateID": 59,
  "ficoApprovalNumber": "sample string 60",
  "ficoApprovalDate": "2025-01-09T20:48",
  "preferredDeliveryMethod": 62,
  "niNumber": "sample string 63",
  "preferredRentDemandMethod": 64,
  "managementTypeID": 65,
  "propertyManagementType": 66,
  "propertyIntroductionFee": 67.0,
  "propertyIntroductionPercentage": 68.0,
  "propertyManagementFee": 69.0,
  "propertyManagementPercentage": 70.0,
  "processOutlookEmails": 64,
  "preferredFeedbackMethod": 64,
  "preferredFeedbackReportMethod": 64,
  "invoiceFeesSeparately": 64,
  "passDataTo3rdParties": 64,
  "passDataToIFA": 64,
  "passDataToConveyancer": 64,
  "localAuthorityLLRegistration": 64,
  "guarantorID": 79,
  "customBankAccounts": 64,
  "clientBankAccountID": 81,
  "depositBankAccountID": 82,
  "uploadData": 64,
  "consolidatedPayments": 64,
  "paymentDay": 85,
  "consolidatedFloat": 86.0,
  "passportNumber": "sample string 87",
  "drivingLicenceNumber": "sample string 88",
  "marketingPreferencesSentDate": "2025-01-09T20:48",
  "marketingPreferencesConfirmedDate": "2025-01-09T20:48",
  "taxReferenceNumber": "sample string 91",
  "workOrderCommissionFee": 92.0,
  "workOrderCommissionPercentage": 93.0,
  "pausePaymentRun": 64
}

application/xml, text/xml
Sample: 
<Contacts xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ID>1</ID>
  <LastName>sample string 2</LastName>
  <FirstNames>sample string 3</FirstNames>
  <Salutation>sample string 4</Salutation>
  <TitleID>5</TitleID>
  <TypeID>6</TypeID>
  <StatusID>7</StatusID>
  <StatusDate>2025-01-09T20:48:44.4289535+00:00</StatusDate>
  <SourceID>9</SourceID>
  <ProfessionID>10</ProfessionID>
  <AddedDate>2025-01-09T20:48:44.4289535+00:00</AddedDate>
  <UpdatedDate>2025-01-09T20:48:44.4289535+00:00</UpdatedDate>
  <UserID>13</UserID>
  <AssignedUserID>14</AssignedUserID>
  <SiteID>15</SiteID>
  <BirthDate>2025-01-09T20:48:44.4289535+00:00</BirthDate>
  <PrimaryContact>64</PrimaryContact>
  <LinkedTo>18</LinkedTo>
  <Email>sample string 19</Email>
  <EmailAlt>sample string 20</EmailAlt>
  <WebPage>sample string 21</WebPage>
  <MobileTelephone>sample string 22</MobileTelephone>
  <CardID>sample string 23</CardID>
  <CardRequired>64</CardRequired>
  <TelephoneList>64</TelephoneList>
  <EmailingList>64</EmailingList>
  <MailingList>64</MailingList>
  <SMSList>64</SMSList>
  <MailingAddress>64</MailingAddress>
  <MailingCheckedDate>2025-01-09T20:48:44.4289535+00:00</MailingCheckedDate>
  <MailingRenewalDate>2025-01-09T20:48:44.4289535+00:00</MailingRenewalDate>
  <HomeCountryCode>32</HomeCountryCode>
  <HomeProperty>sample string 33</HomeProperty>
  <HomeStreet>sample string 34</HomeStreet>
  <HomeLocality>sample string 35</HomeLocality>
  <HomeTown>sample string 36</HomeTown>
  <HomePostcode>sample string 37</HomePostcode>
  <HomeRegion>sample string 38</HomeRegion>
  <HomeCountry>sample string 39</HomeCountry>
  <HomeTelephone>sample string 40</HomeTelephone>
  <HomeTelephoneAlt>sample string 41</HomeTelephoneAlt>
  <HomeFax>sample string 42</HomeFax>
  <BusinessCompany>sample string 43</BusinessCompany>
  <BusinessJobTitle>sample string 44</BusinessJobTitle>
  <BusinessCountryCode>45</BusinessCountryCode>
  <BusinessProperty>sample string 46</BusinessProperty>
  <BusinessStreet>sample string 47</BusinessStreet>
  <BusinessLocality>sample string 48</BusinessLocality>
  <BusinessTown>sample string 49</BusinessTown>
  <BusinessPostcode>sample string 50</BusinessPostcode>
  <BusinessRegion>sample string 51</BusinessRegion>
  <BusinessCountry>sample string 52</BusinessCountry>
  <BusinessTelephone>sample string 53</BusinessTelephone>
  <BusinessFax>sample string 54</BusinessFax>
  <BusinessDepartment>sample string 55</BusinessDepartment>
  <BusinessQualifications>sample string 56</BusinessQualifications>
  <BusinessDX>sample string 57</BusinessDX>
  <OverseasTaxMethod>64</OverseasTaxMethod>
  <DeductTaxRateID>59</DeductTaxRateID>
  <FICOApprovalNumber>sample string 60</FICOApprovalNumber>
  <FICOApprovalDate>2025-01-09T20:48:44.4289535+00:00</FICOApprovalDate>
  <PreferredDeliveryMethod>62</PreferredDeliveryMethod>
  <NINumber>sample string 63</NINumber>
  <PreferredRentDemandMethod>64</PreferredRentDemandMethod>
  <ManagementTypeID>65</ManagementTypeID>
  <PropertyManagementType>66</PropertyManagementType>
  <PropertyIntroductionFee>67</PropertyIntroductionFee>
  <PropertyIntroductionPercentage>68</PropertyIntroductionPercentage>
  <PropertyManagementFee>69</PropertyManagementFee>
  <PropertyManagementPercentage>70</PropertyManagementPercentage>
  <ProcessOutlookEmails>64</ProcessOutlookEmails>
  <PreferredFeedbackMethod>64</PreferredFeedbackMethod>
  <PreferredFeedbackReportMethod>64</PreferredFeedbackReportMethod>
  <InvoiceFeesSeparately>64</InvoiceFeesSeparately>
  <PassDataTo3rdParties>64</PassDataTo3rdParties>
  <PassDataToIFA>64</PassDataToIFA>
  <PassDataToConveyancer>64</PassDataToConveyancer>
  <LocalAuthorityLLRegistration>64</LocalAuthorityLLRegistration>
  <GuarantorID>79</GuarantorID>
  <CustomBankAccounts>64</CustomBankAccounts>
  <ClientBankAccountID>81</ClientBankAccountID>
  <DepositBankAccountID>82</DepositBankAccountID>
  <UploadData>64</UploadData>
  <ConsolidatedPayments>64</ConsolidatedPayments>
  <PaymentDay>85</PaymentDay>
  <ConsolidatedFloat>86</ConsolidatedFloat>
  <PassportNumber>sample string 87</PassportNumber>
  <DrivingLicenceNumber>sample string 88</DrivingLicenceNumber>
  <MarketingPreferencesSentDate>2025-01-09T20:48:44.4289535+00:00</MarketingPreferencesSentDate>
  <MarketingPreferencesConfirmedDate>2025-01-09T20:48:44.4289535+00:00</MarketingPreferencesConfirmedDate>
  <TaxReferenceNumber>sample string 91</TaxReferenceNumber>
  <WorkOrderCommissionFee>92</WorkOrderCommissionFee>
  <WorkOrderCommissionPercentage>93</WorkOrderCommissionPercentage>
  <PausePaymentRun>64</PausePaymentRun>
</Contacts>