The following lists the database field names associated with [[Standard Fields]].<br> These are used in JSON API (SmartConnect).<br> == Field List Syntax ==
These are used in JSON API (SmartConnect).
==Field List Syntax==
{| class="wikitable"
|
|-
!|Field List Syntax!|Example
|-
||Separate values with ";;" ||sf_Name;;cf_MyFieldName;;cf_MyFieldssid
|-
||Prefix Standard fields with "sf_"||sf_Name
|}
==Companies==
* '''sf_Company ID''': Company id. (0 if new company){| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference* '''sf_Parent Company''': Parent company name.! width="25%"|Field Description* '''sf_Parent Company ID'''! style="text-align: Parent company id.center;" width="15%"|Allow Get/List* '''sf_Is External'''! style="text-align: Flag (1center;" width=external, 0"15%"|Allow Update! width=internal)"25%"|Notes External|-||sf_Name* '''sf_Owner ID''': Owner ID ||Name of current company.* '''sf_Owner'''| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Phone||| style="text-align: Owner name of company.center;"|✓* '''sf_Primary Contact ID'''| style="text-align: Primary contact ID of company. (0 if empty)center;"|✓|||-||sf_Fax||* '''sf_Primary Contact'''| style="text-align: Primary contact name of company.center;"|✓* '''sf_Name'''| style="text-align: Name standard field.center;"|✓|||-* '''||sf_Address'''||| style="text-align: center;"|✓| style="text-align: Address standard field.center;"|✓|||-* '''||sf_Address 2'''||| style="text-align: Address2 standard field.center;"|✓| style="text-align: center;"|✓|||-* '''||sf_City'''||| style="text-align: center;"|✓| style="text-align: City standard field.center;"|✓|||-* '''||sf_State / Province'''||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Country||| style="text-align: center;"|✓| style="text-align: Province standard field.center;"|✓||Update using Country ID or Country name as value|-* '''||sf_Zip / Postal Code'''||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Web Site||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Latitude||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Primary Contact||Primary Contact name| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Parent Company||Parent company name| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Owner||Name of User in Owner Standard Field| style="text-align: center;"|✓| style="text-align: Postal code center;"|Not Updatable|||-||sf_Company Workflow||ID of Company workflow standard field.* '''sf_Country'''| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_User Workflow||ID of country User workflow standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Last Updated||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Company ID||Company id. (0 if emptynew company)* '''sf_Phone'''| style="text-align: center;"|✓| style="text-align: Phone standard center;"|Not Updatable||Mandatory field.for updating records|-||sf_Owner ID||ID of User in Owner Standard Field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Parent Company ID||ID of Parent Company| style="text-align: center;"|✓* '''sf_Fax'''| style="text-align: Fax standard center;"|✓||Mandatory field.for adding records|-||sf_Primary Contact ID||Primary Contact ID (0 if empty)| style="text-align: center;"|✓* '''sf_Web Site'''| style="text-align: Website standard field.center;"|✓|||-* '''||sf_Category ID List''': ||Comma delimited list of category IDs. (Starts and ends with a comma)* '''sf_Last Updated'''| style="text-align: date the record was last updated on SmartSimplecenter;"|✓* '''sf_Created Dated'''| style="text-align: date the record was created on SmartSimplecenter;"|✓|||-* '''||sf_Status ID'''||Returns Status ID| style="text-align: center;"|✓| style="text-align: Status center;"|✓||Update using Status ID of the company.as value|-||sf_Is External||Flag (1=external, 0=internal)| style="text-align: center;"|✓* '''sf_Status'''| style="text-align: Status name center;"|Not Updatable||Mandatory field for adding records For updates, this attribute will follow the attribute of the parent company.* '''|-||sf_Status Caption'''||Returns Status Caption| style="text-align: center;"|✓| style="text-align: Status caption of the company.center;"|Not Updatable|||}
==Users==
* '''sf_User ID'''{| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: User ID (0 if new user)center;" width="15%"|Allow Update* '''sf_Is ! width="25%"|Notes External'''|-||sf_First Name||| style="text-align: center;"|✓| style="text-align: Flag (1center;"|✓|||-||sf_Last Name||| style=external, 0"text-align: center;"|✓| style=internal)"text-align: center;"|✓|||-||sf_Email||* '''sf_Company ID'''| style="text-align: ID of user's company. 0 if empty.center;"|✓* '''sf_Company'''| style="text-align: name of user's company.center;"|✓|||-* '''||sf_Title'''||| style="text-align: center;"|✓| style="text-align: Title standard field.center;"|✓|||-* '''||sf_Prefix'''||| style="text-align: center;"|✓| style="text-align: Prefix standard field.center;"|✓|||-* '''||sf_Suffix'''||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Phone||| style="text-align: Suffix standard field.center;"|✓* '''sf_First Name'''| style="text-align: First name standard fieldcenter;"|✓|||-||sf_Phone Ext.* '''sf_Last Name'''||| style="text-align: Last name standard field.center;"|✓* '''sf_Email'''| style="text-align: Email standard field.center;"|✓|||-* '''||sf_Address'''||| style="text-align: center;"|✓| style="text-align: Address standard field.center;"|✓|||-* '''||sf_Address 2'''||| style="text-align: center;"|✓| style="text-align: Address 2 standard field.center;"|✓|||-* '''||sf_City'''||| style="text-align: center;"|✓| style="text-align: City standard field.center;"|✓|||-* '''||sf_State / Province'''||| style="text-align: center;"|✓| style="text-align: Province standard field.center;"|✓|||-* '''||sf_Country'''||| style="text-align: name of country field. 0 if empty.center;"|✓* '''sf_Country ID'''| style="text-align: ID of country field. 0 if empty.center;"|✓|||-* '''||sf_Zip / Postal Code||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Company||Name of user'''s company| style="text-align: center;"|✓| style="text-align: center;"|✓||When updating, use Company ID or Company name as value|-||sf_Middle Name||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude||| style="text-align: center;"|✓| style="text-align: Postal code standard field.center;"|✓|||-||sf_Latitude||* '''sf_Phone'''| style="text-align: Phone standard field.center;"|✓* '''sf_Phone Ext'''| style="text-align: Phone extension field.center;"|✓|||-* '''||sf_User Role''': ||Comma delimited list of role IDs. (Starts and ends with a comma)* '''sf_Active | style="text-align: center;"|✓| style="text-align: center;"|✓||sf_User Role and sf_Role ID List are interchangable.|-||sf_Access Type''': ||1 ('Administration or Portal InterfaceUser'), 3 ('User Centric or Applicant Interface'), 5 or 0 ('Web Service UserAPI'),0 ('No Access')* '''| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using ID as value|-||sf_User Type''': ||10 ('User'‘User’), 30 ('Local ‘Local User Administrator'Administrator’), 40 50 ('Global ‘Global User Administrator'Administrator’)* '''sf_Status'''| style="text-align: center;"|✓| style="text-align: status center;"|✓||Update using ID of useras value|-* '''||sf_Updated By''': name ||Name of user who that last updated the record.* '''| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Last Updated''': date ||Date record was last updated.* '''| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date''': date ||Date the record was created.* '''sf_Created By'''| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Status||Returns Status name | style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_User ID||User ID (0 if new user)| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Company ID||ID of user who created 's company. 0 if empty.| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Status ID||Returns Status ID| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Role ID List||Comma delimited list of role IDs. (Starts and ends with a comma)| style="text-align: center;"|✓| style="text-align: center;"|✓||sf_User Role and sf_Role ID List are interchangable.|-||sf_Is External||Flag (1=external, 0=internal)| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for adding records For updates, this attribute will follow the attribute of the record.parent company |-||sf_Status Caption||Returns Status Caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||}
==Level 1==
* '''sf_Level One ID'''{| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: Tracking ID of center;" width="15%"|Allow Update! width="25%"|Notes External|-||sf_Application Type||Returns level 1.template name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Type ID as value|-* '''||sf_Application Name||Returns value of Name standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Customer||Name of company on Client standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Company ID'''as value|-||sf_Person||Name of contact attached to Person standard field| style="text-align: center;"|✓| style="text-align: UTA center;"|✓||Update using User ID.as value|-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓* '''sf_Company ||Update using Status ID'''as value|-||sf_Revenue||Revenue standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Currency||Currency standard field| style="text-align: center;"|✓| style="text-align: Company ID center;"|✓|||-||sf_Close Date||Close Date standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Modified Date||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Modified By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Probability||Probability standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Requirement||Requirement standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Owner||Returns name of level 1 owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID as value|-||sf_Branch||Returns company/client name on Branch standard field. | style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Branch ID as value|-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Archived||Flag (1=Archived, 0 if empty.=Not Archived)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Level One ID* '''sf_Branch ||Returns unique Level 1 tracking ID'''| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records Use "recordid" in place of "sf_Level One ID" in updating records |-||sf_Company ID||Company ID of level 1 branch company/client field. 0 if empty.* '''| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Person ID''': ||User ID of level 1 people field. 0 if empty.* '''sf_Person'''| style="text-align: center;"|✓| style="text-align: name center;"|✓|||-||sf_Branch ID||Company ID of User for level 1 people branch field. 0 if empty| style="text-align: center;"|✓| style="text-align: center;"|✓|||-* '''||sf_Type ID''': ||ID of level 1 template.* '''sf_Application Template Type'''| style="text-align: Level 1 template type name.center;"|✓* '''sf_Application Name'''| style="text-align: Name standard field.center;"|✓* '''sf_Description''': Description standard ||Mandatory field.for adding records<br /> Update using Type ID as value* '''sf_Requirement''': Requirement standard field.|-* '''||sf_Status ID''': ||Status ID of level 1 status. 0 if empty.* '''sf_Status'''| style="text-align: center;"|✓| style="text-align: Name center;"|✓||Mandatory field for adding records<br /> Update using Status ID as value|-||sf_Owner ID||ID of level 1 statusowner.* '''sf_Revenue'''| style="text-align: Revenue standard field.center;"|✓* '''sf_Start Date'''| style="text-align: Start date standard field.center;"|✓|||-||sf_Application ID||Returns UTA ID* '''sf_End Date'''| style="text-align: End date standard field.center;"|✓* '''sf_Close Date'''| style="text-align: Close date standard field.center;"|Not Updatable|||-||sf_Status Caption||Returns Status caption* '''sf_Probability'''| style="text-align: Probability standard field.center;"|✓* '''sf_Owner ID'''| style="text-align: ID of level 1 owner.center;"|Not Updatable|||-||sf_Type Caption* '''sf_Owner''': Name of ||Returns level 1 owner.template caption* '''sf_Modified By'''| style="text-align: Name of user who modified the record.center;"|✓* '''sf_Modified Date'''| style="text-align: Date the record was modified.center;"|Not Updatable* '''sf_Created By''': Name of user who created the record.||* '''sf_Created Date''': Date the record was created.|}
==Level 2==
* '''sf_Level Two ID'''{| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Activity Type||Returns level 2 type name| style="text-align: center;"|✓| style="text-align: Activity center;"|✓||Update using Type ID of as value|-||sf_Subject||Returns level 2.subject| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓* '''sf_Application ||Update using Status ID'''as value|-||sf_Location||Location standard field| style="text-align: UTA ID.center;"|✓* '''sf_Description'''| style="text-align: Description center;"|✓|||-||sf_Duration||Duration standard field.* '''sf_Subject'''| style="text-align: center;"|✓| style="text-align: Subject center;"|✓|||-||sf_Owner||Returns name of level 2 owner standard field.* '''sf_Type | style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID'''as value|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Whole Day Event||Flag (Yes, No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Reminder Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Reminder Type||Returns ID of level 2/3 reminder type.* '''sf_Activity | style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Follow-up Type'''||Returns Id of follow-up type| style="text-align: Level 2 type name.center;"|✓* '''sf_Parent ID'''| style="text-align: Parent object ID.center;"|✓|||-* '''||sf_Assign Person''': ||Comma delimited list of user IDs in assigned standard field.* '''| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Contact Person''': ||Comma delimited list of user IDs in contact standard field.* '''sf_Location'''| style="text-align: center;"|✓| style="text-align: Location center;"|✓|||-||sf_Description||Returns value from Description standard field.* '''sf_Start Date'''| style="text-align: center;"|✓| style="text-align: Start date center;"|✓|||-||sf_Amount||Returns value from Amount standard field.* '''sf_End Date'''| style="text-align: center;"|✓| style="text-align: End date center;"|✓|||-||sf_Parent Name||Returns Name standard field.from parent level 1| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Latitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Level Two ID||Returns unique level 2 ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records Use "recordid" in place of "sf_Level Two ID" in updating records |-||sf_Parent ID||Returns level 1 ID from parent record| style="text-align: center;"|✓* '''sf_Duration'''| style="text-align: Duration standard center;"|✓||Mandatory field.for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L2 records|-||sf_Type ID||ID of level 2 template| style="text-align: center;"|✓* '''sf_Amount'''| style="text-align: Amount standard center;"|✓||Mandatory field.for adding records|-* '''||sf_Status ID''': ||Status ID of level 1 status. 0 if empty.* '''sf_Status'''| style="text-align: center;"|✓| style="text-align: Status name.center;"|✓||Mandatory field for adding records|-* '''||sf_Owner ID''': User ||ID of level 1 owner. 0 if empty.* '''sf_Owner'''| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Application ID||Returns UTA ID| style="text-align: center;"|✓| style="text-align: Name of owner. center;"|Not Updatable|||-||sf_Status Caption||Returns Status caption* '''sf_Updated By'''| style="text-align: Name of user who updated the record. center;"|✓* '''sf_Last Modified'''| style="text-align: Date the record was modified. center;"|Not Updatable|||-||sf_Type Caption||Returns level 2 type caption* '''sf_Created By'''| style="text-align: Name of user who created the record. center;"|✓* '''sf_Created Date'''| style="text-align: Date the record was created.center;"|Not Updatable|||}
==Level 3==
See Level {| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Activity Type||Returns level 3 type name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Type ID as value|-||sf_Subject||Returns level 3 subject| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Status||Returns Status name| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Status ID as value|-||sf_Location||Location standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Duration||Duration standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Owner||Returns name of level 3 owner standard field| style="text-align: center;"|✓| style="text-align: center;"|✓||Update using Owner ID as value|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Start Date||Returns Start Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_End Date||Returns End Date and Time in YYYY-MM-DD HH:MM:SS| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Whole Day Event||Flag (Yes, No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Reminder Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Follow-up Sent||Flag (1=Yes 0=No)| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Reminder Type||Returns ID of reminder type| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Follow-up Type||Returns Id of follow-up type| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Parent Subject||Returns Subject field from parent level 2.| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Associated Parent||Displays level 2 ID from soft-linked UTA| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Assign Person||Comma delimited list of user IDs in assigned standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Contact Person||Comma delimited list of user IDs in contact standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Description||Returns value from Description standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Amount||Returns value from Amount standard field| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Longitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Latitude||| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Level Three ID||Returns unique level 3 ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records
Use "recordid" in place of "sf_Level Three ID" in updating records
|-||sf_Parent ID||Returns level 2 ID from parent record| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records<br /> <br /> Use "objectid" in place of "sf_Parent ID" for new L3 records|-||sf_Type ID||ID of level 3 template| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Status ID||Status ID of level 1 status. 0 if empty| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Owner ID||ID of level 1 owner.| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Application ID||Returns UTA ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Status Caption||Returns Status caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Type Caption||Returns level 3 type caption| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||} ==Multiple Address=={| class="wikitable" width=See Also"85%" cellpadding="5px" align="center"|-[[JSON ! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Address ID||Unique id in Multiple Address table| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Object ID||Object ID of parent record. Could be companyid, contactid.| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Type ID||Address type ID| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Type||Address Type| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Address||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Address 2||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_City||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_State / Province||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Zip / Postal Code||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Country||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Last Modified||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Primary Address||Flag (SmartConnect1=Yes, 0=No)]] <br>[[JSON | style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||} ==Associations=={| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||objectid||| style="text-align: center;"|✓| style="text-align: center;"|✓|||} ==Transactions=={| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API (Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Start Date||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_End Date||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Description||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Subject||| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Status||Returns transaction status name| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Modified Date||Date record was last updated| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Updated By||Name of user that last updated the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Type||Transaction type| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|-||sf_Transaction ID||Unique ID for the transaction record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Object ID||Parent object id for the transaction| style="text-align: center;"|✓| style="text-align: center;"|✓||Mandatory field for adding records|} ==Notes==Notes can only be retrieved via GET and LIST. They cannot be created or updated via SmartConnect) Prerequisite]]<br>. {| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_Note ID||Unique ID for the Note record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Type||Note Type| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Type ID||Type ID| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Content||Contents of the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created By||Name of user that created the record| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Created Date||Date the record was created| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||-||sf_Object ID||Parent object id for the note| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable|||} ==System Variables=={| class="wikitable" width="85%" cellpadding="5px" align="center"|-! width="20%"|API Field Reference! width="25%"|Field Description! style="text-align: center;" width="15%"|Allow Get/List! style="text-align: center;" width="15%"|Allow Update! width="25%"|External Notes|-||sf_ID||System variable record ID.| style="text-align: center;"|✓| style="text-align: center;"|Not Updatable||Mandatory field for updating records|-||sf_Name||Variable Name| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Value||Value of the variable| style="text-align: center;"|✓| style="text-align: center;"|✓|||-||sf_Description||Variable Description| style="text-align: center;"|✓| style="text-align: center;"|✓|||}
==Consumer/Provider==
{| class="wikitable" width="85%" cellpadding="5px" align="center"
|-
! width="20%"|API Field Reference
! width="25%"|Field Description
! style="text-align: center;" width="15%"|Allow Get/List
! style="text-align: center;" width="15%"|Allow Update
! width="25%"|External Notes
|-
||providerappid
||[[Determining_the_applicationid|Application ID]] of the provider UTA
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-
||consumerappid
||[[Determining_the_applicationid|Application ID]] of the consumer UTA
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-
||providerid
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the provider UTA L1/L2
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-
||consumerid
||[[Determining_the_opportunityid|Opportunity ID]] or [[Determining_the_eventid|Event ID]] of the consumer UTA L1/L2
| style="text-align: center;"|✓
| style="text-align: center;"|Not Updatable
||
|-
||roleid
||Connection roleid between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
|-
||rolename
||Connection rolename between consumer/provider
| style="text-align: center;"|✓
| style="text-align: center;"|Updatable
||
|-
||associationid
||Unique identifier for the consumer/provider relationship table
| style="text-align: center;"|✓
| style="text-align: center;"|
||
||
|}
==See Also==
[[SmartConnect_-_RESTful_API|SmartConnect - RESTful API]]
[[Category:Integration]][[Category:API]][[Category:SmartConnect RESTful API]]