Get an account contact
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/AccountContact/{AccountContactId}
Request
Path Parameters
-
AccountContactId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : accounts-AccountContact-item-response
Type:
Show Source
object
-
AccountContactId: integer
(int64)
Title:
Account Contact ID
Read Only:true
The unique identifier of the account contact. -
AccountPartyId: integer
(int64)
Title:
Account Party ID
The primary key identifier of the object in this relationship. Either one of ObjectPartyId, ObjectPartyNumber, and combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountPartyNumber: string
Title:
Account Party Number
Maximum Length:30
The public unique identification number for the object party of the relationship. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
AccountSourceSystem: string
Title:
Account Source System
The name of external source system for the object party in the relationship, which are defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
AccountSourceSystemReferenceValue: string
Title:
Account Source System Reference
The identifier for the object party in the relationship from external source system. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. -
Comments: string
Title:
Comments
Maximum Length:2000
The comments of the user. -
ContactFirstName: string
Title:
First Name
Read Only:true
Maximum Length:150
The first name of the contact record. -
ContactLastName: string
Title:
Last Name
Read Only:true
Maximum Length:150
The last name of the contact record. -
ContactLastUpdateDate: string
(date-time)
Title:
Contact Last Update Date
Read Only:true
The date when the contact record was last updated. -
ContactName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the contact. -
ContactNumber: string
Title:
Contact Number
Maximum Length:30
The user-defined identification number for this contact. -
ContactPartyId: integer
(int64)
Title:
Contact Party ID
The primary key identifier of the subject in this relationship. Either one of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactPartyNumber: string
Title:
Contact Party Number
Maximum Length:30
The public key identifier for the subject party of the relationship. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
ContactSourceSystem: string
Title:
Contact Source System
The name of external source system for the subject party in the relationship, which are defined by an administrator as part of system setup. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
ContactSourceSystemReferenceValue: string
Title:
Contact Source System Reference
The identifier for the subject party in the relationship from external source system. One of SubjectPartyId, SubjectPartyNumber, and a combination of SubjectSourceSystem and SubjectSourceSystemReferenceValue, is used to identify the subject party of the relationship. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the row. -
CreatedByModule: string
Title:
Created by Application
Maximum Length:30
Default Value:HZ_WS
The application module that created the record. It's defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. You can review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the row was created. -
DecisionMakerFlag: boolean
Title:
Decision Maker
Maximum Length:1
Default Value:false
Indicates whether this contact is a decision maker. The values are Y for a decision maker, N for someone who's not the decision maker. -
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 value of the department code for the contact. -
DoCallFlag: boolean
Title:
OK to Call
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can call the contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
DoEmailFlag: boolean
Title:
OK to Email
Read Only:true
Maximum Length:10
Default Value:false
Indicates whether the user can email the contact of an account. The accepted values are True and False or Y and N. Default is False or N. -
DoNotCallFlag: boolean
Title:
Do Not Call
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether you can call the account contact. The accepted values are True and False or Y and N. Default is False or N. -
DoNotEmailFlag: boolean
Title:
Do Not Email
Read Only:true
Maximum Length:255
Default Value:false
Indicates whether you can email the account contact. The accepted values are True and False or Y and N. Default is False or N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The e-mail address of the contact person for the account. -
EmailVerificationDate: string
(date)
Title:
Email Verification Date
Read Only:true
The date of the verification for the email. -
EmailVerificationStatus: string
Title:
Email Verification Status
Read Only:true
The status of the verification for email. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID, ORA_INVALID and ORA_PARTIALLY_VALID. Default value is blank which indicates that values are not verified. -
FormattedAddress: string
Title:
Address
Read Only:true
The formatted address of the contact. -
FormattedPhoneNumber: string
Title:
Phone Number
Read Only:true
The primary formatted phone number for the contact person. -
InfluenceLevelCode: string
Title:
Influence Level
Maximum Length:30
The contact's level of influence in the buying process. -
JobTitle: string
Title:
Job Title
Maximum Length:100
The free form text for job title for the contact associated to an account. -
JobTitleCode: string
Title:
Job Title Code
Maximum Length:30
The value of the code for the job title of the contact person. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonBuyingRole: string
Title:
Buying Role
Read Only:true
Maximum Length:30
Describes a contact's role in a buying relationship. Sample values are key decision maker, supporting decision maker. -
PersonJobTitle: string
Title:
Contact Job Title
Read Only:true
Maximum Length:100
The title of the contact's job with deploying organization. -
PersonSalesAffinityCode: string
Title:
Affinity
Read Only:true
Maximum Length:30
The contact's affinity for the deploying organization. -
PhoneVerificationDate: string
(date)
Title:
Phone Verification Date
Read Only:true
The date of the verification for phone. -
PhoneVerificationStatus: string
Title:
Phone Verification Status
Read Only:true
The status of the verification for phone. Accepted values are defined in the standard lookup type ORA_HZ_VALIDATION_STATUS as ORA_VALID and ORA_INVALID. Default value is blank which indicates that values are not verified. -
PreferredContactFlag: boolean
Title:
Preferred Contact
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. -
PreferredContactMethod: string
Title:
Preferred Contact Method
Read Only:true
The person's or organization's preferred contact method. -
PrimaryCustomerFlag: boolean
Title:
Primary Customer
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. -
ReferenceUseFlag: boolean
Title:
Reference
Maximum Length:1
Default Value:false
Indicates if this contact can be used as a reference. The values are Y for a contact who will act as a reference, N for a contact who can't act as a reference. -
RelationshipId: integer
(int64)
Title:
Relationship Id
Read Only:true
The unique identifier of the relationship associated with account contact record. -
RelationshipRecId: integer
(int64)
Title:
Relationship Record ID
Finds an account contact with the relationship record identifier. -
RelationshipSourceSystem: string
Title:
Relationship Source System
The name of external source system for the relationship, which is defined by an administrator as part of system setup. One of ObjectPartyId, ObjectPartyNumber, and a combination of ObjectSourceSystem and ObjectSourceSystemReferenceValue, is used to identify the object party of the relationship. The value for this attribute should be predefined using the setup task Manage Trading Community Source Systems. -
RelationshipSourceSystemReferenceValue: string
Title:
Relationship Source System Reference
The identifier for the relationship with the external source system. -
SalesAffinityCode: string
Title:
Affinity
Maximum Length:30
The contact's affinity for the deploying organization. -
SalesAffinityComments: string
Title:
Affinity Comments
Maximum Length:2000
The comments describing the contact's affinity for the deploying organization. -
SalesBuyingRoleCode: string
Title:
Buying Role
Maximum Length:30
The contact's role in the buying process. -
Status: string
Maximum Length:
1
Default Value:A
Indicates whether this is an active or inactive relationship. The values are A for active, I for inactive. This is an internal column and you're not expected to pass in a value. A list of valid values is defined in the lookup HZ_STATUS. You can review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task. Default value is A.
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.
Links
- DepartmentCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DDEPARTMENT_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: DepartmentCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- InfluenceLevelCodeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_INFLUENCE_LVL_CD
The following properties are defined on the LOV link relation:- Source Attribute: InfluenceLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- JobTitleCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DRESPONSIBILITY
The following properties are defined on the LOV link relation:- Source Attribute: JobTitleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonSalesAffinityCodeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE
The following properties are defined on the LOV link relation:- Source Attribute: PersonSalesAffinityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PersonSalesBuyingRoleCodeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: PersonBuyingRole; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- PreferredContactMethodVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_PREFERRED_CONTACT_METHOD
The following properties are defined on the LOV link relation:- Source Attribute: PreferredContactMethod; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesAffinityCodeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_AFFINITY_CODE
The following properties are defined on the LOV link relation:- Source Attribute: SalesAffinityCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- SalesBuyingRoleCodeLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DHZ_SLS_CNTCT_BUY_ROLE_CODE
The following properties are defined on the LOV link relation:- Source Attribute: SalesBuyingRoleCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: