Create a sales team member
post
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/SalesTeamMember
Request
Path Parameters
-
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.
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
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the account. 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. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
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 lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS. -
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. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
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 of the relationship from external source system.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The resource identifier. -
ResourcePartyNumber: string
Title:
Resource Party Number
The unique public identifier of the resource record. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date when the resource is associated with the sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales account resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date on which the record was last updated by a specific user.
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 : accounts-SalesTeamMember-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the type of access granted to the resource as well as the managers of the organizations. The possible values are contained in the ZCA_ACCESS_LEVEL lookup. -
AssignmentTypeCode: string
Title:
Assignment Type
Maximum Length:30
Default Value:MANUAL
The code indicating how the resource is assigned to the sales account team. The possible values are contained in the ZCA_ASSIGNMENT_TYPE lookup. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code associated with the account. 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 record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the record was created. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
EndDateActive: string
(date)
Title:
Archived Date
The date when the resource is dissociated from the sales account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which 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 details of the user who last updated the 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 lookup code indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager. The code lookup is stored in FND_LOOKUPS. -
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. -
PartyId: integer
The unique identifier of the party.
-
PartyNumber: string
The party number.
-
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 of the relationship from external source system.
-
ResourceEmailAddress: string
Title:
Resource Email
The e-mail address of the resource. -
ResourceId: integer
(int64)
Title:
Resource ID
The resource identifier. -
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 unique public identifier of the resource record. -
ResourcePhoneNumber: string
Title:
Phone
Read Only:true
The primary phone number of the sales team member. -
ResourceRoleName: string
Title:
Role
Read Only:true
The roles assigned to the sales team member. -
SalesProfileId: integer
(int64)
Title:
Sales Account ID
The unique identifier of the sales account. -
StartDateActive: string
(date)
Title:
Start Date
The date when the resource is associated with the sales account. -
TeamMemberId: integer
(int64)
Title:
Sales Account Resource ID
The unique identifier of the member of the sales account resource team. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date on which the record was last updated by a specific user.
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}
The list of values indicating the type of access granted to the resource as well as managers of the organizations, such as View only and Edit.
The following properties are defined on the LOV link relation:- Source Attribute: AccessLevelCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- MemberFunctionLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DZCA_RESOURCE_FUNCTION
The list of values indicating a sales account resource's role on the resource team such as Integrator, Executive Sponsor and Technical Account Manager.
The following properties are defined on the LOV link relation:- Source Attribute: MemberFunctionCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RatedCurrencies
-
The list of values indicating the currency code used by the sales team member, such as USD and GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode