Skip to content

Latest commit

 

History

History
55 lines (52 loc) · 7.12 KB

ConstituentRead.md

File metadata and controls

55 lines (52 loc) · 7.12 KB

# ConstituentRead

Properties

Name Type Description Notes
id string The immutable system record ID for the constituent. This is not the same as the user-definable constituent identifier, which is stored in the <code>lookup_id</code>. [optional]
address \BurgerDigital\BlackbaudPhpSdk\Model\AddressRead [optional]
age int This computed field calculates the constituent's age based on the <code>birthdate</code> property. For individuals only. [optional]
birthdate \BurgerDigital\BlackbaudPhpSdk\Model\FuzzyDate [optional]
date_added \DateTime The date when the constituent was created. Includes an offset from UTC in <a href=&quot;https://tools.ietf.org/html/rfc3339\&quot;&gt;ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>. [optional]
date_modified \DateTime The date when the constituent was last modified. Includes an offset from UTC in <a href=&quot;https://tools.ietf.org/html/rfc3339\&quot;&gt;ISO-8601 format: </a><i>1969-11-21T10:29:43-04:00</i>. [optional]
deceased bool Indicates whether the constituent is deceased. For individuals only. [optional]
deceased_date \BurgerDigital\BlackbaudPhpSdk\Model\FuzzyDate [optional]
email \BurgerDigital\BlackbaudPhpSdk\Model\EmailAddressRead [optional]
first string The constituent's first name. For individuals only. [optional]
former_name string The constituent's former name. For individuals only. [optional]
fundraiser_status string Indicates whether the constituent is a fundraiser. For individuals only. [optional]
gender string The constituent's gender. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListGenders\&quot;&gt;&lt;b&gt;Gender&lt;/b&gt;&lt;/a> table. This property defaults to <i>unknown</i> if no value is provided. For individuals only. [optional]
gives_anonymously bool Indicates whether the constituent gives anonymously. [optional]
inactive bool Indicates whether the constituent is inactive. [optional]
last string The constituent's last name. For individuals only. [optional]
lookup_id string The user-defined identifier for the constituent. [optional]
marital_status string The constituent's marital status. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListMaritalStatuses\&quot;&gt;&lt;b&gt;Marital Status</b></a> table. For individuals only. [optional]
middle string The constituent's middle name. For individuals only. [optional]
name string If the constituent's <code>type</code> is <i>Individual</i>, this computed field indicates the full name of the constituent based on the target organization’s display name settings. If the <code>type</code> is <i>Organization</i>, this is the organization's name. [optional]
online_presence \BurgerDigital\BlackbaudPhpSdk\Model\OnlinePresenceRead [optional]
phone \BurgerDigital\BlackbaudPhpSdk\Model\PhoneRead [optional]
preferred_name string The constituent's preferred name. For individuals only. [optional]
spouse \BurgerDigital\BlackbaudPhpSdk\Model\SpouseRead [optional]
suffix string The constituent's primary suffix. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\&quot;&gt;&lt;b&gt;Suffixes&lt;/b&gt;&lt;/a> table. For individuals only. [optional]
suffix_2 string The constituent's secondary suffix. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListSuffixes\&quot;&gt;&lt;b&gt;Suffixes&lt;/b&gt;&lt;/a> table. For individuals only. [optional]
title string The constituent's primary title. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\&quot;&gt;&lt;b&gt;Titles&lt;/b&gt;&lt;/a> table. For individuals only. [optional]
title_2 string The constituent's secondary title. Available values are the entries in the <a href=&quot;https://developer.sky.blackbaud.com/docs/services/56b76470069a0509c8f1c5b3/operations/ListTitles\&quot;&gt;&lt;b&gt;Titles&lt;/b&gt;&lt;/a> table. For individuals only. [optional]
type string The type of constituent. Available values are <i>Individual</i> and <i>Organization</i>. [optional]
birthplace string The birthplace of the constituent. For individuals only. [optional]
ethnicity string The ethnicity of the constituent. For individuals only. [optional]
income string The income for the constituent. For individuals only. [optional]
religion string The religion of the constituent. For individuals only. [optional]
industry string The industry of the constituent. For organizations only. [optional]
matches_gifts bool Indicates if the constituent matches gifts. For organizations only. [optional]
matching_gift_per_gift_min \BurgerDigital\BlackbaudPhpSdk\Model\Currency [optional]
matching_gift_per_gift_max \BurgerDigital\BlackbaudPhpSdk\Model\Currency [optional]
matching_gift_total_min \BurgerDigital\BlackbaudPhpSdk\Model\Currency [optional]
matching_gift_total_max \BurgerDigital\BlackbaudPhpSdk\Model\Currency [optional]
matching_gift_factor double The matching gift factor for the constituent. For organizations only. [optional]
matching_gift_notes string The matching gift notes for the constituent. For organizations only. [optional]
num_employees int The number of employees for the constituent. For organizations only. [optional]
is_memorial bool Indicates whether the constituent is for honor/memorial. [optional]
is_solicitor bool Indicates whether the constituent is a solicitor. [optional]
no_valid_address bool Indicates whether the constituent does not have a valid address. [optional]
receipt_type string The receipt type of the constituent. [optional]
target string The target of the constituent. [optional]

[Back to Model list] [Back to API list] [Back to README]