Create a partner contact
post
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/contacts
Request
Path Parameters
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the contact. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressType: string
Title:
Address Type
The lookup code for the type of address, such as billing address, shipping address etc. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the contact. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ContactName: string
Title:
Name
Maximum Length:450
The derived name of the contact. -
Country(required): string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreateUserAccountFlag: boolean
Indicates whether the user account should be created. This should not be used currently.
-
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Maximum Length:1
Indicates if the user can contact the person by phone, Email, or snail mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Maximum Length:1
Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotMailFlag: boolean
Title:
Do Not Mail
Maximum Length:1
Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
EmailAddress(required): string
Title:
Email
Maximum Length:320
The e-mail address of the partner contact. -
FavoriteContactFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
IsAccountContactFlag: boolean
Default Value:
false
Indicates whether an existing contact from an account would be converted to partner contact. The value 'Y' indicates that the party id of the existing account contact would be used for the partner contact if the related account is already a partner. -
isSelfRegistration: string
Title:
Self-Registered
Indicates whether the partner registration approval process will be invoked or not. If the value is Y, then the process will be invoked. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the primary contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute. -
Latitude: number
Title:
Latitude
The latitude information for the address of the contact. The latitude information for the location is used for spatial proximity and containment purposes. -
Longitude: number
Title:
Longitude
The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ManagerPartyId: integer
Title:
Manager Party ID
The unique identifier of the manager party of the partner contact. -
ManagerPartyNumber: string
Maximum Length:
30
The party number of the manager of the partner contact. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for partner contact's mobile phone. -
MobileCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
MobileNumber: string
Title:
Phone
Maximum Length:40
The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension. -
NamedFlag: boolean
Title:
Named Contact
Maximum Length:1
Default Value:false
Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix. -
PartnerCompanyNumber(required): string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerPartyId(required): integer
(int64)
The unique identifier of the party associated with the partner.
-
PartyId: integer
(int64)
The unique identifier of the partner contact party generated by the system during creation.
-
PartyNumber(required): string
Title:
Registry ID
Maximum Length:30
The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER. -
PersonPreNameAdjunct: string
Title:
Prefix
Maximum Length:30
The title or the salutary introduction for a contact, such as Mr., Herr, and so on. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddressId: integer
(int64)
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.
-
PrimaryFlag: boolean
Title:
Primary Contact Indicator
Maximum Length:255
Indicates whether this partner contact is primary contact of partner or not. If the value is True, then this partner contact is a primary contact. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
RoleCode: string
Maximum Length:
30
The role code of the partner contact. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier of the resource role of the partner contact. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the role 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. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
Title:
Type
Maximum Length:30
The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
userdetails: array
User Account Details
Title:
User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact. -
Username: string
The user name of the account for the partner contact. This should not be used currently.
-
WorkPhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for the partner contact's work phone. -
WorkPhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
WorkPhoneNumber: string
Title:
Phone
Maximum Length:40
The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.
Nested Schema : Attachments
Type:
array
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments.
Show Source
Nested Schema : User Account Details
Type:
array
Title:
User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : partners-contacts-userdetails-item-post-request
Type:
Show Source
object
-
Username: string
Title:
User Name
The name of the user account of the partner contact.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : partners-contacts-item-response
Type:
Show Source
object
-
AcademicTitle: string
Title:
Academic Title
Maximum Length:30
The part of the person???s title that denotes the academic qualification, such as Dr. Jane Smith. -
AddrElementAttribute1: string
Title:
Additional Address Element 1
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute2: string
Title:
Additional Address Element 2
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute3: string
Title:
Additional Address Element 3
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute4: string
Title:
Additional Address Element 4
Maximum Length:150
An additional address element to support flexible address format. -
AddrElementAttribute5: string
Title:
Additional Address Element 5
Maximum Length:150
An additional address element to support flexible address format. -
AddressLineFour: string
Title:
Address Line 4
Maximum Length:240
The fourth line for address of the contact. -
AddressLineOne: string
Title:
Address Line 1
Maximum Length:240
The first line for address. -
AddressLineThree: string
Title:
Address Line 3
Maximum Length:240
The third line for address. -
AddressLineTwo: string
Title:
Address Line 2
Maximum Length:240
The second line for address. -
AddressType: string
Title:
Address Type
The lookup code for the type of address, such as billing address, shipping address etc. -
attachments: array
Attachments
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments. -
Building: string
Title:
Building
Maximum Length:240
The building name or number in the address of the contact. -
CertificationLevel: string
Title:
Certification Level
Maximum Length:30
The certification level of a contact. A list of accepted values is defined in the lookup HZ_PARTY_CERT_LEVEL. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CertificationReasonCode: string
Title:
Certification Reason
Maximum Length:30
The code indicating the reason for the contact's current certification level assignment. A list of accepted values is defined using the lookup HZ_PARTY_CERT_REASON. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
City: string
Title:
City
Maximum Length:60
The city element of the address. -
Comments: string
Title:
Comments
Maximum Length:2000
The textual comments about a contact. -
ContactName: string
Title:
Name
Maximum Length:450
The derived name of the contact. -
Country: string
Title:
Country
Maximum Length:2
The country code of the address. Review the list of country codes using the Manage Geographies task. -
CountryName: string
Read Only:
true
The name for the country of the partner company. -
County: string
Title:
County
Maximum Length:60
The county of the address. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreateUserAccountFlag: boolean
Indicates whether the user account should be created. This should not be used currently.
-
CreationDate: string
(date-time)
Read Only:
true
The date and time the record was created. -
DateOfBirth: string
(date)
Title:
Date of Birth
The date when the person was born. -
DateOfDeath: string
(date)
Title:
Date of Death
The date when the person died. -
DeceasedFlag: boolean
Title:
Person Deceased
Maximum Length:1
Indicates whether the person is deceased or not. If the value is True, then the person is deceased. The default value is False. -
DeclaredEthnicity: string
Title:
Declared Ethnicity
Maximum Length:60
The declared ethnicity of the person. -
Department: string
Title:
Department
Maximum Length:60
The free form text used to name the department for the contact. -
DepartmentCode: string
Title:
Department Code
Maximum Length:30
The code indicating the department of the contact. A list of accepted values is defined in the lookup DEPARTMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
DoNotCallFlag: boolean
Title:
Do Not Call
Maximum Length:1
Indicates if the user can call the person or not. If the value is True, then the user must not call the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotContactFlag: boolean
Title:
Do Not Contact
Maximum Length:1
Indicates if the user can contact the person by phone, Email, or snail mail. If the value is True, then the user must not contact the person. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Maximum Length:1
Indicates if the user can email the person or not. If the value is True, then the user must not contact the person by email. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
DoNotMailFlag: boolean
Title:
Do Not Mail
Maximum Length:1
Indicates if the user can send mail to the person or not. If the value is True, then the user must not contact the person by mail. The default value is False. A list of accepted values is defined using the lookup YES_NO. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Common Lookups task. -
EmailAddress: string
Title:
Email
Maximum Length:320
The e-mail address of the partner contact. -
FavoriteContactFlag: boolean
Title:
Favorite
Maximum Length:10
Default Value:false
Indicates whether the person is a key contact. If the value is True, then person is a key contact. The default value is False. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder. -
FirstName: string
Title:
First Name
Maximum Length:150
The first name of the person. -
FloorNumber: string
Title:
Floor
Maximum Length:40
The floor number of the address. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The formatted address of the partner contact. -
FormattedMobileNumber: string
Title:
Phone Number
Read Only:true
The formatted mobile phone number information. -
FormattedWorkPhoneNumber: string
Title:
Phone Number
Read Only:true
The formatted work phone number information. -
Gender: string
Title:
Gender
Maximum Length:30
The gender of the person, such as male, female, and unknown. A list of accepted values is defined in the lookup HZ_GENDER. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
Initials: string
Title:
Initials
Maximum Length:20
The initials of the contact???s name. -
IsAccountContactFlag: boolean
Default Value:
false
Indicates whether an existing contact from an account would be converted to partner contact. The value 'Y' indicates that the party id of the existing account contact would be used for the partner contact if the related account is already a partner. -
isSelfRegistration: string
Title:
Self-Registered
Indicates whether the partner registration approval process will be invoked or not. If the value is Y, then the process will be invoked. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The job title of the primary contact. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The code indicating the job title. -
LastName: string
Title:
Last Name
Maximum Length:150
The last name of the person. -
LastNamePrefix: string
Title:
Last Name Prefix
Maximum Length:30
The prefix for the last name of a person, such as De, Van. For example, if a person???s name is Hans De Vries, then the last name prefix De is captured using this attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the record. -
Latitude: number
Title:
Latitude
The latitude information for the address of the contact. The latitude information for the location is used for spatial proximity and containment purposes. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Longitude: number
Title:
Longitude
The longitude information for the address of the contact. The longitude information for the location is used for spatial proximity and containment purposes. -
Mailstop: string
Title:
Mail Stop
Maximum Length:60
The user-defined code that indicates a mail drop point within the organization. -
ManagerName: string
Title:
Manager
Read Only:true
Maximum Length:255
The name of the manager of partner contact. -
ManagerPartyId: integer
Title:
Manager Party ID
The unique identifier of the manager party of the partner contact. -
ManagerPartyNumber: string
Maximum Length:
30
The party number of the manager of the partner contact. -
MaritalStatus: string
Title:
Marital Status
Maximum Length:30
The marital status of the person. A list of accepted values is defined in the lookup MARITAL_STATUS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
MaritalStatusEffectiveDate: string
(date)
Title:
Marital Status Effective Date
The date when the person's marital status was changed. -
MiddleName: string
Title:
Middle Name
Maximum Length:60
The middle name of the person. -
MobileAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for partner contact's mobile phone. -
MobileCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s mobile phone number, such as 33 for France. -
MobileExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
MobileNumber: string
Title:
Phone
Maximum Length:40
The mobile phone number of partner contact formatted in the local format. The number should not include area code, country code, or extension. -
NamedFlag: boolean
Title:
Named Contact
Maximum Length:1
Default Value:false
Indicates whether a sales account is a named sales account. If the value is True, then the sales account is a named sales account. The default value is False. -
NameSuffix: string
Title:
Suffix
Maximum Length:30
The place in a family structure. For example, in "Tom Jones III", the "III" is the suffix. -
PartnerCompanyNumber: string
Title:
Partner Number
Maximum Length:30
The unique identifier of the partner company. -
PartnerName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the partner associated with the contact. -
PartnerPartyId: integer
(int64)
The unique identifier of the party associated with the partner.
-
PartyId: integer
(int64)
The unique identifier of the partner contact party generated by the system during creation.
-
PartyNumber: string
Title:
Registry ID
Maximum Length:30
The unique identifier for the partner contact party. Can be system-generated or user-provided during create, based on the profile option HZ_GENERATE_PARTY_NUMBER. -
PersonPreNameAdjunct: string
Title:
Prefix
Maximum Length:30
The title or the salutary introduction for a contact, such as Mr., Herr, and so on. -
PlaceOfBirth: string
Title:
Place of Birth
Maximum Length:60
The place where the person was born, such as city or country. -
PostalCode: string
Title:
Postal Code
Maximum Length:60
The postal code as defined by the formal countrywide postal system. -
PostalPlus4Code: string
Title:
Postal Code Extension
Maximum Length:20
The four-digit extension to the United States Postal ZIP code for the address. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Maximum Length:30
The preferred method to contact the person. A list of accepted values is defined in the lookup HZ_PREFERRED_CONTACT_METHOD. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Point Lookups task. -
PreferredFunctionalCurrency: string
Title:
Preferred Functional Currency
Maximum Length:15
The preferred currency of the contact. A list of accepted values is defined using the Setup and Maintenance work area, Manage Currencies task. -
PreviousLastName: string
Title:
Previous Last Name
Maximum Length:150
The previous last name or surname of the person. -
PrimaryAddressId: integer
(int64)
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.
-
PrimaryContactPartyId: integer
(int64)
Read Only:
true
The party identifier of the primary contact of the partner. -
PrimaryFlag: boolean
Title:
Primary Contact Indicator
Maximum Length:255
Indicates whether this partner contact is primary contact of partner or not. If the value is True, then this partner contact is a primary contact. -
Province: string
Title:
Province
Maximum Length:60
The province of the address. -
RentOrOwnIndicator: string
Title:
Rent or Own Indicator
Maximum Length:30
Indicates if this contact owns or rents his or her residence. A list of valid values for rent, own, and lease is defined in the lookup OWN_RENT_IND. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
RoleCode: string
Maximum Length:
30
The role code of the partner contact. -
RoleId: integer
(int64)
Title:
Role ID
The unique identifier of the resource role of the partner contact. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:255
The name of the resource role for partner contact. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The code indicating the affinity of a contact to the deploying organization. A list of accepted values is defined in the lookup HZ_SLS_CNTCT_AFFINITY_CODE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Contact Lookups task. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The code indicating the role 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. -
Salutation: string
Title:
Salutation
Maximum Length:60
The phrase used to address a contact party in any correspondence. -
SecondLastName: string
Title:
Second Last Name
Maximum Length:150
The second last name for a person. A list of accepted values is defined in the lookup HZ_PERSON_PROFILES. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
SourceSystem: string
The name of the external source system.
-
SourceSystemReferenceValue: string
The identifier of the record from external source system.
-
State: string
Title:
State
Maximum Length:60
The state element of the address. -
Title: string
Title:
Title
Maximum Length:60
A professional or family title, such as Don or The Right Honorable. -
Type: string
Title:
Type
Maximum Length:30
The contact party type that defines whether the contact is a sales account, a prospect, a contact or any other user-defined party type. The default value is ZCA_CUSTOMER. A list of accepted values is defined in the lookup ZCA_CONTACT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
userdetails: array
User Account Details
Title:
User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact. -
Username: string
The user name of the account for the partner contact. This should not be used currently.
-
WorkPhoneAreaCode: string
Title:
Area Code
Maximum Length:20
The area code for the partner contact's work phone. -
WorkPhoneCountryCode: string
Title:
Phone Country Code
Maximum Length:10
The international country code for a partner contact???s work phone number, such as 33 for France. -
WorkPhoneExtension: string
Title:
Extension
Maximum Length:20
The additional number used after initial connection to an internal telephone system. -
WorkPhoneNumber: string
Title:
Phone
Maximum Length:40
The work phone number of a partner contact formatted in the local format without the area code, country code, or extension.
Nested Schema : Attachments
Type:
array
Title:
Attachments
An attachments resource is used to view, create, modify or delete the partner's attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Account Details
Type:
array
Title:
User Account Details
The user account details resource is used to view, create, update, and delete the user account details of a partner contact.
Show Source
Nested Schema : partners-contacts-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
The unique identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attachment. -
CategoryName: string
Title:
Category
Maximum Length:30
The name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name of the person who uploaded the image. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the attachment record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
The code indicating the data type of the attachment. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The unique identifier of the attached document. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
The current version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The code indicating the type of error, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The date when the contents in the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URL of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name of the person who last updated the image. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The length of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name of the attachment file. -
UploadedText: string
Title:
Uploaded Text
The text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of the attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of the attachment. -
UserName: string
Title:
User Name
Maximum Length:255
The login associated with the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : partners-contacts-userdetails-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserAccountStatus: string
Title:
User Account Request Status
Read Only:true
The status of the user account of the partner contact. -
Username: string
Title:
User Name
The name of the user account of the partner contact.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CertificationLevelLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_LEVEL
- finder:
- CertificationReasonCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PARTY_CERT_REASON
- finder:
- CountriesLOV
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
- finder:
- CurrenciesLOV
-
Parameters:
- finder:
EnabledFlagFinder%3BBindEnabledFlag%3DY
- finder:
- DepartmentCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDEPARTMENT_TYPE
- finder:
- DoNotCallFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotContactFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotEmailFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- DoNotMailFlagLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DYES_NO
- finder:
- GenderLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_GENDER
- finder:
- JobTitleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DRESPONSIBILITY
- finder:
- ManagersLOV
-
Parameters:
- finder:
PCManagersFinder%3BPartnerPartyId%3D{PartnerPartyId}
- finder:
- MaritalStatusLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DMARITAL_STATUS
- finder:
- PartnerLookup
- PersonPreNameAdjunctLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupCode%3D{PersonPreNameAdjunct}%2CLookupType%3DCONTACT_TITLE
- finder:
- PhoneCountryCodeLOV
- PreferredContactMethodLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD
- finder:
- RentOwnIndLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DOWN_RENT_IND
- finder:
- ResourceRoleLOV
- SalesAffinityCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE
- finder:
- SalesBuyingRoleCodeLookupLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
- finder:
- SalesProfileTypeLookupLOV
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DZCA_CONTACT_TYPE
- finder:
- attachments
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- PartyNumber:
$request.path.PartyNumber
- CompanyNumber:
- userdetails
-
Parameters:
- CompanyNumber:
$request.path.CompanyNumber
- PartyNumber:
$request.path.PartyNumber
- CompanyNumber: