Get a salesperson reference account
get
/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/{salespersonReferenceAccountsUniqID}
Request
Path Parameters
-
salespersonReferenceAccountsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Salesperson Reference Accounts resource and used to uniquely identify an instance of Salesperson Reference Accounts. The client should not generate the hash key value. Instead, the client should query on the Salesperson Reference Accounts collection resource in order to navigate to a specific instance of Salesperson Reference Accounts to get the hash key.
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:
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.
Root Schema : salespersonReferenceAccounts-item-response
Type:
Show Source
object
-
BusinessUnit: string
Title:
Business Unit
A unit of an enterprise that performs one or more business functions that can be rolled up in a management hierarchy. The business unit is part of the unique set that identifies a reference account. -
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 when the record was created. -
FreightAccountCombination: string
Title:
Freight Account Combination
The accounting flexfield combination for the Freight account. -
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:64
The user who last updated the record. -
Ledger: string
Title:
Ledger
Read Only:true
Maximum Length:30
A ledger at the business unit level which holds all the accounting information details. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReceivablesAccountCombination: string
Title:
Receivables Account Combination
The accounting flexfield combination for the Receivables account. -
RevenueAccountCombination: string
Title:
Revenue Account Combination
The accounting flexfield combination for the Revenue account. -
SalespersonEndDate: string
(date)
Title:
Salesperson End Date
Read Only:true
The date when the salesperson is terminated. -
SalespersonId: integer
Title:
Salesperson ID
The unique identifier of the salesperson. -
SalespersonName: string
Title:
Salesperson Name
Maximum Length:360
The name of the salesperson. The salesperson name is part of the unique set that identifies a reference account. -
SalespersonNumber: string
Title:
Salesperson Number
Maximum Length:120
The number that identifies the salesperson. The salesperson number is part of the unique set that identifies a reference account. -
SalespersonSet: string
Title:
Salesperson Set
Read Only:true
Maximum Length:80
The reference set assigned to the salesperson during salesperson creation to support data partitioning. -
SalespersonStartDate: string
(date)
Title:
Salesperson Start Date
Read Only:true
The date when the salesperson is hired. -
SalespersonStatus: string
Title:
Salesperson Status
Read Only:true
Maximum Length:80
The status of the salesperson. Valid values are Active and Inactive.
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.
Examples
The following example shows how to retrieve aalesperson reference account by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts?q=SalespersonId=100000008143166
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "SalespersonId": 100000008143166, "SalespersonNumber": "999990000955248", "SalespersonName": "Caroline Snel", "SalespersonSet": "Vision Operations Set", ... "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/00030000000EACED0005770800005AF310F6813E0000000C52415F53414C4553524550530000000EACED00057708000110F0811A38A7", "name": "salespersonReferenceAccounts", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts/00030000000EACED0005770800005AF310F6813E0000000C52415F53414C4553524550530000000EACED00057708000110F0811A38A7", "name": "salespersonReferenceAccounts", "kind": "item" }, ... ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/salespersonReferenceAccounts", "name": "salespersonReferenceAccounts", "kind": "collection" } ] }