Create a contact
post
/crmRestApi/resources/11.13.18.05/contacts
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes their academic qualification, such as Dr. Jane Smith. -
AccountPartyId: integer
(int64)
Title:
Related Account Party ID
The unique identifier of sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountSourceSystem: string
Title:
Related Account Source System
The source system code of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountSourceSystemReferenceValue: string
Title:
Related Account Source System Reference
The source system reference value of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AdditionalIdentifier: array
Additional Identifiers
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. -
AdditionalName: array
Additional Names
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name. -
Address: array
Contact Addresses
Title:
Contact Addresses
The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber(required): string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to uniquely identify the address record. -
AddressType: string
Title:
Address Type
Additional information as type of address like BillTo, ShipTo. -
Attachment: array
Contact Attachments
Title:
Contact Attachments
The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the contact. -
ClassificationCategory: string
Title:
Classification Category
A valid classification category code for the contact. This is defined by an admin and is marked as primary. -
ClassificationCode: string
Title:
Classification Code
A valid classification code corresponding to the classification category, which is marked as primary. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
ContactIsPrimaryForAccount: string
Title:
Primary
The primary contact associated with an account. -
ContactPoint: array
Contact Points
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on. -
ContactRole: string
Title:
Contact Role
Maximum Length:60
The name of the role of the contact. -
ContactRollup: array
Contact Rollups
Title:
Contact Rollups
The contact rollups resource is used to view a contact rollup. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The application module that created this contact record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CustomerClassification: array
Aux Classifications
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. -
DataCloudStatus: string
Title:
Enrichment Status
Maximum Length:30
The enrichment status of the contact record from Data cloud. A list of accepted values is defined in the lookup DATA_CLOUD_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The name the department of the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoCallHomePhoneFlag: boolean
Title:
OK to Call Home Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type home of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoCallMobilePhoneFlag: boolean
Title:
OK to Call Mobile Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type mobile of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoCallWorkPhoneFlag: boolean
Title:
OK to Call Work Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type work of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoContactEmailFlag: boolean
Title:
OK to Email
Maximum Length:10
Indicates whether the user can contact using the primary email of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoContactFaxFlag: boolean
Title:
OK to Contact Fax
Maximum Length:10
Indicates whether the user can contact using the primary fax of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotCallHomePhoneFlag: boolean
Title:
Do Not Contact Primary Home Phone
Maximum Length:255
Indicates whether the user can call the primary home phone. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallMobileFlag: boolean
Title:
Do Not Contact Primary Mobile
Maximum Length:255
Indicates whether the user can call the primary mobile. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallWorkPhoneFlag: boolean
Title:
Do Not Contact Primary Work Phone
Maximum Length:255
Indicates whether the user can call the primary work phone. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactEmailFlag: boolean
Title:
Do Not Contact Primary Email
Maximum Length:255
Indicates whether the primary email can be used for contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactFaxFlag: boolean
Title:
Do Not Contact Primary Fax
Maximum Length:255
Indicates whether the primary fax can be used for contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Maximum Length:1
Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Maximum Length:1
Indicates if the user can e-mail the person or not. If the value is True, then the user must not contact the person by e-mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotMailFlag: boolean
Title:
Do Not Mail
Maximum Length:1
Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the contact point. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
The preferred format for e-mail addressed to this address such as HTML or ASCII. A list of accepted values is defined using the lookup EMAIL_FORMAT. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
The date when email address was last verified. -
EmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email. -
FavoriteContactFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:20
The area code for the fax number. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
FaxExtension: string
Title:
Fax Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
FaxNumber: string
Title:
Fax Number
Maximum Length:40
A telephone number formatted in the local format without the area code, country code, or extension. -
FaxVerificationDate: string
(date)
Title:
Fax Verification Date
The date when fax number was last verified. -
FaxVerificationStatus: string
Title:
Fax Verification Status
Maximum Length:30
The status code of the fax number verification. The values based on the lookup are valid and invalid for fax. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
HeadOfHouseholdFlag: boolean
Title:
Head of Household Indicator
Maximum Length:1
Default Value:false
Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False. -
HomePhoneAreaCode: string
Title:
Home Phone Area Code
Maximum Length:20
The area code for the contact's home phone number. -
HomePhoneCountryCode: string
Title:
Home Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number formatted in the local format without the area code, country code, or extension. -
HomePhoneVerificationDate: string
(date)
Title:
Home Phone Verification Date
The date when home phone number was last verified. -
HomePhoneVerificationStatus: string
Title:
Home Phone Verification Status
Maximum Length:30
The status code of the home phone number verification. The values based on lookup are valid and invalid for phone. -
HouseholdIncomeAmount: number
Title:
Household Income
The income of the household that this person is a part of. -
HouseholdSize: number
Title:
Household Size
The size of the household this person is a part of. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title of the contact, for example, Analyst. A list of valid values is defined in the lookup HZLookup. -
LastContactDate: string
(date-time)
Title:
Last Contact Date
The date when the contact was last contacted. -
LastEnrichmentDate: string
(date)
Title:
Last Enrichment Date
The date when the contact record was last enriched with data from external sources by using Data-as-a-Service. -
LastKnownGPS: string
Title:
Last Known Location
Maximum Length:60
Last known location of the contact. Mostly based on GPS enabled device used by contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as fon, van. For example, if a person???s name is Hans Van, the last name of the person is captured using this attribute. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Mobile Area Code
Maximum Length:20
The area code for the contact's mobile phone. -
MobileCountryCode: string
Title:
Mobile Country Code
Maximum Length:10
The international country code for a contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Mobile Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
MobileNumber: string
Title:
Mobile Number
Maximum Length:40
The mobile phone number formatted in the local format. The number should not include area code, country code, or extension. -
MobileVerificationDate: string
(date)
Title:
Mobile Verification Date
The date when mobile phone number was last verified. -
MobileVerificationStatus: string
Title:
Mobile Verification Status
Maximum Length:30
The status code of the mobile phone number verification. The values based on lookup are valid and invalid for phone. -
NamedFlag: boolean
Title:
Named Contact
Maximum Length:1
Default Value:false
Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The part of the name appended to a person's name. For example, the III in Tom Jones III. -
Note: array
Notes
Title:
Notes
The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact. -
OwnerPartyId: integer
(int64)
Title:
Owner Party ID
The unique identifier of a valid employee resource who owns and manages the sales account. The owner is a valid employee resource defined within Engagement Cloud. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. During create, if none of the OwnerPartyID, OwnerPartyNumber, or OwnerEmailAddress is provided, then the contact is assigned by default to the login user. The login user's partyID is used to populate OwnerPartyID. -
PartyNumber(required): string
Title:
Party Number
Maximum Length:30
The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartyNumberKey(required): string
Title:
Registry ID
Maximum Length:30
The alternate unique identifier of the record. -
PersonalIncomeAmount: number
Title:
Annual Income
The estimated gross annual income of the person. -
PictureAttachment: array
Attachments
Title:
Attachments
The contact picture attachments resource is used to view, create, update, or delete the contacts picture. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The code indicating the organization's default currency. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddress: array
Contact Primary Addresses
Title:
Contact Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RawFaxNumber: string
Title:
Raw Fax Number
Maximum Length:60
The unformatted fax number information. -
RawHomePhoneNumber: string
Title:
Raw Home Phone Number
Maximum Length:60
Unformatted home phone number information. -
RawMobileNumber: string
Title:
Raw Mobile Number
Maximum Length:60
The unformatted mobile phone number information. -
RawPhoneNumber: string
Title:
Overall Primary Formatted Phone Number
Maximum Length:60
The raw phone number on the contact point record of type phone. -
RawWorkPhoneNumber: string
Title:
Raw Work Phone Number
Maximum Length:60
The unformatted work phone number information. -
RecordSet: string
Title:
Record Set
Maximum Length:30
The search results displayed under the selected record set. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The code indicating the registration status of the contact. For example, Approved, Pending, or Rejected. The valid list of values is defined in the lookup ORA_CONTACT_REG_STATUS. -
Relationship: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesProfileNumber: string
Title:
Sales Account Number
Maximum Length:30
The unique identifier for the sales profile. -
SalesProfileStatus: string
Title:
Status
Maximum Length:30
A valid user defined status of the sales account. -
SalesTeamMember: array
Sales Account Resources
Title:
Sales Account Resources
Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SalutoryIntroduction: string
Title:
Prefix
Maximum Length:30
The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceSystem: string
Title:
Party Source System
The name of external source system where the contact party is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReference: array
Source System References
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data. -
SourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the contact party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification Number
Maximum Length:20
The taxpayer identification number, which is often a unique identifier of the contact. The typical values are taxpayer Id in USA or fiscal code or NIF in Europe. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
Time zone of a contact to know preferred time to call or email. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
Title:
Type
Maximum Length:30
The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
UniqueNameSuffix: string
Title:
Name Suffix
Maximum Length:540
The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
WorkPhoneAreaCode: string
Title:
Work Phone Area Code
Maximum Length:20
The area code for the contact's work phone. -
WorkPhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The international country code for a contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Work Phone Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number formatted in the local format without the area code, country code, or extension. -
WorkPhoneVerificationDate: string
(date)
Title:
Work Phone Verification Date
The date when work phone number was last verified. -
WorkPhoneVerificationStatus: string
Title:
Work Phone Verification Status
Maximum Length:30
The status code of the work phone number verification. The values based on lookup are valid and invalid for phone.
Nested Schema : Additional Identifiers
Type:
array
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name.
Show Source
Nested Schema : Contact Addresses
Type:
array
Title:
Contact Addresses
The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact.
Show Source
Nested Schema : Contact Attachments
Type:
array
Title:
Contact Attachments
The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Contact Rollups
Type:
array
Title:
Contact Rollups
The contact rollups resource is used to view a contact rollup.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The contact picture attachments resource is used to view, create, update, or delete the contacts picture.
Show Source
Nested Schema : Contact Primary Addresses
Type:
array
Title:
Contact Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member.
Show Source
Nested Schema : Sales Account Resources
Type:
array
Title:
Sales Account Resources
Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of the party identifier. -
PartyIdentifierValue: string
Title:
Identifier Value
Maximum Length:60
The value of the party identifier. -
PartyNumber: string
The party number of the additional identifier.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : contacts-AdditionalName-item-post-request
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartySourceSystem: string
The source system name.
-
PartySourceSystemReferenceValue: string
The identifier for the record from the original system.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of the source system for the associated party.
-
SourceSystemReferenceValue: string
The identifier of the source system reference for the associated party.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
Nested Schema : contacts-Address-item-post-request
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressNumber(required): string
Title:
Site Number
Maximum Length:30
The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressPurpose: array
Contact Address Purposes
Title:
Contact Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The additional information as type of address like BillTo, ShipTo. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city element of the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the address record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The user who created the module. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates if this address should be used for mailing. If the value is True, then the address should not be used for mailing. The default value is False. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes effective.
-
EndDateActive: string
(date)
Title:
End Date
Date on which this address is no longer active. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for this location. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId(required): integer
(int64)
Title:
Party ID
The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDateActive: string
(date)
Title:
Start Date
Date on which this address becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Contact Address Purposes
Type:
array
Title:
Contact Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : contacts-Address-AddressLocale-item-post-request
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : schema
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
Purpose: string
Title:
Purpose
Maximum Length:30
The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDate: string
(date)
Title:
From Date
The date from which the address purpose is valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : contacts-Attachment-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data. For example, a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : schema
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of the contact point. The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email address. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The alternate unique identifier of the contact point.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : schema
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
The code indicating the classification category of the customer. For example, High Technology, Customer, or Telecom. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application module that created the customer classification. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact or household with which the classification is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household with which the classification is associated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the account, contact or household with which the classification is associated. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the customer classification is the primary classification. The default value is false. -
SourceSystem: string
Title:
Source System
The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the customer classification in the external source. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the customer classification was created. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
Nested Schema : contacts-Note-item-post-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the note creator's party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code used to classify a note, as asset or adjustment. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, etc. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Nested Schema : contacts-PictureAttachment-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data. For example, a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : contacts-PrimaryAddress-item-post-request
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The addressee of the primary address. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified during creating the contact, then it is automatically generated using a list of accepted values from the profile option ZCA_PUID_PREFIX, and concatenated with an internally generated unique sequence number. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building mentioned in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier for this location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique source system identifier value.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : contacts-Relationship-item-post-request
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the relationship record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
ObjectPartyId: integer
(int64)
The primary key identifier of the contact, in this relationship. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
-
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The unique alternate identifier for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the contact party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The unique identifier from external source system for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code indicating whether the relationship is a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system for the relationship, which are defined by an Admin as part of system setup.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier of the relationship from the external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The type of relationship of a contact party, such as CUSTOMER_SUPPLIER. A list of accepted relationship type values is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups task. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
StartDate: string
(date)
Title:
From Date
Date on which this relationship becomes active. -
SubjectPartyId: integer
(int64)
The primary key identifier of the subject in this relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
-
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate unique identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an Admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. A list of accepted values should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The unique identifier from external source system for the subject party in the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
Nested Schema : contacts-SalesTeamMember-item-post-request
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
Date on which this sales team member is no longer active. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner of the contract. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The unique identification number for the party.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the household resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales profile of the resource. -
StartDateActive: string
(date)
Title:
Start Date
Date on which this sales team member becomes active. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the sales team member. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : contacts-smartActions-item-post-request
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel(required): string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity(required): string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName(required): string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
array
Title:
Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : contacts-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : contacts-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : contacts-SourceSystemReference-item-post-request
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
EndDate: string
(date)
The date after which the record is inactive.
-
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated contact.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated contact. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the contact. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated contact. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : contacts-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes their academic qualification, such as Dr. Jane Smith. -
AccountName: string
Title:
Account
Read Only:true
Maximum Length:360
The name of the sales account that this contact belongs to. -
AccountPartyId: integer
(int64)
Title:
Related Account Party ID
The unique identifier of sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountPartyNumber: string
Title:
Related Account Party Number
Read Only:true
Maximum Length:30
The party number of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountSourceSystem: string
Title:
Related Account Source System
The source system code of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountSourceSystemReferenceValue: string
Title:
Related Account Source System Reference
The source system reference value of the sales account that this contact belongs to. To specify the account for a contact, you can provide an Account's party ID, PartyNumber, SourceSystem, or SourceSystemReference. -
AccountUniqueName: string
Title:
Account
Read Only:true
Maximum Length:900
The unique name of the primary account. The default value is the concatenation of attributes AccountName and UniqueNameSuffix. -
AdditionalIdentifier: array
Additional Identifiers
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number. -
AdditionalName: array
Additional Names
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name. -
Address: array
Contact Addresses
Title:
Contact Addresses
The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to uniquely identify the address record. -
AddressType: string
Title:
Address Type
Additional information as type of address like BillTo, ShipTo. -
AssignmentExceptionFlag: boolean
Title:
Assignment Exception Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the sales account has the required dimensions to allow assignment manager to assign territories. If the value is True, then the assignment manager doesn???t assign territories to the sales account. The default value is False. -
Attachment: array
Contact Attachments
Title:
Contact Attachments
The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the contact. -
ClassificationCategory: string
Title:
Classification Category
A valid classification category code for the contact. This is defined by an admin and is marked as primary. -
ClassificationCode: string
Title:
Classification Code
A valid classification code corresponding to the classification category, which is marked as primary. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
ContactIsPrimaryForAccount: string
Title:
Primary
The primary contact associated with an account. -
ContactName: string
Title:
Name
Read Only:true
Maximum Length:450
The derived name of the contact. -
ContactPoint: array
Contact Points
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on. -
ContactRole: string
Title:
Contact Role
Maximum Length:60
The name of the role of the contact. -
ContactRollup: array
Contact Rollups
Title:
Contact Rollups
The contact rollups resource is used to view a contact rollup. -
ContactUniqueName: string
Title:
Name
Read Only:true
Maximum Length:900
The unique contact name displayed on contact related screens. The default value for ContactUniqueName is the concatenation of attributes ContactName and UniqueNameSuffix. If the attribute UniqueNameSuffix is nil, then the ContactName is concatenated with a system generated number. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county of the primary address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the contact record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The application module that created this contact record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the contact record was created. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CustomerClassification: array
Aux Classifications
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private. -
DataCloudStatus: string
Title:
Enrichment Status
Maximum Length:30
The enrichment status of the contact record from Data cloud. A list of accepted values is defined in the lookup DATA_CLOUD_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
DeleteFlag: boolean
Title:
Delete Contact
Read Only:true
Indicates if the contact can be deleted. The default value is false. -
Department: string
Title:
Department
Maximum Length:60
The name the department of the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoCallHomePhoneFlag: boolean
Title:
OK to Call Home Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type home of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoCallMobilePhoneFlag: boolean
Title:
OK to Call Mobile Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type mobile of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoCallWorkPhoneFlag: boolean
Title:
OK to Call Work Phone
Maximum Length:10
Indicates whether the user can call the primary contact phone of type work of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoContactEmailFlag: boolean
Title:
OK to Email
Maximum Length:10
Indicates whether the user can contact using the primary email of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoContactFaxFlag: boolean
Title:
OK to Contact Fax
Maximum Length:10
Indicates whether the user can contact using the primary fax of a contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotCallHomePhoneFlag: boolean
Title:
Do Not Contact Primary Home Phone
Maximum Length:255
Indicates whether the user can call the primary home phone. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallMobileFlag: boolean
Title:
Do Not Contact Primary Mobile
Maximum Length:255
Indicates whether the user can call the primary mobile. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallWorkPhoneFlag: boolean
Title:
Do Not Contact Primary Work Phone
Maximum Length:255
Indicates whether the user can call the primary work phone. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactEmailFlag: boolean
Title:
Do Not Contact Primary Email
Maximum Length:255
Indicates whether the primary email can be used for contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactFaxFlag: boolean
Title:
Do Not Contact Primary Fax
Maximum Length:255
Indicates whether the primary fax can be used for contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Maximum Length:1
Indicates if the user can contact the person or not by phone, e-mail, or mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Maximum Length:1
Indicates if the user can e-mail the person or not. If the value is True, then the user must not contact the person by e-mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotMailFlag: boolean
Title:
Do Not Mail
Maximum Length:1
Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the contact point. -
EmailContactPointType: string
Title:
Email Type
Read Only:true
Maximum Length:30
Default Value:EMAIL
The type of contact point for email address. -
EmailContactPtId: string
Title:
Email Contact Point Identifier
Read Only:true
The unique identifier of the email contact point for the contact. -
EmailFormat: string
Title:
Email Format
Maximum Length:30
The preferred format for e-mail addressed to this address such as HTML or ASCII. A list of accepted values is defined using the lookup EMAIL_FORMAT. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
The date when email address was last verified. -
EmailVerificationStatus: string
Title:
Email Verification Status
Maximum Length:30
The status code of the email address verification. The values based on lookup are valid, invalid, or partially invalid for email. -
ExistingCustomerFlag: boolean
Title:
Existing Sales Account
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether there is an existing selling or billing relationship with the sales account. Such relationships are defined by the existence of a Sell_To or Bill_To address. If the value is True, then there is an existing relationship with the sales account. The default value is False. -
ExistingCustomerFlagLastUpdateDate: string
(date)
Title:
Existing Indicator Last Update Date
Read Only:true
The date when the ExistingCustomerFlag was last modified. It is internally populated by the application. -
FavoriteContactFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder. -
FaxAreaCode: string
Title:
Fax Area Code
Maximum Length:20
The area code for the fax number. -
FaxContactPointType: string
Title:
Fax Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point for fax. -
FaxContactPtId: string
Title:
Fax Phone Contact Point Identifier
Read Only:true
The unique identifier of the fax phone contact point for the contact. -
FaxCountryCode: string
Title:
Fax Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
FaxExtension: string
Title:
Fax Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
FaxNumber: string
Title:
Fax Number
Maximum Length:40
A telephone number formatted in the local format without the area code, country code, or extension. -
FaxVerificationDate: string
(date)
Title:
Fax Verification Date
The date when fax number was last verified. -
FaxVerificationStatus: string
Title:
Fax Verification Status
Maximum Length:30
The status code of the fax number verification. The values based on the lookup are valid and invalid for fax. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor Number
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted version of the primary address. -
FormattedFaxNumber: string
Title:
Formatted Fax Number
Read Only:true
The formatted fax number information. -
FormattedHomePhoneNumber: string
Title:
Home Phone
Read Only:true
The formatted home phone number information. -
FormattedMobileNumber: string
Title:
Mobile Phone
Read Only:true
The formatted mobile phone number information. -
FormattedWorkPhoneNumber: string
Title:
Work Phone
Read Only:true
The formatted work phone number information. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
HeadOfHouseholdFlag: boolean
Title:
Head of Household Indicator
Maximum Length:1
Default Value:false
Indicates if the person is the head of the household. If the value is True, then the person is the head of the household. The default value is False. -
HomePhoneAreaCode: string
Title:
Home Phone Area Code
Maximum Length:20
The area code for the contact's home phone number. -
HomePhoneContactPointType: string
Title:
Home Phone Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point for home phone. -
HomePhoneContactPtId: string
Title:
Home Phone Contact Point Identifier
Read Only:true
The unique identifier of the home phone contact point for a contact. -
HomePhoneCountryCode: string
Title:
Home Phone Country Code
Maximum Length:10
The international country code for a telephone number, such as 33 for France. -
HomePhoneNumber: string
Title:
Home Phone Number
Maximum Length:40
The home phone number formatted in the local format without the area code, country code, or extension. -
HomePhoneVerificationDate: string
(date)
Title:
Home Phone Verification Date
The date when home phone number was last verified. -
HomePhoneVerificationStatus: string
Title:
Home Phone Verification Status
Maximum Length:30
The status code of the home phone number verification. The values based on lookup are valid and invalid for phone. -
HouseholdIncomeAmount: number
Title:
Household Income
The income of the household that this person is a part of. -
HouseholdSize: number
Title:
Household Size
The size of the household this person is a part of. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title of the contact, for example, Analyst. A list of valid values is defined in the lookup HZLookup. -
LastAssignmentDate: string
(date)
Title:
Last Assigned Date
Read Only:true
The date when the sales account territory assignment was last run by assignment manager. -
LastContactDate: string
(date-time)
Title:
Last Contact Date
The date when the contact was last contacted. -
LastEnrichmentDate: string
(date)
Title:
Last Enrichment Date
The date when the contact record was last enriched with data from external sources by using Data-as-a-Service. -
LastKnownGPS: string
Title:
Last Known Location
Maximum Length:60
Last known location of the contact. Mostly based on GPS enabled device used by contact. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as fon, van. For example, if a person???s name is Hans Van, the last name of the person is captured using this attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the contact was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the contact record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Mobile Area Code
Maximum Length:20
The area code for the contact's mobile phone. -
MobileContactPointType: string
Title:
Mobile Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point for mobile. -
MobileCountryCode: string
Title:
Mobile Country Code
Maximum Length:10
The international country code for a contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Mobile Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
MobileNumber: string
Title:
Mobile Number
Maximum Length:40
The mobile phone number formatted in the local format. The number should not include area code, country code, or extension. -
MobilePhoneContactPtId: string
Title:
Mobile Phone Contact Point Identifier
Read Only:true
The unique identifier of the mobile phone contact point for the contact. -
MobileVerificationDate: string
(date)
Title:
Mobile Verification Date
The date when mobile phone number was last verified. -
MobileVerificationStatus: string
Title:
Mobile Verification Status
Maximum Length:30
The status code of the mobile phone number verification. The values based on lookup are valid and invalid for phone. -
NamedFlag: boolean
Title:
Named Contact
Maximum Length:1
Default Value:false
Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The part of the name appended to a person's name. For example, the III in Tom Jones III. -
Note: array
Notes
Title:
Notes
The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact. -
OverallPrimaryFormattedPhoneNumber: string
Title:
Overall Primary Formatted Phone Number
Read Only:true
The formatted overall primary phone number. -
OverallPrimaryPhoneContactPtId: integer
(int64)
Read Only:
true
The unique identifier of the primary phone contact. -
OwnerEmailAddress: string
Title:
Owner Email
Read Only:true
Maximum Length:320
The e-mail address of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. -
OwnerName: string
Title:
Owner
Read Only:true
Maximum Length:360
The name of the sales account owner. -
OwnerPartyId: integer
(int64)
Title:
Owner Party ID
The unique identifier of a valid employee resource who owns and manages the sales account. The owner is a valid employee resource defined within Engagement Cloud. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner: PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. During create, if none of the OwnerPartyID, OwnerPartyNumber, or OwnerEmailAddress is provided, then the contact is assigned by default to the login user. The login user's partyID is used to populate OwnerPartyID. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of a valid employee resource who owns and manages the sales account. To assign an owner to the sales account, user can provide one of the following attributes pertaining to the owner, PartyID, PartyNumber, or E-mail Address. This is provided if user wants to change the owner of the contact or create contact with a different owner than the login user. If provided, then OwnerPartyID, OwnerPartyNumber, and OwnerEmailAddress are honored in this order to determine the owner for the contact. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique internal identifier of a contact party. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact party. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The alternate key identifier for the contact party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartyNumberKey: string
Title:
Registry ID
Maximum Length:30
The alternate unique identifier of the record. -
PartyStatus: string
Read Only:
true
Maximum Length:1
Default Value:A
The status of the contact party. A list of valid values are defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
Default Value:PERSON
The type of the party. -
PersonalIncomeAmount: number
Title:
Annual Income
The estimated gross annual income of the person. -
PersonProfileId: integer
(int64)
Title:
Contact ID
Read Only:true
The unique identifier of the person's profile. -
PictureAttachment: array
Attachments
Title:
Attachments
The contact picture attachments resource is used to view, create, update, or delete the contacts picture. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the address. -
PostalPlus4Code: string
Title:
Postal Plus 4 Code
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The code indicating the organization's default currency. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddress: array
Contact Primary Addresses
Title:
Contact Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact. -
PrimaryAddressId: integer
(int64)
Read Only:
true
The unique identifier of the primary address. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RawFaxNumber: string
Title:
Raw Fax Number
Maximum Length:60
The unformatted fax number information. -
RawHomePhoneNumber: string
Title:
Raw Home Phone Number
Maximum Length:60
Unformatted home phone number information. -
RawMobileNumber: string
Title:
Raw Mobile Number
Maximum Length:60
The unformatted mobile phone number information. -
RawPhoneNumber: string
Title:
Overall Primary Formatted Phone Number
Maximum Length:60
The raw phone number on the contact point record of type phone. -
RawWorkPhoneNumber: string
Title:
Raw Work Phone Number
Maximum Length:60
The unformatted work phone number information. -
RecordSet: string
Title:
Record Set
Maximum Length:30
The search results displayed under the selected record set. -
RegistrationStatus: string
Title:
Registration Status
Maximum Length:30
The code indicating the registration status of the contact. For example, Approved, Pending, or Rejected. The valid list of values is defined in the lookup ORA_CONTACT_REG_STATUS. -
Relationship: array
Relationships
Title:
Relationships
The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the roles played by a contact in the buying process, for example, decision maker or supporting role. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_BUY_ROLE_CODE. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesProfileNumber: string
Title:
Sales Account Number
Maximum Length:30
The unique identifier for the sales profile. -
SalesProfileStatus: string
Title:
Status
Maximum Length:30
A valid user defined status of the sales account. -
SalesTeamMember: array
Sales Account Resources
Title:
Sales Account Resources
Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SalutoryIntroduction: string
Title:
Prefix
Maximum Length:30
The title or a salutary introduction for a contact, such as Mr., Herr, and so on. A list of accepted values is defined in the lookup CONTACT_TITLE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SellToPartySiteId: integer
(int64)
Title:
Sell to Address
Read Only:true
The system identifier for the site address of type sell to. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceObjectType: string
Read Only:
true
Maximum Length:255
Default Value:SALES_PARTY_CONTACT
The type for the source object. -
SourceSystem: string
Title:
Party Source System
The name of external source system where the contact party is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReference: array
Source System References
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data. -
SourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier for the contact party from the external source system specified in the attribute SourceSystem. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
TaxpayerIdentificationNumber: string
Title:
Taxpayer Identification Number
Maximum Length:20
The taxpayer identification number, which is often a unique identifier of the contact. The typical values are taxpayer Id in USA or fiscal code or NIF in Europe. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
Time zone of a contact to know preferred time to call or email. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
Title:
Type
Maximum Length:30
The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
UniqueNameSuffix: string
Title:
Name Suffix
Maximum Length:540
The system generated or manually overridden suffix. The suffix is used to generate the PartyUniqueName attribute and is concatenated to the ContactName attribute to generate the PartyUniqueName. The primary address is defaulted as the suffix. -
UpdateFlag: boolean
Title:
Update Contact
Read Only:true
Indicates if the record can be updated. The default value is false. -
WorkPhoneAreaCode: string
Title:
Work Phone Area Code
Maximum Length:20
The area code for the contact's work phone. -
WorkPhoneContactPointType: string
Title:
Work Phone Type
Read Only:true
Maximum Length:30
Default Value:PHONE
The type of contact point for work phone. -
WorkPhoneContactPtId: string
Title:
Work Phone Contact Point Identifier
Read Only:true
The unique identifier of the work phone contact point for a contact. -
WorkPhoneCountryCode: string
Title:
Work Phone Country Code
Maximum Length:10
The international country code for a contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Work Phone Extension
Maximum Length:20
The additional number addressed after initial connection to an internal telephone system. -
WorkPhoneNumber: string
Title:
Work Phone Number
Maximum Length:40
The work phone number formatted in the local format without the area code, country code, or extension. -
WorkPhoneVerificationDate: string
(date)
Title:
Work Phone Verification Date
The date when work phone number was last verified. -
WorkPhoneVerificationStatus: string
Title:
Work Phone Verification Status
Maximum Length:30
The status code of the work phone number verification. The values based on lookup are valid and invalid for phone.
Nested Schema : Additional Identifiers
Type:
array
Title:
Additional Identifiers
The additional identifiers resource is used to view, create, update, and delete an additional identifiers such as driver's license number or passport number.
Show Source
Nested Schema : Additional Names
Type:
array
Title:
Additional Names
The additional name resource is used to view, create, update, and delete additional names associated with a contact. The resource allows you to capture other names associated with a contact, such as a maiden name, or a brand name.
Show Source
Nested Schema : Contact Addresses
Type:
array
Title:
Contact Addresses
The contact addresses resource is used to view, create, update, and delete addresses of a contact. An address contains the detailed location information of a contact.
Show Source
Nested Schema : Contact Attachments
Type:
array
Title:
Contact Attachments
The contact attachments resource is used to view, create, update, and delete attachments of a contact. An attachment includes additional information about a contact.
Show Source
Nested Schema : Contact Points
Type:
array
Title:
Contact Points
The contact point resource is used to view, create, update, and delete contact points for an account. Contact points can be geographical addresses, phone numbers, e-mail IDs, URLs, messenger IDs, and so on.
Show Source
Nested Schema : Contact Rollups
Type:
array
Title:
Contact Rollups
The contact rollups resource is used to view a contact rollup.
Show Source
Nested Schema : Aux Classifications
Type:
array
Title:
Aux Classifications
The aux classifications resource is used to view, create, update, and delete the auxiliary classifications of the customers associated with the contacts. Auxiliary classification enable you to categorize customers into different groups, such as commercial or private.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note resource is used to view, create, update, and delete notes associated with a contact. A note captures comments, information, or instructions related to a contact.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The contact picture attachments resource is used to view, create, update, or delete the contacts picture.
Show Source
Nested Schema : Contact Primary Addresses
Type:
array
Title:
Contact Primary Addresses
The primary addresses resource is used to view, create, update, and delete the primary addresses of the contacts. A primary address is the default communication address of a contact.
Show Source
Nested Schema : Relationships
Type:
array
Title:
Relationships
The relationships resource is used to view, create, and update contact relationships. A contact relationship is the interconnection between parties, such as employee or board member.
Show Source
Nested Schema : Sales Account Resources
Type:
array
Title:
Sales Account Resources
Sales account resources is used to view, create, update, and delete a resource party that is assigned to a sales account team. A sales account team member has a defined access role for the sales account.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Source System References
Type:
array
Title:
Source System References
The source system reference resource is used to view, create, update, and delete source systems. A source system is an external system from which you import data.
Show Source
Nested Schema : contacts-AdditionalIdentifier-item-response
Type:
Show Source
object
-
Country: string
Title:
Issuing Country
Maximum Length:2
The country code of the additional identifier. Review the list of country codes using the Manage Geographies task. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the additional identifier. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created this organization record. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Read Only:
true
The date when the additional identifier was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the additional identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
The date when the additional identifier will expire. -
IssueDate: string
(date)
Title:
Issue Date
The date when the additional identifier was issued. -
IssuingAuthorityName: string
Title:
Issuing Authority Name
Maximum Length:500
The name of the issuing authority of the additional identifier. -
IssuingAuthorityPartyId: integer
(int64)
The unique identifier of the issuing authority party.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the additional identifier was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the additional identifier. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the additional identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyIdentifierId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyIdentifierType: string
Title:
Identifier Type
Maximum Length:30
The type of the party identifier. -
PartyIdentifierValue: string
Title:
Identifier Value
Maximum Length:60
The value of the party identifier. -
PartyNumber: string
The party number of the additional identifier.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier of the relationship from external source system.
-
StateProvince: string
Title:
Issuing State
Maximum Length:60
Used for certain types of identifiers such as Passports or Driving licenses based on geography setup. -
StatusCode: string
Maximum Length:
1
Default Value:A
The status code of the additional identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : contacts-AdditionalName-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person's title that denotes the academic qualification, such as Dr. Jane Smith. -
ConflictId: integer
(int64)
Default Value:
0
The attribute value is used to guarantee the uniqueness of the row when duplicates are created in different databases. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the contact record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the contact record was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the Additional Name record -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of a person. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of a person. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the contact was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of a person. -
Name: string
Title:
Additional Name
Maximum Length:360
The name of the organization, person, or group party. For example, "Oracle" or "John Smith". -
NameId: integer
(int64)
Read Only:
true
The unique identifier of the name. -
NameType: string
Title:
Additional Name Type
Maximum Length:30
The type of the name. For example, ALIAS or LEGAL. -
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The public unique identifier of the party. -
PartySourceSystem: string
The source system name.
-
PartySourceSystemReferenceValue: string
The identifier for the record from the original system.
-
PreferredFlag: boolean
Title:
Preferred Indicator
Maximum Length:1
Default Value:false
Identify the name as preferred name for this party within this name type. Possible values are 'Y' and 'N'. Default is 'N'. -
SourceSystem: string
The name of the source system for the associated party.
-
SourceSystemReferenceValue: string
The identifier of the source system reference for the associated party.
-
StatusFlag: boolean
Maximum Length:
1
Default Value:true
The record status used to soft delete the record. The accepted values are A for active and I for inactive. The default value is A. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
TransliterationLanguage helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values: US,NL,DK etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Address-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressLocale: array
Address Locales
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language. -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The unique alternate identifier for the address. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified, then it is automatically generated. A list of accepted values is defined in the profile option ZCA_PUID_PREFIX concatenated with an internally generated unique sequence number. -
AddressPurpose: array
Contact Address Purposes
Title:
Contact Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address. -
AddressType: string
Title:
Type
The additional information as type of address like BillTo, ShipTo. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
CalculateFormattedAddress: boolean
The formatted address.
-
City: string
Title:
City
Maximum Length:60
The city element of the address. -
ClliCode: string
Title:
CLLI Code
Maximum Length:60
The Common Language Location Identifier (CLLI) code of the address. The code is used within the North American to specify the location of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CorpCurrencyCode: string
Title:
Corporate Currency
Maximum Length:15
The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the address record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreatedByModule1: string
Title:
Created by Application
Maximum Length:30
The user who created the module. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the address record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotMailFlag: boolean
Title:
Contact Preferences
Default Value:false
Indicates if this address should be used for mailing. If the value is True, then the address should not be used for mailing. The default value is False. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates that a particular location is not eligible for address validation regardless of the current Validation Status Code. -
DunsNumberC: string
Title:
D-U-N-S Number
Maximum Length:30
The D-U-N-S number of the business location. -
EffectiveDate: string
(date)
The date when the address becomes effective.
-
EndDateActive: string
(date)
Title:
End Date
Date on which this address is no longer active. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedAddress1: string
Title:
Formatted Address 1
Read Only:true
The formatted address of the contact address record. -
FormattedMultilineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
FormattedMultilineAddress1: string
Title:
Address
Read Only:true
The formatted address in multiline of the contact address record. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of building. A list of accepted values for this attribute is defined in the lookup HZ_HOUSE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the address data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the address record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the address record. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
Title:
Location ID
The unique identifier for this location. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
ObjectVersionNumber1: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated. -
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the contact to which the address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. The default value for PartyNumber is the value specified in the profile option ZCA_PUID_PREFIX concatenated with a unique generated sequence number. You can update the PartyNumber depending on the profile option HZ_GENERATE_PARTY_NUMBER. A list of accepted values is defined in the profile option HZ_GENERATE_PARTY_NUMBER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. -
PartySiteName: string
Title:
Site Name
Maximum Length:240
User-defined name for the address. -
PartySourceSystem: string
Title:
Party Source System
The name of external source system of the contact with which the address is associated. Part of Alternate Key for the contact record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the contact with which the address is associated. Part of Alternate Key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the contact record with which the address is associated. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if this is the primary address of the contact irrespective of the context. If the value is True, then the address is the primary address of the contact. The default value is False. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
The name of the table that holds the record data and is referenced to manage source system reference. -
SSRPartyOwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the party record data and is referenced to manage source system reference. -
StartDateActive: string
(date)
Title:
Start Date
Date on which this address becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
The status of the address. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStartDate: string
(date)
Read Only:
true
The date when the address validation started. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Address Locales
Type:
array
Title:
Address Locales
The address locales resource is used to view, create, update, and delete the local address. An address locale contains the details about a location or address in the local language.
Show Source
Nested Schema : Contact Address Purposes
Type:
array
Title:
Contact Address Purposes
The address purposes resource is used to view, create, update, and delete the address purpose. The address purpose describes the type of an address, such as a shipping address or a billing address.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Address-AddressLocale-item-response
Type:
Show Source
object
-
AddrElementAttribute1: string
Title:
Address Element Attribute 1
Maximum Length:150
The additional address element 1 to support flexible address format in local language. -
AddrElementAttribute2: string
Title:
Address Element Attribute 2
Maximum Length:150
The additional address element 2 to support flexible address format in local language. -
AddrElementAttribute3: string
Title:
Address Element Attribute 3
Maximum Length:150
The additional address element 3 to support flexible address format in local language. -
AddrElementAttribute4: string
Title:
Address Element Attribute 4
Maximum Length:150
The additional address element 4 to support flexible address format in local language. -
AddrElementAttribute5: string
Title:
Address Element Attribute 5
Maximum Length:150
The additional address element 5 to support flexible address format in local language. -
Address1: string
Title:
Address Line 1
Maximum Length:240
The first line of the address in the local language. -
Address2: string
Title:
Address Line 2
Maximum Length:240
The second line of the address in the local language. -
Address3: string
Title:
Address Line 3
Maximum Length:240
The third line of the address in the local language. -
Address4: string
Title:
Address Line 4
Maximum Length:240
The fourth line of the address in the local language. -
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of the following keys is used to identify the address purpose record during update: AddressId, AddressNumber, or SourceSystem and SourceSystemReferenceValue. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address in local language. -
City: string
Title:
City
Maximum Length:60
The specific name of the city in local language. -
Country: string
Title:
Country
Read Only:true
Maximum Length:2
The specific name of the country in local language. -
County: string
Title:
County
Maximum Length:60
The specific name of the county in local language. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address locale record. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address locale record was created. -
FloorNumber: string
Title:
Floor
Maximum Length:240
The specific floor number at a given address or a particular building when building number is provided in local language. -
FormattedAddress: string
Read Only:
true
The formatted read only version of the locale address. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address locale was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address locale record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address locale record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
The unique identifier of the location record.
-
LocationLocaleId: integer
(int64)
Read Only:
true
The unique identifier of the location locale record. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code of the locale. A postal code, known in various countries as a post code, postcode, or ZIP code, is a series of letters or digits appended to a postal address for the purpose of sorting mail in local language. -
PostalPlus4code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code in local language. -
Province: string
Title:
Province
Maximum Length:60
The name of the province in local language. -
SiteSourceSystem: string
The name of external source system for the parent address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the parent address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
State: string
Title:
State
Maximum Length:60
The name of the State in the local language. -
TransliterationLanguage: string
Title:
Transliteration Language
Maximum Length:4
Transliteration Language helps people pronounce words and names in foreign languages. It is validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Address-AddressPurpose-item-response
Type:
Show Source
object
-
AddressId: integer
(int64)
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update.
-
AddressNumber: string
Title:
Site Number
Read Only:true
Maximum Length:30
The unique address identifier that is internally generated during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address purpose record during update. -
AddressPurposeId: integer
(int64)
Read Only:
true
The unique identifier for the address purpose of an address. -
Comments: string
Title:
Comments
Maximum Length:2000
The user comments for the address purpose. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the address purpose record. -
CreatedByModule: string
Maximum Length:
30
Default Value:HZ_WS
The application module that created this address purpose record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. You can review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the address purpose record was created. -
DeleteFlag: boolean
Indicates if the address purpose for an address was deleted. If the value is True, then the address purpose is deleted. The default value is False.
-
EndDate: string
(date)
Title:
To Date
The date on which the address purpose is no longer valid. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the address purpose was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the address purpose record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the address purpose record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimaryPerType: string
Title:
Primary
Maximum Length:1
Default Value:N
Indicates if this is the primary use for the site. Y stands for the primary site and N stands for all other sites. -
Purpose: string
Title:
Purpose
Maximum Length:30
The purpose of the address. A list of valid values is defined in the lookup PARTY_SITE_USE_CODE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
SiteSourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SiteSourceSystemReferenceValue: string
The unique identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystem: string
The name of external source system for the address purpose denoted by a code, which is defined by an administrator as part of system setup. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address purpose.
-
SourceSystemReferenceValue: string
The unique identifier for the address purpose from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDate: string
(date)
Title:
From Date
The date from which the address purpose is valid. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates whether the address purpose is still valid for the associated address record. The value A indicates active and I indicates inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Attachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data. For example, a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-ContactPoint-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
ContactPointId: integer
(int64)
Read Only:
true
The unique identifier of the contact point. -
ContactPointType: string
Title:
Type
Maximum Length:30
The type of the contact point. The type of contact point. A list of valid contact point types is defined in the lookup COMMUNICATION_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Contact Point Lookups. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Application
Default Value:HZ_WS
The user who created the module. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DoContactPreferenceFlag: boolean
Title:
OK to Contact
Indicates whether to use a particular contact method. Defaulted to false. -
DoNotContactPreferenceFlag: boolean
The contact preference flag that indicates DNC option.
-
DoNotContactReason: string
The reason code for the contact preference.
-
EmailAddress: string
Maximum Length:
255
The email address of the contact point. -
EmailPurpose: string
Title:
Email Purpose
Maximum Length:30
The purpose of the email address. -
FormattedPhoneNumber: string
Read Only:
true
Maximum Length:255
The formatted phone number of the contact point. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the contact point was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the contact point. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the contact point. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement optimistic locking. This number is incremented every time the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
PartyId: integer
(int64)
The unique identifier of the party.
-
PartyNumber: string
The alternate unique identifier of the contact point.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The identifier for the record from an external source system.
-
PhoneAreaCode: string
Maximum Length:
255
The area code for the telephone number. -
PhoneCountryCode: string
Maximum Length:
255
The country code of the phone number. -
PhoneExtension: string
Maximum Length:
255
The extension number of the phone line number like office desk extension. -
PhoneNumber: string
Maximum Length:
255
The phone number of the contact point. -
PhonePurpose: string
Title:
Phone Purpose
Maximum Length:30
Defines the purpose of using the PHONE contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
PhoneType: string
The type of the phone. A list of valid phone types is defined in the lookup ORA_HZ_PHONE_TYPE. You can review and update the codes using the Setup and Maintenance task, Manage Standard Lookups.
-
PreferenceRequestedBy: string
Title:
Preference Requested By
Indicates if the permission or restriction was created internally or requested by the party. The list of accepted values are defined in the REQUESTED_BY lookup. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether the phone number is preferred. -
RawPhoneNumber: string
Maximum Length:
255
The phone number in raw format. -
SocialNetworkId: string
The unique identifier of the social network.
-
SocialNetworkName: string
The name of the social network.
-
SocialNetworkPurpose: string
Title:
Social Network Purpose
Maximum Length:30
Defines the purpose of using the IM contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE.Sample values: ASSISTANT,PERSONAL,HOME_BUSINESS,BUSINESS etc. -
SourceSystem: string
The name of external source system, which is defined by an admin as part of system setup. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
SourceSystemReferenceValue: string
The unique identifier for the contacts party from the external source system specified in the attribute SourceSystem. It is part of alternate key (along with SourceSystemReference), and is mandatory if PK or partyNumberBusinessKey is not passed in update.
-
Status: string
Maximum Length:
30
Default Value:A
The status of the contact point. -
URL: string
The URL associated with the contact point.
-
VerificationDate: string
(date)
Title:
Verification Date
The date of verification of the phone or email contact point. -
VerificationStatus: string
Title:
Verification Status
Maximum Length:30
The status of the verification for phone or email contact points. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. The value ORA_PARTIALLY_VALID is applicable only for email. Default value is blank which indicates that values aren't verified. -
WebPurpose: string
Title:
Web Purpose
Maximum Length:30
Defines the purpose of using the WEB contact point. The accepted values are defined in the lookup type CONTACT_POINT_PURPOSE_WEB.Sample values: HOMEPAGE,SALESURL,MARKETINGURL,SUPPORTURL,RSS_FEED etc.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-ContactRollup-item-response
Type:
Show Source
object
-
CallsMade: number
Title:
Calls Made
Read Only:true
The total number of calls made to a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency
Read Only:true
Maximum Length:15
The corporate currency code associated with the contact rollup such as USD or INR. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the contact rollup. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the contact rollup was created. -
EmailsSent: number
Title:
Emails Sent
Read Only:true
The total number of emails sent to a contact. -
LastCallMadeDate: string
(date-time)
Title:
Last Call Made
Read Only:true
The date when last call was made to a contact. -
LastCompletedActivity: string
(date-time)
Title:
Last Completed Activity
Read Only:true
The date when the activity was last completed with a contact. Activity includes task, appointment, and call report. -
LastEmailSentDate: string
(date-time)
Title:
Last Email Sent
Read Only:true
The date when last email was sent to a contact. -
LastResponse: string
(date-time)
Title:
Last Response Date
Read Only:true
The date when a last email or call was received from a contact. -
LastTouchDate: string
(date-time)
Title:
Last Touch
Read Only:true
The date when the last email was sent or call was made to a contact. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the contact rollup was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the contact rollup. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the contact rollup. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextTaskDue: string
(date)
Title:
Next Task Due
Read Only:true
The due date of the task with a contact. -
NumberOfOpenActivities: number
Title:
Number of Open Activities
Read Only:true
The total number of activities that are open for a contact. -
NumberOfOpenCriticalServiceRequests: number
Title:
Critical Open Service Requests
Read Only:true
The number of open service requests with severity equal to one that are associated with a contact. -
NumberOfOpenHotLeads: number
Title:
Hot Leads
Read Only:true
The number of leads that are open and are ranked hot. -
NumberOfOpenLeads: number
Title:
Open Leads
Read Only:true
The total number of leads that are open for the contact. -
NumberOfOpenOpportunities: number
Title:
Open Opportunities
Read Only:true
The number of open opportunities associated with a contact. -
NumberOfOpenServiceRequests: number
Title:
Open Service Requests
Read Only:true
The number of open service requests associated with a contact. -
NumberOfResponses: number
Title:
Responses
Read Only:true
The total number of calls or emails received from a contact. -
NumberOfTouches: number
Title:
Touches
Read Only:true
The total number of emails sent or calls made to a contact. -
PersonProfileId: integer
(int64)
Title:
Person Profile Identifier
Read Only:true
The unique identifier of the person profile. -
SumOfOpenOpportunitiesRevenue: number
Title:
Open Opportunities Revenue
Read Only:true
The cumulative total of revenues from open opportunities associated with a contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-CustomerClassification-item-response
Type:
Show Source
object
-
ClassCategory: string
Title:
Classification Category
Maximum Length:30
The name of the classification category. -
ClassCode: string
Title:
Classification Code
Maximum Length:30
The code indicating the classification category of the customer. For example, High Technology, Customer, or Telecom. -
CodeAssignmentId: integer
(int64)
Title:
Code Assignment ID
Read Only:true
The unique identifier for the customer classification assignment. -
ConflictId: integer
(int64)
Read Only:
true
Default Value:0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Title:
Created by Module
Maximum Length:30
The application module that created the customer classification. Defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDateActive: string
(date)
Title:
End Date
The date from which the classification code is no longer valid. -
IsAuxClassificationFlag: boolean
Title:
Auxiliary Classification Status
Read Only:true
Indicates whether the classification category is an user-defined group classification category. The default value is false. -
IsIndustryFlag: boolean
Title:
Industry Type Status
Read Only:true
Indicates whether the classification category is an industry group classification category. The default value is false. -
IsOrgTypeFlag: boolean
Title:
Organization Type Status
Read Only:true
Indicates whether the classification category is an organization type classification category. The default value is false. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
Title:
Party ID
The unique Identifier of the account, contact or household with which the classification is associated. -
PartyNumber: string
Title:
Party Number
Maximum Length:30
The unique alternate identifier of the account, contact, or household with which the classification is associated. -
PartySourceSystem: string
Title:
Party Source System
The name of the external source system of the account, contact, or household with which the classification is associated. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The unique identifier from external source system for the account, contact or household with which the classification is associated. -
PartyType: string
Title:
Party Type
Read Only:true
Maximum Length:30
The type of the party, such as account, contact, or household. -
PrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates if the customer classification is the primary classification. The default value is false. -
SourceSystem: string
Title:
Source System
The name of external source system where the customer classification is imported from. The values are configured in Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SourceSystemReferenceValue: string
Title:
Source System Reference Value
The unique identifier for the customer classification in the external source. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the customer classification was created. -
Status: string
Title:
Status
Maximum Length:1
Default Value:A
Indicates if the code assignment is active or inactive. The code assignment is active if the value is A, and inactive if the value is I.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the note creator's party. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique Identifier of the note associated with the contact. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code used to classify a note, as asset or adjustment. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the contact to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of a contact party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, etc. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-PictureAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the type of data. For example, a web page. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-PrimaryAddress-item-response
Type:
Show Source
object
-
Addressee: string
Title:
Addressee
Maximum Length:360
The addressee of the primary address. -
AddressElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
The additional address element to support flexible address format. -
AddressElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
The additional address element to support flexible address format. -
AddressId: integer
(int64)
Read Only:
true
The unique identifier for the address that is generated internally during create. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. -
AddressLine1: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLine2: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressLine3: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLine4: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address. -
AddressLinesPhonetic: string
Title:
Address Lines Phonetic
Maximum Length:560
The phonetic or kana representation of the Kanji address lines (used in Japan). -
AddressNumber: string
Title:
Site Number
Maximum Length:30
The alternate key identifier of the address that is internally generated during create. The AddressNumber is auto-generated when the contact is created, and is not required to be in the request payload when creating a contact. One of AddressId, AddressNumber or SourceSystem and SourceSystemReferenceValue keys is used to identify the address record during update. If not specified during creating the contact, then it is automatically generated using a list of accepted values from the profile option ZCA_PUID_PREFIX, and concatenated with an internally generated unique sequence number. -
Building: string
Title:
Building
Maximum Length:240
The specific building name or number at a given address. -
City: string
Title:
City
Maximum Length:60
The city element of the primary address. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the address. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. -
CorpCurrencyCode: string
Maximum Length:
15
The corporate currency code associated with the addresses. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table. -
County: string
Title:
County
Maximum Length:60
The county element of Address. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the address record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the address record was created. -
CurcyConvRateType: string
Maximum Length:
30
The currency conversion rate type associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the address. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DateValidated: string
(date)
Title:
Validated Date
The date when the address was last validated. -
DeleteFlag: boolean
Title:
Delete Primary Address
Indicates if the primary address was deleted. If the value is True, then the primary address is deleted. The default value is False. -
Description: string
Title:
Description
Maximum Length:2000
An extensive description of the location of the address. -
DoNotValidateFlag: boolean
Title:
Don't Validate
Maximum Length:1
Indicates the contact preference to indicate DNC option. -
EndDateActive: string
(date)
Title:
To Date
The last date for a record in active status. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The specific floor number at a given address or in a particular building when building number is provided. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address information. -
FormattedMultiLineAddress: string
Title:
Address
Read Only:true
The formatted multiple line address information. -
HouseType: string
Title:
House Type
Maximum Length:30
The type of the building mentioned in the address. A list of valid values are defined in the lookup HZ_HOUSE_TYPE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the address data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the address record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the address record. -
Latitude: number
Title:
Latitude
Used to store latitude information for the location for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationComments: string
Title:
Comments
Maximum Length:2000
The additional information for the record in free text format. -
LocationDirections: string
Title:
Location Directions
Maximum Length:640
The directions to the location. -
LocationId: integer
(int64)
The unique identifier for this location.
-
LocationIntegrationKey: string
The integration key for the location record.
-
LocationLocationId: integer
(int64)
Title:
Location ID
The system identifier for the location record. -
LocationSourceSystem: string
The name of source system for the location record.
-
LocationSourceSystemReferenceValue: string
The unique source system identifier value.
-
LocationStatusFlag: boolean
Maximum Length:
1
Default Value:true
The status flag for location record. -
Longitude: number
Title:
Longitude
Used to store longitude information for the location for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
A user-defined code to indicate a mail drop point within their organization. -
ObjectVersionNumberLocation: integer
(int32)
The internal version number for the location object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumberPartySite: integer
(int32)
The internal version number for the party site object. The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OverallPrimaryFlag: boolean
Title:
Primary
Maximum Length:1
Default Value:false
Indicates whether this is the primary address of the associated object. If the value is Y, then the address is a primary address. -
PartyId: integer
(int64)
The unique Identifier of the contact to which the primary address is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the contact record with which the address is associated.
-
PartySiteName: string
Title:
Site Name
Maximum Length:240
The name of party site. -
PartySiteType: string
Title:
One-Time Address
Maximum Length:30
The type information of the party site. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four digit extension to the United States Postal ZIP code. -
Province: string
Title:
Province
Maximum Length:60
The province element of Address. -
ShortDescription: string
Title:
Short Description
Maximum Length:240
The brief free text that describes the site record. -
SourceSystem: string
The name of external source system for the address denoted by a code, which is defined by an administrator as part of system setup. The value of SourceSystem should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
SourceSystemReferenceValue: string
The identifier for the address from the external source. SourceSystem and SourceSystemReference combination is unique and is used as the foreign key to identify an address.
-
StartDateActive: string
(date)
Title:
From Date
The date on which the record becomes active. -
State: string
Title:
State
Maximum Length:60
The state element of Address. -
Status: string
Maximum Length:
1
Default Value:A
The status of the record. -
TimezoneCode: string
Title:
Time Zone
Maximum Length:64
The time zone for the location. -
ValidatedFlag: boolean
Title:
Validated
Maximum Length:1
Default Value:false
Indicates if the location was validated. If the value is True, then the location is validated. The default value is False. The value is internally set by system during address cleansing. -
ValidationStatusCode: string
Title:
Validation Status
Maximum Length:30
The code indicating the status of the validation. Internally set by system during address cleansing.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-Relationship-item-response
Type:
Show Source
object
-
BackwardRole: string
Title:
Backward Role
Read Only:true
The backward relationship code used to describe relationships. For example, SUPPLIER_OF. -
Comments: string
Title:
Comments
Maximum Length:2000
User comments for the relationship. -
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the relationship record. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the relationship record. The default value for CreatedByModule is HZ_WS for all Web service based creation. A list of accepted values is defined in the lookup type HZ_CREATED_BY_MODULES. Review and update the value for this attribute using the Setup and Maintenance task work area, Manage Trading Community Common Lookups task. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the relationship record was created. -
DependentFlag: string
Title:
Dependent Indicator
Maximum Length:1
Default Value:N
Indicates whether one party is a dependent on another. -
DirectionCode: string
Read Only:
true
Maximum Length:30
The record validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional. -
EndDate: string
(date)
Title:
To Date
The date when the relationship ends. -
HeadOfHouseholdFlag: string
Title:
Head of Household Indicator
Maximum Length:1
Default Value:N
Indicates whether a person is the head of the household that he belongs to. -
InfluenceLevel: string
Title:
Influence Level
The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None. -
JobDefinitionName: string
Maximum Length:
100
The definition of the job name. -
JobDefinitionPackage: string
Maximum Length:
900
The definition of the job package. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the relationship data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the relationship record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the relationship record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectPartyId: integer
(int64)
The primary key identifier of the contact, in this relationship. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship.
-
ObjectPartyName: string
Title:
Object Party Name
Read Only:true
Maximum Length:360
The name of the object party of the relationship. -
ObjectPartyNumber: string
Title:
Object Registry ID
Maximum Length:30
The unique alternate identifier for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. -
ObjectSourceSystem: string
Title:
Object Source System
The name of external source system for the contact party in the relationship, which are defined by an admin as part of system setup. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the object party of the relationship. A list of accepted values should be pre-defined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
ObjectSourceSystemReferenceValue: string
Title:
Object Source System Reference
The unique identifier from external source system for the relationship of the contact party. One of ObjectPartyId, ObjectPartyNumber and ObjectSourceSystem along with ObjectSourceSystemReferenceValue combination is used to identify the contact party of the relationship. -
ObjectTableName: string
Maximum Length:
30
The source table name of the object party in this relationship. -
ObjectType: string
Maximum Length:
30
The object type of the contact. -
ObjectUsageCode: string
Maximum Length:
30
The usage code of object party in the relationship. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The attribute is used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was last queried. -
ObjectVersionNumber2: integer
(int32)
Read Only:
true
The number to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried. -
PartyId: integer
(int64)
Read Only:
true
The unique identifier of the party. -
PartyId1: integer
(int64)
Read Only:
true
The alternate unique identifier of the party. -
PercentageOwnership: number
Title:
Ownership Percentage
The percentage of the child entity owned by the parent entity. -
PreferredContactFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this contact person is primary contact for the customer. Accepted values are Y and N. Default value is N. -
PrimaryCustomerFlag: boolean
Maximum Length:
10
Default Value:false
Indicates whether this customer is primary customer for the contact. Accepted values are Y and N. Default value is N. -
RelationshipCode: string
Title:
Relationship Code
Maximum Length:30
The code indicating whether the relationship is a forward or a backward relationship. A list of accepted relationship values is defined in the lookup PARTY_RELATIONS_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups. -
RelationshipId: integer
(int64)
Read Only:
true
The unique identifier of the relationship. -
RelationshipRecId: integer
(int64)
The unique identifier of the relationship record.
-
RelationshipSourceSystem: string
The name of external source system for the relationship, which are defined by an Admin as part of system setup.
-
RelationshipSourceSystemReferenceValue: string
The unique identifier of the relationship from the external source system.
-
RelationshipType: string
Title:
Relationship Type
Maximum Length:30
The type of relationship of a contact party, such as CUSTOMER_SUPPLIER. A list of accepted relationship type values is defined in the lookup HZ_RELATIONSHIP_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Relationship Lookups task. -
RequestId: integer
(int64)
The unique identifier of the request.
-
Role: string
Title:
Role
The role between the subject and object party. -
SSROwnerTableName: string
Read Only:
true
Maximum Length:255
Default Value:HZ_PARTIES
The name of the table that holds the record data and is referenced to manage source system reference. -
StartDate: string
(date)
Title:
From Date
Date on which this relationship becomes active. -
Status: string
Read Only:
true
Maximum Length:1
Default Value:A
The status of the relationship. Indicates if this is an active or inactive relationship. The values A indicate an active relationship and I an inactive relationship. This is an internal column and user is not expected to pass in a value. A list of accepted values is defined in the lookup HZ_STATUS. Review and update the values for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SubjectPartyId: integer
(int64)
The primary key identifier of the subject in this relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship.
-
SubjectPartyName: string
Title:
Subject Party Name
Read Only:true
Maximum Length:360
The name of the subject party. -
SubjectPartyNumber: string
Title:
Subject Registry ID
Maximum Length:30
The alternate unique identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. -
SubjectSourceSystem: string
Title:
Subject Source System
The name of external source system for the subject party in the relationship, which are defined by an Admin as part of system setup. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. A list of accepted values should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Source Systems task. -
SubjectSourceSystemReferenceValue: string
Title:
Subject Source System Reference
The unique identifier from external source system for the subject party in the relationship. One of SubjectPartyId, SubjectPartyNumber and SubjectSourceSystem along with SubjectSourceSystemReferenceValue combination is used to identify the subject party of the relationship. -
SubjectTableName: string
Maximum Length:
30
The source table of the subject. -
SubjectType: string
Maximum Length:
30
The subject type of the contact. -
SubjectUsageCode: string
Maximum Length:
30
The usage code of subject party in the contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-SalesTeamMember-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the sales team member record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the sale team member record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
Date on which this sales team member is no longer active. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the sales team member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales team member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the sales team member record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner of the contract. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The unique identification number for the party.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the household resource. -
ResourceName: string
Title:
Resource Name
Read Only:true
The name of the sales team member. -
ResourceOrgName: string
Read Only:
true
The name of the organization that the sales team member belongs to. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
ResourcePhoneNumber: string
Title:
Phone
Read Only:true
The primary phone number of the sales team member. -
ResourceRoleName: string
Title:
Role
Read Only:true
The names of the roles assigned to the sales team member. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales profile of the resource. -
StartDateActive: string
(date)
Title:
Start Date
Date on which this sales team member becomes active. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the sales team member. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-smartActions-item-response
Type:
Show Source
object
-
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:1024
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:150
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : contacts-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:250
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:50
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:80
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contacts-SourceSystemReference-item-response
Type:
Show Source
object
-
ConflictId: integer
(int64)
Default Value:
0
The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreatedByModule: string
Default Value:
HZ_WS
The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
EndDate: string
(date)
The date after which the record is inactive.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is comparedat the start and end of a transaction to determine whether another session has updated the row.
-
PartyId: integer
(int64)
The unique identifier of the associated contact.
-
PartyNumber: string
Title:
Party Number
The alternate unique identifier of the associated contact. -
PartySourceSystem: string
Title:
Party Source System
The source system name for the contact. -
PartySourceSystemReferenceValue: string
Title:
Party Source System Reference Value
The identifier for the record from an external source system. -
SourceSystem: string
Title:
Source System
Maximum Length:30
The name of the source system. -
SourceSystemReferenceId: integer
(int64)
Read Only:
true
The unique identifier of the source system reference. -
SourceSystemReferenceValue: string
Maximum Length:
255
The source system reference value required to identify the associated contact. -
StartDate: string
(date)
The date when the record was created.
-
Status: string
Maximum Length:
1
Default Value:A
Indicates of the mapping to the source system is active. If the value is A, then the mapping is active. If the value is I, then the mapping is inactive.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AdditionalIdentifier
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- AdditionalName
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- Address
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- Attachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- CertificationLevelLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_LEVEL
- finder:
- CertificationReasonCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_REASON
- finder:
- ContactPoint
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- ContactRoleLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_CONTACT_ROLE
- finder:
- ContactRollup
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The name of the country associated with the contact. - finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder%3BBindEnabledFlag%3DY
- finder:
- CustomerClassification
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- DataCloudStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDATA_CLOUD_STATUS
- finder:
- DepartmentCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDEPARTMENT_TYPE
- finder:
- DoCallHomePhoneLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
Indicates whether the user can call the primary contact phone of type home of a contact. The accepted values are True and False or Y and N. Default is False or N. - finder:
- DoCallMobilePhoneLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
Indicates whether the user can call the primary contact phone of type mobile of a contact. The accepted values are True and False or Y and N. Default is False or N. - finder:
- DoCallWorkPhoneLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
Indicates whether the user can call the primary contact phone of type work of a contact. The accepted values are True and False or Y and N. Default is False or N. - finder:
- DoContactEmailLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
Indicates whether the user can contact using the primary email of a contact. The accepted values are True and False or Y and N. Default is False or N. - finder:
- DoContactFaxLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
Indicates whether the user can contact using the primary fax of a contact. The accepted values are True and False or Y and N. Default is False or N. - finder:
- DoNotCallFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotCallHomePhoneLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values that indicate DO NOT call preference for the primary home phone. The values can be True or False. Default value is False. - finder:
- DoNotCallMobileLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values that indicate DO NOT call preference for the primary mobile. The values can be True or False. Default value is False. - finder:
- DoNotCallWorkPhoneLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values that indicate DO NOT call preference for the primary work phone. The values can be True or False. Default value is False. - finder:
- DoNotContactEmailLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values that indicate DO NOT call preference for the primary email. The values can be True or False. Default value is False. - finder:
- DoNotContactFaxLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
The list of values that indicate DO NOT call preference for the primary fax. The values can be True or False. Default value is False. - finder:
- DoNotContactFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotEmailFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotMailFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- EmailVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{EmailVerificationStatus}
The list of acceptable values indicating the verification status of the email. - finder:
- FaxCountryCodeLOV
- FaxVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{FaxVerificationStatus}
The list of acceptable values indicating the verification status of the fax. - finder:
- GenderLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_GENDER
- finder:
- HomePhoneCountryCodeLOV
- HomePhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{HomePhoneVerificationStatus}
The list of acceptable values indicating the verification status of the home phone. - finder:
- JobTitleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DRESPONSIBILITY
- finder:
- MaritalStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DMARITAL_STATUS
- finder:
- MobileCountryCodeLOV
- MobileVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{MobileVerificationStatus}
The list of acceptable values indicating the verification status of the mobile phone. - finder:
- Note
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- PersonPreNameAdjunctLookupVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCONTACT_TITLE
- finder:
- PictureAttachment
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- PreferredContactMethodLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD
- finder:
- PrimaryAddress
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- RatedCurrenciesLOV
- RegistrationStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_CONTACT_REG_STATUS
- finder:
- Relationship
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- RentOwnIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DOWN_RENT_IND
- finder:
- SalesAffinityCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE
- finder:
- SalesBuyingRoleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
- finder:
- SalesProfileStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_SALES_ACCOUNT_STATUS
- finder:
- SalesProfileTypeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_CONTACT_TYPE
- finder:
- SalesTeamMember
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- SearchFilters
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_CONTACT_SEARCH_REC_SET
- finder:
- SourceSystemReference
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber:
- StatusLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_STATUS
- finder:
- TimezoneVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_TIMEZONE_CODES
The time zone associated with the contact. - finder:
- WorkPhoneCountryCodeLOV
- WorkPhoneVerificationStatusLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HZ_VALIDATION_STATUS%2CLookupCode%3D{WorkPhoneVerificationStatus}
The list of acceptable values indicating the verification status of the work phone. - finder:
- smartActions
-
Parameters:
- PartyNumber:
$request.path.PartyNumber
- PartyNumber: