Get all contacts

get

/crmRestApi/resources/11.13.18.05/contacts

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ContactPartyNumberRF: Finds contacts by party number.
      Finder Variables:
      • PartyNumber; string; The unique primary identifier for the contact party.
    • MyBusinessContacts: Finds a contact from My Business Contacts.
      Finder Variables:
      • MyContacts: Finds a contact from My Contacts.
        Finder Variables:
        • BindUserPartyId; integer; The unique identifier of the contact.
      • MyFavoriteContacts: Finds a contact from My Favorite Contacts.
        Finder Variables:
        • PrimaryKey: Finds a contact with the specified primary key.
          Finder Variables:
          • PartyId; integer; The unique identifier of the contact.
          • PersonProfileId; integer; The unique identifier of the contact.
        • SourceSystemReferenceAltKey: Finds contacts with the source system information.
          Finder Variables:
          • SourceSystem; string; The name of external source system where the contact party is imported from.
          • SourceSystemReferenceValue; string; The unique identifier for the contact party from the external source system.
      • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
      • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

        Example:
        self,canonical
      • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
      • The resource item payload will be filtered in order to contain only data (no links section, for example).
      • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
      • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

        Format: ?q=expression1;expression2

        You can use these queryable attributes to filter this collection resource using the q query parameter:
        • AcademicTitle; string; The part of the person???s title that denotes their academic qualification, such as Dr. Jane Smith.
        • AccountName; string; The name of the sales account that this contact belongs to.
        • AccountPartyId; integer; 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; 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; 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; 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; The unique name of the primary account. The default value is the concatenation of attributes AccountName and UniqueNameSuffix.
        • AddressElementAttribute1; string; The additional address element to support flexible address format.
        • AddressElementAttribute2; string; The additional address element to support flexible address format.
        • AddressElementAttribute3; string; The additional address element to support flexible address format.
        • AddressElementAttribute4; string; The additional address element to support flexible address format.
        • AddressElementAttribute5; string; The additional address element to support flexible address format.
        • AddressLine1; string; The first line for address.
        • AddressLine2; string; The second line for address.
        • AddressLine3; string; The third line for address.
        • AddressLine4; string; The fourth line for address.
        • AddressLinesPhonetic; string; The phonetic or kana representation of the Kanji address lines (used in Japan).
        • AddressNumber; string; 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.
        • Building; string; The specific building name or number at a given address.
        • CertificationLevel; string; 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; 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; The city element of the contact.
        • Comments; string; The textual comments about a contact.
        • ConflictId; integer; The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
        • ContactIsPrimaryForAccount; string; The primary contact associated with an account.
        • ContactName; string; The derived name of the contact.
        • ContactRole; string; The name of the role of the contact.
        • ContactUniqueName; string; 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; The country code of the address. This attribute is defined in the TERRITORY_CODE column in the FND_TERRITORY table.
        • County; string; The county of the primary address.
        • CreatedBy; string; The user who created the contact record.
        • CreationDate; string; The date and time when the contact record was created.
        • DataCloudStatus; string; 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; The date when the person was born.
        • DateOfDeath; string; The date when the person died.
        • DeceasedFlag; boolean; 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; The declared ethnicity of the person.
        • Department; string; The name the department of the contact.
        • DepartmentCode; string; 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.
        • DoNotCallFlag; boolean; 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.
        • DoNotContactFlag; boolean; 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; 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; 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; The e-mail address of the contact point.
        • EmailContactPointType; string; The type of contact point for email address.
        • EmailFormat; string; 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.
        • FavoriteContactFlag; boolean; 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; The area code for the fax number.
        • FaxContactPointType; string; The type of contact point for fax.
        • FaxCountryCode; string; The international country code for a telephone number, such as 33 for France.
        • FaxExtension; string; The additional number addressed after initial connection to an internal telephone system.
        • FaxNumber; string; A telephone number formatted in the local format without the area code, country code, or extension.
        • FirstName; string; The first name of the person.
        • FloorNumber; string; The specific floor number at a given address or in a particular building when building number is provided.
        • Gender; string; 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; 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; The area code for the contact's home phone number.
        • HomePhoneContactPointType; string; The type of contact point for home phone.
        • HomePhoneCountryCode; string; The international country code for a telephone number, such as 33 for France.
        • HomePhoneNumber; string; The home phone number formatted in the local format without the area code, country code, or extension.
        • HouseholdIncomeAmount; number; The income of the household that this person is a part of.
        • HouseholdSize; number; The size of the household this person is a part of.
        • Initials; string; The initials of the contact???s name.
        • JobTitle; string; The job title of the contact.
        • JobTitleCode; string; 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; The date when the sales account territory assignment was last run by assignment manager.
        • LastContactDate; string; The date when the contact was last contacted.
        • LastEnrichmentDate; string; The date when the contact record was last enriched with data from external sources by using Data-as-a-Service.
        • LastKnownGPS; string; Last known location of the contact. Mostly based on GPS enabled device used by contact.
        • LastName; string; The last name of the person.
        • LastNamePrefix; string; 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; The date and time when the contact was last updated.
        • LastUpdateLogin; string; The session login associated to the user who last updated the contact record.
        • LastUpdatedBy; string; The user who last updated the contact record.
        • Mailstop; string; A user-defined code to indicate a mail drop point within their organization.
        • MaritalStatus; string; 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; The date when the person's marital status was changed.
        • MiddleName; string; The middle name of the person.
        • MobileAreaCode; string; The area code for the contact's mobile phone.
        • MobileContactPointType; string; The type of contact point for mobile.
        • MobileCountryCode; string; The international country code for a contact???s mobile phone number, such as 33 for France.
        • MobileExtension; string; The additional number addressed after initial connection to an internal telephone system.
        • MobileNumber; string; The mobile phone number formatted in the local format. The number should not include area code, country code, or extension.
        • NameSuffix; string; The part of the name appended to a person's name. For example, the III in Tom Jones III.
        • NamedFlag; boolean; 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.
        • OwnerEmailAddress; string; 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; The name of the sales account owner.
        • OwnerPartyId; integer; 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; 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; 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; 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. Inactive records can't be updated.
        • PartyNumberKey; string; The alternate unique identifier of the record.
        • PartyStatus; string; 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; The type of the party.
        • PersonProfileId; integer; The unique identifier of the person's profile.
        • PersonalIncomeAmount; number; The estimated gross annual income of the person.
        • PlaceOfBirth; string; The place where the person was born, such as city or country.
        • PostalCode; string; The postal code of the address.
        • PostalPlus4Code; string; The four digit extension to the United States Postal ZIP code.
        • PreferredContactMethod; string; 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; 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; The previous last name or surname of the person.
        • PrimaryAddressId; integer; The unique identifier of the primary address.
        • Province; string; The province of the address.
        • RawFaxNumber; string; The unformatted fax number information.
        • RawHomePhoneNumber; string; Unformatted home phone number information.
        • RawMobileNumber; string; The unformatted mobile phone number information.
        • RawPhoneNumber; string; The raw phone number on the contact point record of type phone.
        • RawWorkPhoneNumber; string; The unformatted work phone number information.
        • RecordSet; string; The search results displayed under the selected record set.
        • RegistrationStatus; string; 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.
        • RentOrOwnIndicator; string; 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; 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; 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; The unique identifier for the sales profile.
        • SalesProfileStatus; string; A valid user defined status of the sales account.
        • Salutation; string; The phrase used to address a contact party in any correspondence.
        • SalutoryIntroduction; string; 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; 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; The system identifier for the site address of type sell to.
        • SourceSystem; string; 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.
        • SourceSystemReferenceValue; string; The unique identifier for the contact party from the external source system specified in the attribute SourceSystem.
        • State; string; The state element of Address.
        • TaxpayerIdentificationNumber; string; 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; Time zone of a contact to know preferred time to call or email.
        • Title; string; A professional or family title, such as Don or The Right Honorable.
        • Type; string; 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; 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; The area code for the contact's work phone.
        • WorkPhoneContactPointType; string; The type of contact point for work phone.
        • WorkPhoneCountryCode; string; The international country code for a contact???s work phone number, such as 33 for France.
        • WorkPhoneExtension; string; The additional number addressed after initial connection to an internal telephone system.
        • WorkPhoneNumber; string; The work phone number formatted in the local format without the area code, country code, or extension.
      • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
      Header Parameters
      • 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".
      • 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.

      There's no request body for this operation.

      Back to Top

      Response

      Supported Media Types

      Default Response

      The following table describes the default response for this task.
      Headers
      • 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".
      • 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.
      Body ()
      Root Schema : contacts
      Type: object
      Show Source
      Nested Schema : Items
      Type: array
      Title: Items
      The items in the collection.
      Show Source
      Nested Schema : contacts-item-response
      Type: object
      Show Source
      • Title: Academic Title
        Maximum Length: 30
        The part of the person???s title that denotes their academic qualification, such as Dr. Jane Smith.
      • Title: Account
        Read Only: true
        Maximum Length: 360
        The name of the sales account that this contact belongs to.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • Title: Additional Address Element 1
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 2
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 3
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 4
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 5
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Address Line 1
        Maximum Length: 240
        The first line for address.
      • Title: Address Line 2
        Maximum Length: 240
        The second line for address.
      • Title: Address Line 3
        Maximum Length: 240
        The third line for address.
      • Title: Address Line 4
        Maximum Length: 240
        The fourth line for address.
      • Title: Address Lines Phonetic
        Maximum Length: 560
        The phonetic or kana representation of the Kanji address lines (used in Japan).
      • 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.
      • Title: Address Type
        Additional information as type of address like BillTo, ShipTo.
      • 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.
      • 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.
      • Title: Building
        Maximum Length: 240
        The specific building name or number at a given address.
      • 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.
      • 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.
      • Title: City
        Maximum Length: 60
        The city element of the contact.
      • Title: Classification Category
        A valid classification category code for the contact. This is defined by an admin and is marked as primary.
      • Title: Classification Code
        A valid classification code corresponding to the classification category, which is marked as primary.
      • Title: Comments
        Maximum Length: 2000
        The textual comments about a contact.
      • Default Value: 0
        The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
      • Title: Primary
        The primary contact associated with an account.
      • Title: Name
        Read Only: true
        Maximum Length: 450
        The derived name of the contact.
      • 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.
      • Title: Contact Role
        Maximum Length: 60
        The name of the role of the contact.
      • Contact Rollups
        Title: Contact Rollups
        The contact rollups resource is used to view a contact rollup.
      • 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.
      • 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.
      • Title: County
        Maximum Length: 60
        The county of the primary address.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the contact record.
      • 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.
      • Title: Creation Date
        Read Only: true
        The date and time when the contact record was created.
      • 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.
      • 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.
      • 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.
      • Title: Date of Birth
        The date when the person was born.
      • Title: Date of Death
        The date when the person died.
      • 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.
      • Title: Declared Ethnicity
        Maximum Length: 60
        The declared ethnicity of the person.
      • Title: Delete Contact
        Read Only: true
        Indicates if the contact can be deleted. The default value is false.
      • Title: Department
        Maximum Length: 60
        The name the department of the contact.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • Title: Email
        Maximum Length: 320
        The e-mail address of the contact point.
      • Title: Email Type
        Read Only: true
        Maximum Length: 30
        Default Value: EMAIL
        The type of contact point for email address.
      • Title: Email Contact Point Identifier
        Read Only: true
        The unique identifier of the email contact point for the contact.
      • 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.
      • Title: Email Verification Date
        The date when email address was last verified.
      • 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.
      • 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.
      • Title: Existing Indicator Last Update Date
        Read Only: true
        The date when the ExistingCustomerFlag was last modified. It is internally populated by the application.
      • 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.
      • Title: Fax Area Code
        Maximum Length: 20
        The area code for the fax number.
      • Title: Fax Type
        Read Only: true
        Maximum Length: 30
        Default Value: PHONE
        The type of contact point for fax.
      • Title: Fax Phone Contact Point Identifier
        Read Only: true
        The unique identifier of the fax phone contact point for the contact.
      • Title: Fax Country Code
        Maximum Length: 10
        The international country code for a telephone number, such as 33 for France.
      • Title: Fax Extension
        Maximum Length: 20
        The additional number addressed after initial connection to an internal telephone system.
      • Title: Fax Number
        Maximum Length: 40
        A telephone number formatted in the local format without the area code, country code, or extension.
      • Title: Fax Verification Date
        The date when fax number was last verified.
      • 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.
      • Title: First Name
        Maximum Length: 150
        The first name of the person.
      • Title: Floor Number
        Maximum Length: 40
        The specific floor number at a given address or in a particular building when building number is provided.
      • Title: Address
        Read Only: true
        The formatted version of the primary address.
      • Title: Formatted Fax Number
        Read Only: true
        The formatted fax number information.
      • Title: Home Phone
        Read Only: true
        The formatted home phone number information.
      • Title: Mobile Phone
        Read Only: true
        The formatted mobile phone number information.
      • Title: Work Phone
        Read Only: true
        The formatted work phone number information.
      • 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.
      • 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.
      • Title: Home Phone Area Code
        Maximum Length: 20
        The area code for the contact's home phone number.
      • Title: Home Phone Type
        Read Only: true
        Maximum Length: 30
        Default Value: PHONE
        The type of contact point for home phone.
      • Title: Home Phone Contact Point Identifier
        Read Only: true
        The unique identifier of the home phone contact point for a contact.
      • Title: Home Phone Country Code
        Maximum Length: 10
        The international country code for a telephone number, such as 33 for France.
      • Title: Home Phone Number
        Maximum Length: 40
        The home phone number formatted in the local format without the area code, country code, or extension.
      • Title: Home Phone Verification Date
        The date when home phone number was last verified.
      • 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.
      • Title: Household Income
        The income of the household that this person is a part of.
      • Title: Household Size
        The size of the household this person is a part of.
      • Title: Initials
        Maximum Length: 20
        The initials of the contact???s name.
      • Title: Job Title
        Maximum Length: 100
        The job title of the contact.
      • 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.
      • Title: Last Assigned Date
        Read Only: true
        The date when the sales account territory assignment was last run by assignment manager.
      • Title: Last Contact Date
        The date when the contact was last contacted.
      • Title: Last Enrichment Date
        The date when the contact record was last enriched with data from external sources by using Data-as-a-Service.
      • Title: Last Known Location
        Maximum Length: 60
        Last known location of the contact. Mostly based on GPS enabled device used by contact.
      • Title: Last Name
        Maximum Length: 150
        The last name of the person.
      • 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.
      • Title: Last Updated Date
        Read Only: true
        The date and time when the contact was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the contact record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The session login associated to the user who last updated the contact record.
      • Links
      • Title: Mail Stop
        Maximum Length: 60
        A user-defined code to indicate a mail drop point within their organization.
      • 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.
      • Title: Marital Status Effective Date
        The date when the person's marital status was changed.
      • Title: Middle Name
        Maximum Length: 60
        The middle name of the person.
      • Title: Mobile Area Code
        Maximum Length: 20
        The area code for the contact's mobile phone.
      • Title: Mobile Type
        Read Only: true
        Maximum Length: 30
        Default Value: PHONE
        The type of contact point for mobile.
      • Title: Mobile Country Code
        Maximum Length: 10
        The international country code for a contact???s mobile phone number, such as 33 for France.
      • Title: Mobile Extension
        Maximum Length: 20
        The additional number addressed after initial connection to an internal telephone system.
      • 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.
      • Title: Mobile Phone Contact Point Identifier
        Read Only: true
        The unique identifier of the mobile phone contact point for the contact.
      • Title: Mobile Verification Date
        The date when mobile phone number was last verified.
      • 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.
      • 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.
      • Title: Suffix
        Maximum Length: 30
        The part of the name appended to a person's name. For example, the III in Tom Jones III.
      • 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.
      • Title: Overall Primary Formatted Phone Number
        Read Only: true
        The formatted overall primary phone number.
      • Read Only: true
        The unique identifier of the primary phone contact.
      • 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.
      • Title: Owner
        Read Only: true
        Maximum Length: 360
        The name of the sales account owner.
      • 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.
      • 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.
      • 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.
      • 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. Inactive records can't be updated.
      • Title: Registry ID
        Maximum Length: 30
        The alternate unique identifier of the record.
      • 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.
      • Title: Party Type
        Read Only: true
        Maximum Length: 30
        Default Value: PERSON
        The type of the party.
      • Title: Annual Income
        The estimated gross annual income of the person.
      • Title: Contact ID
        Read Only: true
        The unique identifier of the person's profile.
      • Attachments
        Title: Attachments
        The contact picture attachments resource is used to view, create, update, or delete the contacts picture.
      • Title: Place of Birth
        Maximum Length: 60
        The place where the person was born, such as city or country.
      • Title: Postal Code
        Maximum Length: 60
        The postal code of the address.
      • Title: Postal Plus 4 Code
        Maximum Length: 20
        The four digit extension to the United States Postal ZIP code.
      • 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.
      • 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.
      • Title: Previous Last Name
        Maximum Length: 150
        The previous last name or surname of the person.
      • 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.
      • Read Only: true
        The unique identifier of the primary address.
      • Title: Province
        Maximum Length: 60
        The province of the address.
      • Title: Raw Fax Number
        Maximum Length: 60
        The unformatted fax number information.
      • Title: Raw Home Phone Number
        Maximum Length: 60
        Unformatted home phone number information.
      • Title: Raw Mobile Number
        Maximum Length: 60
        The unformatted mobile phone number information.
      • Title: Overall Primary Formatted Phone Number
        Maximum Length: 60
        The raw phone number on the contact point record of type phone.
      • Title: Raw Work Phone Number
        Maximum Length: 60
        The unformatted work phone number information.
      • Title: Record Set
        Maximum Length: 30
        The search results displayed under the selected record set.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • Title: Sales Account Number
        Maximum Length: 30
        The unique identifier for the sales profile.
      • Title: Status
        Maximum Length: 30
        A valid user defined status of the sales account.
      • 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.
      • Title: Salutation
        Maximum Length: 60
        The phrase used to address a contact party in any correspondence.
      • 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.
      • 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.
      • Title: Sell to Address
        Read Only: true
        The system identifier for the site address of type sell to.
      • 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.
      • Read Only: true
        Maximum Length: 255
        Default Value: SALES_PARTY_CONTACT
        The type for the source object.
      • 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.
      • 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.
      • Title: Party Source System Reference Value
        The unique identifier for the contact party from the external source system specified in the attribute SourceSystem.
      • Title: State
        Maximum Length: 60
        The state element of Address.
      • 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.
      • Title: Time Zone
        Maximum Length: 64
        Time zone of a contact to know preferred time to call or email.
      • Title: Title
        Maximum Length: 60
        A professional or family title, such as Don or The Right Honorable.
      • 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.
      • 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.
      • Title: Update Contact
        Read Only: true
        Indicates if the record can be updated. The default value is false.
      • Title: Work Phone Area Code
        Maximum Length: 20
        The area code for the contact's work phone.
      • Title: Work Phone Type
        Read Only: true
        Maximum Length: 30
        Default Value: PHONE
        The type of contact point for work phone.
      • Title: Work Phone Contact Point Identifier
        Read Only: true
        The unique identifier of the work phone contact point for a contact.
      • Title: Work Phone Country Code
        Maximum Length: 10
        The international country code for a contact???s work phone number, such as 33 for France.
      • Title: Work Phone Extension
        Maximum Length: 20
        The additional number addressed after initial connection to an internal telephone system.
      • Title: Work Phone Number
        Maximum Length: 40
        The work phone number formatted in the local format without the area code, country code, or extension.
      • Title: Work Phone Verification Date
        The date when work phone number was last verified.
      • 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 : contacts-AdditionalIdentifier-item-response
      Type: object
      Show Source
      • Title: Issuing Country
        Maximum Length: 2
        The country code of the additional identifier. Review the list of country codes using the Manage Geographies task.
      • Read Only: true
        Maximum Length: 64
        The user who created the additional identifier.
      • 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.
      • Read Only: true
        The date when the additional identifier was created.
      • Title: Description
        Maximum Length: 240
        The description of the additional identifier.
      • Title: Expiration Date
        The date when the additional identifier will expire.
      • Title: Issue Date
        The date when the additional identifier was issued.
      • Title: Issuing Authority Name
        Maximum Length: 500
        The name of the issuing authority of the additional identifier.
      • The unique identifier of the issuing authority party.
      • Read Only: true
        The date when the additional identifier was last updated.
      • Read Only: true
        Maximum Length: 64
        The user who last updated the additional identifier.
      • Read Only: true
        Maximum Length: 32
        The login of the user who last updated the additional identifier.
      • Links
      • 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.
      • The unique identifier of the party.
      • Read Only: true
        The unique identifier of the party.
      • Title: Identifier Type
        Maximum Length: 30
        The type of the party identifier.
      • Title: Identifier Value
        Maximum Length: 60
        The value of the party identifier.
      • The party number of the additional identifier.
      • 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.
      • The identifier for the record from an external source system.
      • 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.
      • The unique identifier of the relationship from external source system.
      • Title: Issuing State
        Maximum Length: 60
        Used for certain types of identifiers such as Passports or Driving licenses based on geography setup.
      • Maximum Length: 1
        Default Value: A
        The status code of the additional identifier.
      Nested Schema : contacts-AdditionalName-item-response
      Type: object
      Show Source
      Nested Schema : contacts-Address-item-response
      Type: object
      Show Source
      • Title: Additional Address Element 1
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 2
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 3
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 4
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 5
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Address Line 1
        Maximum Length: 240
        The first line for address.
      • Title: Address Line 2
        Maximum Length: 240
        The second line for address.
      • Title: Address Line 3
        Maximum Length: 240
        The third line for address.
      • Title: Address Line 4
        Maximum Length: 240
        The fourth line for address.
      • 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.
      • Title: Address Lines Phonetic
        Maximum Length: 560
        The phonetic or kana representation of the Kanji address lines (used in Japan).
      • 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.
      • 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.
      • 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.
      • Title: Type
        The additional information as type of address like BillTo, ShipTo.
      • Title: Building
        Maximum Length: 240
        The specific building name or number at a given address.
      • The formatted address.
      • Title: City
        Maximum Length: 60
        The city element of the address.
      • 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.
      • Title: Comments
        Maximum Length: 2000
        User comments for the address.
      • Default Value: 0
        The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
      • 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.
      • 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.
      • Title: County
        Maximum Length: 60
        The county element of Address.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the address record.
      • 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.
      • Title: Created by Application
        Maximum Length: 30
        The user who created the module.
      • Title: Creation Date
        Read Only: true
        The date and time when the address record was created.
      • 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.
      • 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.
      • Title: Validated Date
        The date when the address was last validated.
      • Title: Description
        Maximum Length: 2000
        An extensive description of the location of the address.
      • 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.
      • 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.
      • Title: D-U-N-S Number
        Maximum Length: 30
        The D-U-N-S number of the business location.
      • The date when the address becomes effective.
      • Title: End Date
        Date on which this address is no longer active.
      • Title: Floor
        Maximum Length: 40
        The specific floor number at a given address or in a particular building when building number is provided.
      • Title: Address
        Read Only: true
        The formatted address information.
      • Title: Formatted Address 1
        Read Only: true
        The formatted address of the contact address record.
      • Title: Address
        Read Only: true
        The formatted multiple line address information.
      • Title: Address
        Read Only: true
        The formatted address in multiline of the contact address record.
      • 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.
      • Title: Last Updated Date
        Read Only: true
        The date when the address data was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the address record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The session login associated to the user who last updated the address record.
      • Title: Latitude
        Used to store latitude information for the location for spatial proximity and containment purposes.
      • Links
      • Title: Location Directions
        Maximum Length: 640
        The directions to the location.
      • Title: Location ID
        The unique identifier for this location.
      • Title: Longitude
        Used to store longitude information for the location for spatial proximity and containment purposes.
      • Title: Mail Stop
        Maximum Length: 60
        A user-defined code to indicate a mail drop point within their organization.
      • 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.
      • 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.
      • 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.
      • 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. Inactive records can't be updated.
      • Title: Site Name
        Maximum Length: 240
        User-defined name for the address.
      • 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.
      • 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.
      • Title: Postal Code
        Maximum Length: 60
        The postal code as defined by the formal countrywide postal system.
      • Title: Postal Code Extension
        Maximum Length: 20
        The four digit extension to the United States Postal ZIP code.
      • 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.
      • Title: Province
        Maximum Length: 60
        The province element of Address.
      • 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.
      • 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.
      • Read Only: true
        Maximum Length: 255
        The name of the table that holds the record data and is referenced to manage source system reference.
      • 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.
      • Title: Start Date
        Date on which this address becomes active.
      • Title: State
        Maximum Length: 60
        The state element of Address.
      • 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.
      • 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.
      • Read Only: true
        The date when the address validation started. The value is internally set by system during address cleansing.
      • 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-response
      Type: object
      Show Source
      • Title: Address Element Attribute 1
        Maximum Length: 150
        The additional address element 1 to support flexible address format in local language.
      • Title: Address Element Attribute 2
        Maximum Length: 150
        The additional address element 2 to support flexible address format in local language.
      • Title: Address Element Attribute 3
        Maximum Length: 150
        The additional address element 3 to support flexible address format in local language.
      • Title: Address Element Attribute 4
        Maximum Length: 150
        The additional address element 4 to support flexible address format in local language.
      • Title: Address Element Attribute 5
        Maximum Length: 150
        The additional address element 5 to support flexible address format in local language.
      • Title: Address Line 1
        Maximum Length: 240
        The first line of the address in the local language.
      • Title: Address Line 2
        Maximum Length: 240
        The second line of the address in the local language.
      • Title: Address Line 3
        Maximum Length: 240
        The third line of the address in the local language.
      • Title: Address Line 4
        Maximum Length: 240
        The fourth line of the address in the local language.
      • Title: Site Number
        Read Only: true
        Maximum Length: 30
        The unique address identifier that's 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.
      • Title: Building
        Maximum Length: 240
        The specific building name or number at a given address in local language.
      • Title: City
        Maximum Length: 60
        The specific name of the city in local language.
      • Title: Country
        Read Only: true
        Maximum Length: 2
        The specific name of the country in local language.
      • Title: County
        Maximum Length: 60
        The specific name of the county in local language.
      • Read Only: true
        Maximum Length: 64
        The user who created the address locale record.
      • Read Only: true
        The date and time when the address locale record was created.
      • 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.
      • Read Only: true
        The formatted read only version of the locale address.
      • Read Only: true
        The date and time when the address locale was last updated.
      • Read Only: true
        Maximum Length: 64
        The user who last updated the address locale record.
      • Read Only: true
        Maximum Length: 32
        The login of the user who last updated the address locale record.
      • Links
      • The unique identifier of the location record.
      • Read Only: true
        The unique identifier of the location locale record.
      • 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.
      • Title: Postal Code Extension
        Maximum Length: 20
        The four digit extension to the United States Postal ZIP code in local language.
      • Title: Province
        Maximum Length: 60
        The name of the province in local language.
      • 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.
      • 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.
      • Title: State
        Maximum Length: 60
        The name of the State in the local language.
      • Title: Transliteration Language
        Maximum Length: 4
        Transliteration Language helps people pronounce words and names in foreign languages. It's validated against FND_LANGUAGES.LANGUAGE_CODE. Sample values are US,NL, DK.
      Nested Schema : contacts-Address-AddressPurpose-item-response
      Type: object
      Show Source
      • 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.
      • 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.
      • Read Only: true
        The unique identifier for the address purpose of an address.
      • Title: Comments
        Maximum Length: 2000
        The user comments for the address purpose.
      • Read Only: true
        Maximum Length: 64
        The user who created the address purpose record.
      • 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.
      • Read Only: true
        The date and time when the address purpose record was created.
      • 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.
      • Title: To Date
        The date on which the address purpose is no longer valid.
      • Read Only: true
        The date and time when the address purpose was last updated.
      • Read Only: true
        Maximum Length: 64
        The user who last updated the address purpose record.
      • Read Only: true
        Maximum Length: 32
        The login of the user who last updated the address purpose record.
      • Links
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • 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.
      • Title: From Date
        The date from which the address purpose is valid.
      • 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-response
      Type: object
      Show Source
      Nested Schema : contacts-ContactPoint-item-response
      Type: object
      Show Source
      • Title: Conflict ID
        Default Value: 0
        The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
      • Title: Contact Point ID
        Read Only: true
        The unique identifier of the contact point.
      • 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.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the record.
      • Title: Created by Application
        Default Value: HZ_WS
        The user who created the module.
      • Title: Creation Date
        Read Only: true
        The date when the record was created.
      • Title: OK to Contact
        Indicates whether to use a particular contact method. Defaulted to false.
      • Title: Do Not Contact
        The contact preference flag that indicates DNC option.
      • Title: Do Not Contact Reason
        The reason code for the contact preference.
      • Title: Email
        Maximum Length: 255
        The email address of the contact point.
      • Title: Email Purpose
        Maximum Length: 30
        The purpose of the email address.
      • Title: Phone Number
        Read Only: true
        Maximum Length: 255
        The formatted phone number of the contact point.
      • Title: Last Update Date
        Read Only: true
        The date when the contact point was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the contact point.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The login of the user who last updated the contact point.
      • Links
      • Title: Object Version Number
        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.
      • Title: Party ID
        The unique identifier of the party.
      • Title: Registry ID
        The alternate unique identifier of the contact point.
      • Title: Party Source System
        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.
      • Title: Party Source System Reference Value
        The identifier for the record from an external source system.
      • Title: Area Code
        Maximum Length: 255
        The area code for the telephone number.
      • Title: Phone Country Code
        Maximum Length: 255
        The country code of the phone number.
      • Title: Extension
        Maximum Length: 255
        The extension number of the phone line number like office desk extension.
      • Title: Phone
        Maximum Length: 255
        The phone number of the contact point.
      • 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.
      • Title: Type
        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.
      • 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.
      • Title: Primary
        Maximum Length: 1
        Default Value: false
        Indicates whether the phone number is preferred.
      • Title: Phone
        Maximum Length: 255
        The phone number in raw format.
      • Title: User ID
        The unique identifier of the social network.
      • Title: Social Network
        The name of the social network.
      • 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.
      • Title: Source System
        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.
      • Title: Source System Reference Value
        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.
      • Title: Status
        Maximum Length: 30
        Default Value: A
        The status of the contact point.
      • Title: URL
        The URL associated with the contact point.
      • Title: Verification Date
        The date of verification of the phone or email contact point.
      • 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.
      • 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 : contacts-ContactRollup-item-response
      Type: object
      Show Source
      Nested Schema : contacts-CustomerClassification-item-response
      Type: object
      Show Source
      • Title: Classification Category
        Maximum Length: 30
        The name of the classification category.
      • Title: Classification Code
        Maximum Length: 30
        The code indicating the classification category of the customer. For example, High Technology, Customer, or Telecom.
      • Title: Classification Code Meaning
        Read Only: true
        Maximum Length: 80
        A valid classification code meaning corresponding to the classification code.
      • Title: Code Assignment ID
        Read Only: true
        The unique identifier for the customer classification assignment.
      • 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.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the record.
      • 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.
      • Title: Creation Date
        Read Only: true
        The date when the record was created.
      • Title: End Date
        The date from which the classification code is no longer valid.
      • Title: Auxiliary Classification Status
        Read Only: true
        Indicates whether the classification category is an user-defined group classification category. The default value is false.
      • Title: Industry Type Status
        Read Only: true
        Indicates whether the classification category is an industry group classification category. The default value is false.
      • Title: Organization Type Status
        Read Only: true
        Indicates whether the classification category is an organization type classification category. The default value is false.
      • Title: Last Updated Date
        Read Only: true
        The date when the record was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The login of the user who last updated the record.
      • Links
      • Title: Party ID
        The unique Identifier of the account, contact or household with which the classification is associated.
      • Title: Party Number
        Maximum Length: 30
        The unique alternate identifier of the account, contact, or household with which the classification is associated. Inactive records can't be updated.
      • Title: Party Source System
        The name of the external source system of the account, contact, or household with which the classification is associated.
      • 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.
      • Title: Party Type
        Read Only: true
        Maximum Length: 30
        The type of the party, such as account, contact, or household.
      • Title: Primary
        Maximum Length: 1
        Default Value: false
        Indicates if the customer classification is the primary classification. The default value is false.
      • 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.
      • Title: Source System Reference Value
        The unique identifier for the customer classification in the external source.
      • Title: Start Date
        The date on which the customer classification was created.
      • 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-response
      Type: object
      Show Source
      • Title: Contact Relationship ID
        The unique identifier of the relationship that is populated when the note is associated with a contact.
      • 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.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the note record.
      • Title: Creation Date
        Read Only: true
        The date and time when the note record was created.
      • Title: Creator Party ID
        The unique identifier of the note creator's party.
      • 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.
      • 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.
      • 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.
      • Title: Primary Email
        Read Only: true
        Maximum Length: 320
        The email address of the user who created the note.
      • Title: Primary Address
        Read Only: true
        The address of the user who created the note.
      • Title: Primary Phone
        Read Only: true
        The phone number of the user who created the note.
      • Title: Last Update Date
        Read Only: true
        The date when the note data was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The login of the user who last updated the record.
      • Links
      • 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.
      • Maximum Length: 30
        The alternate unique identifier of the note. A user key that's system generated or from an external system.
      • Title: Title
        Maximum Length: 500
        The title of the note entered by the user.
      • Title: Note
        The actual note text.
      • Title: Type
        Maximum Length: 30
        The code used to classify a note, as asset or adjustment.
      • Title: Parent Note ID
        The unique identifier of the parent note.
      • 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.
      • Title: Author
        Read Only: true
        Maximum Length: 360
        The name of a contact party.
      • 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.
      • Title: Related Object
        Maximum Length: 64
        The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc.
      • 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.
      • 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-response
      Type: object
      Show Source
      Nested Schema : contacts-PrimaryAddress-item-response
      Type: object
      Show Source
      • Title: Addressee
        Maximum Length: 360
        The addressee of the primary address.
      • Title: Additional Address Element 1
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 2
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 3
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 4
        Maximum Length: 150
        The additional address element to support flexible address format.
      • Title: Additional Address Element 5
        Maximum Length: 150
        The additional address element to support flexible address format.
      • 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.
      • Title: Address Line 1
        Maximum Length: 240
        The first line for address.
      • Title: Address Line 2
        Maximum Length: 240
        The second line for address.
      • Title: Address Line 3
        Maximum Length: 240
        The third line for address.
      • Title: Address Line 4
        Maximum Length: 240
        The fourth line for address.
      • Title: Address Lines Phonetic
        Maximum Length: 560
        The phonetic or kana representation of the Kanji address lines (used in Japan).
      • 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.
      • Title: Building
        Maximum Length: 240
        The specific building name or number at a given address.
      • Title: City
        Maximum Length: 60
        The city element of the primary address.
      • Title: Comments
        Maximum Length: 2000
        User comments for the address.
      • Default Value: 0
        The unique identifier of the conflict.
      • 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.
      • 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.
      • Title: County
        Maximum Length: 60
        The county element of Address.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the address record.
      • Title: Creation Date
        Read Only: true
        The date and time when the address record was created.
      • 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.
      • 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.
      • Title: Validated Date
        The date when the address was last validated.
      • 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.
      • Title: Description
        Maximum Length: 2000
        An extensive description of the location of the address.
      • Title: Don't Validate
        Maximum Length: 1
        Indicates the contact preference to indicate DNC option.
      • Title: To Date
        The last date for a record in active status.
      • Title: Floor
        Maximum Length: 40
        The specific floor number at a given address or in a particular building when building number is provided.
      • Title: Address
        Read Only: true
        The formatted address information.
      • Title: Address
        Read Only: true
        The formatted multiple line address information.
      • 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.
      • Title: Last Updated Date
        Read Only: true
        The date when the address data was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the address record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The session login associated to the user who last updated the address record.
      • Title: Latitude
        Used to store latitude information for the location for spatial proximity and containment purposes.
      • Links
      • Title: Comments
        Maximum Length: 2000
        The additional information for the record in free text format.
      • Title: Location Directions
        Maximum Length: 640
        The directions to the location.
      • The unique identifier for this location.
      • The integration key for the location record.
      • Title: Location ID
        The system identifier for the location record.
      • The name of source system for the location record.
      • The unique source system identifier value.
      • Maximum Length: 1
        Default Value: true
        The status flag for location record.
      • Title: Longitude
        Used to store longitude information for the location for spatial proximity and containment purposes.
      • Title: Mail Stop
        Maximum Length: 60
        A user-defined code to indicate a mail drop point within their organization.
      • 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.
      • 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.
      • 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.
      • 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.
      • Title: Site Name
        Maximum Length: 240
        The name of party site.
      • Title: One-Time Address
        Maximum Length: 30
        The type information of the party site.
      • Title: Postal Code
        Maximum Length: 60
        The postal code as defined by the formal countrywide postal system.
      • Title: Postal Code Extension
        Maximum Length: 20
        The four digit extension to the United States Postal ZIP code.
      • Title: Province
        Maximum Length: 60
        The province element of Address.
      • Title: Short Description
        Maximum Length: 240
        The brief free text that describes the site record.
      • 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.
      • 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.
      • Title: From Date
        The date on which the record becomes active.
      • Title: State
        Maximum Length: 60
        The state element of Address.
      • Maximum Length: 1
        Default Value: A
        The status of the record.
      • Title: Time Zone
        Maximum Length: 64
        The time zone for the location.
      • 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.
      • 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-response
      Type: object
      Show Source
      • Title: Backward Role
        Read Only: true
        The backward relationship code used to describe relationships. For example, SUPPLIER_OF.
      • Title: Comments
        Maximum Length: 2000
        User comments for the relationship.
      • Default Value: 0
        The unique identifier of the conflict. This number is used by mobile or portable applications that consume the web service.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the relationship record.
      • 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.
      • Title: Creation Date
        Read Only: true
        The date and time when the relationship record was created.
      • Title: Dependent Indicator
        Maximum Length: 1
        Default Value: N
        Indicates whether one party is a dependent on another.
      • 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.
      • Title: To Date
        The date when the relationship ends.
      • 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.
      • Title: Influence Level
        The sales contact's influence in a buying relationship. Sample values are Inner Circle, Political structure, None.
      • Maximum Length: 100
        The definition of the job name.
      • Maximum Length: 900
        The definition of the job package.
      • Title: Last Updated Date
        Read Only: true
        The date and time when the relationship data was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the relationship record.
      • Title: Last Update Login
        Read Only: true
        Maximum Length: 32
        The session login associated to the user who last updated the relationship record.
      • Links
      • 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.
      • Title: Object Party Name
        Read Only: true
        Maximum Length: 360
        The name of the object party of the relationship.
      • 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.
      • 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.
      • 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.
      • Maximum Length: 30
        The source table name of the object party in this relationship.
      • Maximum Length: 30
        The object type of the contact.
      • Maximum Length: 30
        The usage code of object party in the relationship.
      • 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.
      • 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.
      • 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.
      • Read Only: true
        The unique identifier of the party.
      • Read Only: true
        The alternate unique identifier of the party.
      • Title: Ownership Percentage
        The percentage of the child entity owned by the parent entity.
      • 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.
      • 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.
      • 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.
      • Read Only: true
        The unique identifier of the relationship.
      • The unique identifier of the relationship record.
      • The name of external source system for the relationship, which are defined by an Admin as part of system setup.
      • The unique identifier of the relationship from the external source system.
      • 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.
      • The unique identifier of the request.
      • Title: Role
        The role between the subject and object party.
      • 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.
      • Title: From Date
        Date on which this relationship becomes active.
      • 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.
      • 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.
      • Title: Subject Party Name
        Read Only: true
        Maximum Length: 360
        The name of the subject party.
      • 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.
      • 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.
      • 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.
      • Maximum Length: 30
        The source table of the subject.
      • Maximum Length: 30
        The subject type of the contact.
      • Maximum Length: 30
        The usage code of subject party in the contact.
      Nested Schema : contacts-SalesTeamMember-item-response
      Type: object
      Show Source
      • 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.
      • 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.
      • 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.
      • Title: Created By
        Read Only: true
        Maximum Length: 64
        The user who created the sales team member record.
      • Title: Creation Date
        Read Only: true
        The date and time when the sale team member record was created.
      • 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.
      • 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.
      • Title: Archived Date
        Date on which this sales team member is no longer active.
      • Title: Last Updated Date
        Read Only: true
        The date when the sales team member record was last updated.
      • Title: Last Updated By
        Read Only: true
        Maximum Length: 64
        The user who last updated the sales team member record.
      • 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
      • 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'.
      • 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.
      • 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.
      • Title: Owner
        Default Value: false
        Indicates whether the contact is the owner of the contract.
      • The unique identifier of the party.
      • The unique identification number for the party.
      • 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.
      • 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.
      • Title: Resource Email
        The e-mail address of the resource.
      • Title: Resource ID
        The unique identifier of the household resource.
      • Title: Resource Name
        Read Only: true
        The name of the sales team member.
      • Read Only: true
        The name of the organization that the sales team member belongs to.
      • Title: Resource Party Number
        The alternate key identifier of the resource that this team member belongs to.
      • Title: Phone
        Read Only: true
        The primary phone number of the sales team member.
      • Title: Role
        Read Only: true
        The names of the roles assigned to the sales team member.
      • Title: Sales Account ID
        The unique identifier of the sales profile of the resource.
      • Title: Start Date
        Date on which this sales team member becomes active.
      • Title: Sales Account Resource ID
        The unique identifier of the sales team member.
      • 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-response
      Type: object
      Show Source
      • Title: Action Intent
        JSON object that describes what an action does and what context data can be passed to the action.
      • Title: Confirmation Message
        Maximum Length: 4000
        The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
      • Title: Content Type
        Maximum Length: 50
        The media type of the smart action REST operation.
      • Title: Action Name
        Maximum Length: 256
        The display name of the smart action.
      • 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.
      • Title: REST Endpoint
        Maximum Length: 150
        The relative path of the smart action REST resource. The path can include path parameters.
      • Title: Included in Application
        Maximum Length: 512
        The client applications that the smart action is associated with.
      • Links
      • Title: Mass Action
        Maximum Length: 1
        Boolean type indicating if this action can be mass processed.
      • Title: HTTP Method
        Maximum Length: 15
        The HTTP method of the smart action REST operation.
      • Title: Object Function
        Maximum Length: 64
        The object function associated with the smart action.
      • Title: Page Type
        Maximum Length: 256
        The list of pages that this action can be used in.
      • Title: Smart Suggest
        Maximum Length: 1
        Indicates whether smart suggest is enabled for the action.
      • Title: System Action
        Maximum Length: 1
        Indicates whether the action is seeded or custom.
      • 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.
      • Title: User Action ID
        The unique system assigned identifier of the smart action definition.
      • Title: Action Name
        Maximum Length: 256
        The unique system assigned smart action name.
      • Smart Action User Interface Definitions
        Title: Smart Action User Interface Definitions
        The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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.
      • Title: Priority
        The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
      • 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.
      • 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 : Smart Action User Interface Definitions
      Type: array
      Title: Smart Action User Interface Definitions
      The user interface definitions resource is used to view the user interfaces associated with a smart action. Each user interface can be mapped to a client application. 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 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-UserActionNavigation-item-response
      Type: object
      Show Source
      • Links
      • 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.
      • Title: Application Usage
        Maximum Length: 50
        The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
      • Title: Navigation Metadata
        Maximum Length: 1000
        The metadata definition of the smart action user interface endpoint.
      • Title: Primary Key
        The unique system assigned identifier of a smart action user interface definition.
      • Title: Navigation Type
        Maximum Length: 100
        The text value used by applications to determine which user interface to launch.
      Nested Schema : contacts-smartActions-UserActionRequestPayload-item-response
      Type: object
      Show Source
      • 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
      • 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.
      • The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
      • Title: Request Payload Attribute Name
        Maximum Length: 256
        The value assigned to the name property of a name-value pair.
      • Title: Smart Suggest Path
        Maximum Length: 2048
        The path used for smart suggest.
      • 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.
      • Title: Request Payload Attribute Value
        Maximum Length: 1000
        The value assigned to the value property of a name-value pair.
      • 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-response
      Type: object
      Show Source
      • 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
      • 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.
      • The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
      • Title: URL Binding Parameter Name
        Maximum Length: 50
        The value assigned to the name property of a name-value pair.
      • 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-response
      Type: object
      Show Source
      Back to Top

      Examples

      The following example shows how to get all contacts by submitting a get request on the REST resource using cURL.

      cURL Command

      curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/contacts

      Example of Response Body

      The following shows an example of the response body in JSON format.

      {
          "items": [
              {
                  "PartyId": -1,
                  "PartyNumber": "CONTACT-1033",
                  "SourceSystem": null,
                  "SourceSystemReferenceValue": null,
                  "AccountPartyId": null,
                  "AccountPartyNumber": null,
                  "AccountSourceSystem": null,
                  "AccountSourceSystemReferenceValue": null,
                  "AccountName": null,
                  "AccountUniqueName": null,
                  "PersonProfileId": -1,
                  "FirstName": "Lisa",
                  "LastName": "Pickford",
                  "LastNamePrefix": null,
                  "MiddleName": null,
                  "UniqueNameSuffix": "US)",
                  "ContactName": "Lisa Pickford",
                  "PreviousLastName": null,
                  "SecondLastName": null,
                  "OwnerPartyId": 300100174752464,
                  "OwnerPartyNumber": "CDRM_836604",
                  "OwnerEmailAddress": "sendmail-test-discard@oracle.com",
                  "OwnerName": "RCL_USER",
                  "SalesProfileNumber": "CDRM_237597",
                  "Type": "ZCA_CONTACT",
                  "ExistingCustomerFlag": false,
                  "ExistingCustomerFlagLastUpdateDate": null,
                  "NamedFlag": false,
                  "LastAssignmentDate": null,
                  "AssignmentExceptionFlag": false,
                  "SalesProfileStatus": null,
                  "TaxpayerIdentificationNumber": null,
                  "DateOfBirth": null,
                  "PlaceOfBirth": null,
                  "DateOfDeath": null,
                  "DeceasedFlag": null,
                  "Gender": null,
                  "MaritalStatus": null,
                  "MaritalStatusEffectiveDate": null,
                  "DeclaredEthnicity": null,
                  "PreferredFunctionalCurrency": null,
                  "PersonalIncomeAmount": null,
                  "HeadOfHouseholdFlag": false,
                  "HouseholdIncomeAmount": null,
                  "HouseholdSize": null,
                  "Salutation": null,
                  "SalutoryIntroduction": null,
                  "Title": null,
                  "AcademicTitle": null,
                  "Initials": null,
                  "RentOrOwnIndicator": null,
                  "CertificationLevel": null,
                  "CertificationReasonCode": null,
                  "Comments": null,
                  "PreferredContactMethod": null,
                  "FavoriteContactFlag": "false",
                  "Department": null,
                  "DepartmentCode": null,
                  "DoNotCallFlag": false,
                  "DoNotContactFlag": false,
                  "DoNotEmailFlag": false,
                  "DoNotMailFlag": false,
                  "JobTitle": null,
                  "JobTitleCode": null,
                  "LastContactDate": null,
                  "LastKnownGPS": null,
                  "SalesAffinityCode": null,
                  "SalesBuyingRoleCode": null,
                  "CurrencyCode": null,
                  "DataCloudStatus": null,
                  "LastEnrichmentDate": null,
                  "PartyStatus": "A",
                  "PartyType": "PERSON",
                  "CreatedByModule": null,
                  "CreatedBy": "1",
                  "CreationDate": "2009-03-19T02:56:36+00:00",
                  "LastUpdateDate": "2020-06-25T09:32:47.007+00:00",
                  "LastUpdateLogin": "A8BFD35001910DDCE0533CFDF40AE605",
                  "LastUpdatedBy": "comms_care",
                  "WorkPhoneContactPointType": null,
                  "WorkPhoneCountryCode": null,
                  "WorkPhoneAreaCode": null,
                  "WorkPhoneNumber": null,
                  "WorkPhoneExtension": null,
                  "FormattedWorkPhoneNumber": null,
                  "RawWorkPhoneNumber": null,
                  "MobileContactPointType": null,
                  "MobileCountryCode": null,
                  "MobileAreaCode": null,
                  "MobileNumber": null,
                  "MobileExtension": null,
                  "FormattedMobileNumber": null,
                  "RawMobileNumber": null,
                  "FaxContactPointType": null,
                  "FaxCountryCode": null,
                  "FaxAreaCode": null,
                  "FaxNumber": null,
                  "FaxExtension": null,
                  "FormattedFaxNumber": null,
                  "RawFaxNumber": null,
                  "HomePhoneContactPointType": null,
                  "HomePhoneCountryCode": null,
                  "HomePhoneAreaCode": null,
                  "HomePhoneNumber": null,
                  "FormattedHomePhoneNumber": null,
                  "RawHomePhoneNumber": null,
                  "EmailContactPointType": null,
                  "EmailFormat": null,
                  "EmailAddress": null,
                  "PrimaryAddressId": 300100209000615,
                  "PartyNumberKey": "CONTACT-1033",
                  "SellToPartySiteId": 300100209000615,
                  "ClassificationCategory": null,
                  "ClassificationCode": null,
                  "ContactIsPrimaryForAccount": null,
                  "NameSuffix": null,
                  "ContactUniqueName": "Lisa Pickford US)",
                  "RecordSet": null,
                  "SourceObjectType": "SALES_PARTY_CONTACT",
                  "ContactRole": null,
                  "RegistrationStatus": null,
                  "UpdateFlag": true,
                  "DeleteFlag": true,
                  "AddressNumber": "CDRM_747139",
                  "AddressElementAttribute1": null,
                  "AddressElementAttribute2": null,
                  "AddressElementAttribute3": null,
                  "AddressElementAttribute4": null,
                  "AddressElementAttribute5": null,
                  "AddressLine1": "Texas",
                  "AddressLine2": null,
                  "AddressLine3": null,
                  "AddressLine4": null,
                  "Building": null,
                  "City": null,
                  "Country": "US",
                  "County": null,
                  "FloorNumber": null,
                  "PostalCode": null,
                  "PostalPlus4Code": null,
                  "Province": null,
                  "State": null,
                  "Mailstop": null,
                  "AddressLinesPhonetic": null,
                  "AddressType": null,
                  "FormattedAddress": "Texas",
                  "OverallPrimaryFormattedPhoneNumber": null,
                  "OverallPrimaryPhoneContactPtId": null,
                  "TimezoneCode": null,
                  "ConflictId": 0,
                  "DoNotCallMobileFlag": false,
                  "DoNotCallWorkPhoneFlag": false,
                  "DoNotCallHomePhoneFlag": false,
                  "DoNotContactEmailFlag": false,
                  "DoNotContactFaxFlag": false,
                  "WorkPhoneVerificationStatus": null,
                  "WorkPhoneVerificationDate": null,
                  "MobileVerificationStatus": null,
                  "MobileVerificationDate": null,
                  "FaxVerificationStatus": null,
                  "FaxVerificationDate": null,
                  "HomePhoneVerificationStatus": null,
                  "HomePhoneVerificationDate": null,
                  "EmailVerificationStatus": null,
                  "EmailVerificationDate": null,
                  "DoCallMobilePhoneFlag": false,
                  "DoCallWorkPhoneFlag": false,
                  "DoCallHomePhoneFlag": false,
                  "DoContactFaxFlag": false,
                  "DoContactEmailFlag": false,
                  "MobilePhoneContactPtId": null,
                  "WorkPhoneContactPtId": null,
                  "HomePhoneContactPtId": null,
                  "FaxContactPtId": null,
                  "EmailContactPtId": null,
                  "RawPhoneNumber": null,
                  "links": [
                      {
                          "rel": "self",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033",
                          "name": "contacts",
                          "kind": "item",
                          "properties": {
                              "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000005770400000005737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000047371007E0002000000047371007E0002000000027371007E0002000000017371007E00020000000178"
                          }
                      },
                      {
                          "rel": "canonical",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033",
                          "name": "contacts",
                          "kind": "item"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/MaritalStatusLookupLOV",
                          "name": "MaritalStatusLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/WorkPhoneVerificationStatusLookupVA",
                          "name": "WorkPhoneVerificationStatusLookupVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/CurrenciesLOV",
                          "name": "CurrenciesLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/RatedCurrenciesLOV",
                          "name": "RatedCurrenciesLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoCallHomePhoneLookupLOV",
                          "name": "DoCallHomePhoneLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DepartmentCodeLookupLOV",
                          "name": "DepartmentCodeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/RegistrationStatusLookupLOV",
                          "name": "RegistrationStatusLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/EmailVerificationStatusLookupVA",
                          "name": "EmailVerificationStatusLookupVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/CertificationLevelLookupLOV",
                          "name": "CertificationLevelLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/MobileVerificationStatusLookupVA",
                          "name": "MobileVerificationStatusLookupVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/WorkPhoneCountryCodeLOV",
                          "name": "WorkPhoneCountryCodeLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotContactFlagLookupLOV",
                          "name": "DoNotContactFlagLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/HomePhoneCountryCodeLOV",
                          "name": "HomePhoneCountryCodeLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/PersonPreNameAdjunctLookupVO",
                          "name": "PersonPreNameAdjunctLookupVO",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/RentOwnIndLookupLOV",
                          "name": "RentOwnIndLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotCallWorkPhoneLookupLOV",
                          "name": "DoNotCallWorkPhoneLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotContactEmailLookupLOV",
                          "name": "DoNotContactEmailLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoContactEmailLookupLOV",
                          "name": "DoContactEmailLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/MobileCountryCodeLOV",
                          "name": "MobileCountryCodeLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotCallHomePhoneLookupLOV",
                          "name": "DoNotCallHomePhoneLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/FaxVerificationStatusLookupVA",
                          "name": "FaxVerificationStatusLookupVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/TimezoneVA",
                          "name": "TimezoneVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoCallWorkPhoneLookupLOV",
                          "name": "DoCallWorkPhoneLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoContactFaxLookupLOV",
                          "name": "DoContactFaxLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotCallFlagLookupLOV",
                          "name": "DoNotCallFlagLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/FaxCountryCodeLOV",
                          "name": "FaxCountryCodeLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/JobTitleCodeLookupLOV",
                          "name": "JobTitleCodeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotEmailFlagLookupLOV",
                          "name": "DoNotEmailFlagLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotMailFlagLookupLOV",
                          "name": "DoNotMailFlagLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/GenderLookupLOV",
                          "name": "GenderLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/CertificationReasonCodeLookupLOV",
                          "name": "CertificationReasonCodeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotContactFaxLookupLOV",
                          "name": "DoNotContactFaxLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/PreferredContactMethodLOV",
                          "name": "PreferredContactMethodLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/SalesBuyingRoleCodeLookupLOV",
                          "name": "SalesBuyingRoleCodeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/StatusLOV",
                          "name": "StatusLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/SalesProfileTypeLookupLOV",
                          "name": "SalesProfileTypeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/SearchFilters",
                          "name": "SearchFilters",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DataCloudStatusLookupLOV",
                          "name": "DataCloudStatusLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/SalesAffinityCodeLookupLOV",
                          "name": "SalesAffinityCodeLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoNotCallMobileLookupLOV",
                          "name": "DoNotCallMobileLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/DoCallMobilePhoneLookupLOV",
                          "name": "DoCallMobilePhoneLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/ContactRoleLookupLOV",
                          "name": "ContactRoleLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/SalesProfileStatusLookupLOV",
                          "name": "SalesProfileStatusLookupLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/CountriesLOV",
                          "name": "CountriesLOV",
                          "kind": "collection"
                      },
                      {
                          "rel": "lov",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/lov/HomePhoneVerificationStatusLookupVA",
                          "name": "HomePhoneVerificationStatusLookupVA",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/AdditionalIdentifier",
                          "name": "AdditionalIdentifier",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/AdditionalName",
                          "name": "AdditionalName",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/Address",
                          "name": "Address",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/Attachment",
                          "name": "Attachment",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/ContactPoint",
                          "name": "ContactPoint",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/ContactRollup",
                          "name": "ContactRollup",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/CustomerClassification",
                          "name": "CustomerClassification",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/Note",
                          "name": "Note",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/PictureAttachment",
                          "name": "PictureAttachment",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/PrimaryAddress",
                          "name": "PrimaryAddress",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/Relationship",
                          "name": "Relationship",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/SalesTeamMember",
                          "name": "SalesTeamMember",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/SourceSystemReference",
                          "name": "SourceSystemReference",
                          "kind": "collection"
                      },
                      {
                          "rel": "child",
                          "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/CONTACT-1033/child/smartActions",
                          "name": "smartActions",
                          "kind": "collection"
                      }
                  ]
              },
        .....
          ],
          "count": 25,
          "hasMore": true,
          "limit": 25,
          "offset": 0,
          "links": [
              {
                  "rel": "self",
                  "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts",
                  "name": "contacts",
                  "kind": "collection"
              },
              {
                  "rel": "action",
                  "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/contacts/action/findDuplicates",
                  "name": "findDuplicates",
                  "kind": "other"
              }
          ]
      }
      Back to Top