Update a sales team member
patch
/crmRestApi/resources/11.13.18.05/contacts/{PartyNumber}/child/SalesTeamMember/{TeamMemberId}
Request
Path Parameters
-
PartyNumber(required): 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.
-
TeamMemberId(required): integer(int64)
The unique identifier of the sales team member.
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.
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
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
Date on which this sales team member is no longer active. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner of the contract. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The unique identification number for the party.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
StartDateActive: string
(date)
Title:
Start Date
Date on which this sales team member becomes active. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the sales team member. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : contacts-SalesTeamMember-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access granted to the resource as well as managers of the organizations. The possible values are defined in the ZCA_ACCESS_LEVEL lookup. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. A list of accepted values is defined in the lookup ZCA_ASSIGNMENT_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Standard Lookups task. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the sales team member record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the sale team member record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code associated with the sales team member. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
EndDateActive: string
(date)
Title:
Archived Date
Date on which this sales team member is no longer active. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the sales team member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the sales team member record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login associated to the user who last updated the sales team member record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockAssignmentFlag: boolean
Title:
Locked
Maximum Length:1
Default Value:false
Indicates if the automatic territory assignment can be set. If the value is True, then the automatic territory assignment cannot remove the sales account team resource. The default value is False. When a sales account team member is added manually, this flag is defaulted to `Y'. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the role of a sales team member in the resource team such as Integrator, Executive Sponsor, and Technical Account Manager. A list of accepted values is defined in the lookup FND_LOOKUPS. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
ObjectVersionNumber: integer
(int32)
The number used to implement locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to determine whether another session has updated the row.
-
OwnerFlag: boolean
Title:
Owner
Default Value:false
Indicates whether the contact is the owner of the contract. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The unique identification number for the party.
-
PartySourceSystem: string
The name of external source system of the account, contact or household with which the address is associated. Part of alternate key for the account, contact or household record (along with PartyourceSystemReferenceValue). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated. The value for this attribute should be predefined in the lookup type HZ_ORIG_SYSTEMS_VL using the setup task Manage Trading Community Source Systems.
-
PartySourceSystemReferenceValue: string
The unique identifier from external source system for the account, contact or household with which the address is associated. Part of alternate key (along with PartySourceSystem). One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to identify the account, contact or household record with which the address is associated.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the household resource. -
ResourceName: string
Title:
Resource Name
Read Only:true
The name of the sales team member. -
ResourceOrgName: string
Read Only:
true
The name of the organization that the sales team member belongs to. -
ResourcePartyNumber: string
Title:
Resource Party Number
The alternate key identifier of the resource that this team member belongs to. -
ResourcePhoneNumber: string
Title:
Phone
Read Only:true
The primary phone number of the sales team member. -
ResourceRoleName: string
Title:
Role
Read Only:true
The names of the roles assigned to the sales team member. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales profile of the resource. -
StartDateActive: string
(date)
Title:
Start Date
Date on which this sales team member becomes active. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the sales team member. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date and time when the record was last updated. This value is different from LAST_UPDATE_DATE if the update originally happened in a different database.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : 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
- AccessLevelLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_ACCESS_LEVEL%2CLookupCode%3D{AccessLevelCode}
- finder:
- MemberFunctionLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION
- finder:
- RatedCurrencies