Get a carried interest distribution
get
/fscmRestApi/resources/11.13.18.05/carriedInterestDistributions/{distributionId}
Request
Path Parameters
-
distributionId(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=
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 : carriedInterestDistributions-item-response
Type:
Show Source
object
-
accountedCurrencyCode: string
Title:
Accounting Currency
Read Only:true
Maximum Length:15
The currency code of accounting currency of the source joint venture transaction. -
accountingDate: string
(date)
Title:
Accounting Date
Read Only:true
The date used to determine the accounting period for the transaction. -
accountingPeriod: string
Title:
Accounting Period
Read Only:true
Maximum Length:15
The name of the fiscal period that the source transaction is associated with. -
agreement: string
Title:
Agreement
Read Only:true
Maximum Length:30
The name of the agreement of the carried interest distribution. -
agreementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the agreement of the carried interest distribution. -
consentingPercentage: number
Title:
Consenting Carried Percentage
Read Only:true
The percentage of the nonconsenting stakeholder's share that's assumed by the consenting stakeholder. -
consentingStakeholder: string
Title:
Consenting Stakeholder
Read Only:true
Maximum Length:30
The name of the consenting stakeholder on the carried interest distribution. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture distribution. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture distribution was created. -
distributedAccountedCredit: number
Title:
Consenting Stakeholder Carried Accounted Credit
Read Only:true
The distributed credit amount for the stakeholder in accounting currency. -
distributedAccountedDebit: number
Title:
Consenting Stakeholder Carried Accounted Debit
Read Only:true
The distributed debit amount for the stakeholder in accounting currency. -
distributedEnteredCredit: number
Title:
Consenting Stakeholder Carried Entered Credit
Read Only:true
The distributed credit amount for the stakeholder in the entered currency. -
distributedEnteredDebit: number
Title:
Consenting Stakeholder Carried Entered Debit
Read Only:true
The distributed debit amount for the stakeholder in the entered currency. -
distributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
The unique identifier of a carried interest distribution. -
distributionLineNumber: integer
(int32)
Title:
Distribution Line Number
Read Only:true
The line number used when a carried interest distribution record is reversed, reassigned, or redistributed. -
distributionLineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of carried interest distribution line, such as original, canceled, reversed, and so forth. -
enteredCurrencyCode: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
The currency code entered on the original transaction. -
expenditureType: string
Title:
Expenditure Type
Read Only:true
Maximum Length:240
The name identifying the expenditure classification. -
expenditureTypeDescription: string
Title:
Expenditure Type Description
Read Only:true
Maximum Length:2000
The description of the expenditure type. -
jointVenture: string
Title:
Joint Venture
Read Only:true
Maximum Length:30
The name of the joint venture associated with the carried interest distribution. -
jointVentureDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the joint venture associated with the carried interest distribution. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture distribution was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture distribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nonConsentingDistributedAccountedCredit: number
Title:
Nonconsenting Stakeholder Distributed Accounted Credit
Read Only:true
The distributed credit amount for the nonconsenting stakeholder in the accounting currency. -
nonConsentingDistributedAccountedDebit: number
Title:
Nonconsenting Stakeholder Distributed Accounted Debit
Read Only:true
The distributed debit amount for the nonconsenting stakeholder in the accounting currency. -
nonConsentingDistributedEnteredCredit: number
Title:
Nonconsenting Stakeholder Distributed Entered Credit
Read Only:true
The distributed credit amount for the nonconsenting stakeholder in the entered currency. -
nonConsentingDistributedEnteredDebit: number
Title:
Nonconsenting Stakeholder Distributed Entered Debit
Read Only:true
The distributed debit amount for the nonconsenting stakeholder in the entered currency. -
nonConsentingPercentage: number
Title:
Nonconsenting Source Percentage
Read Only:true
The nonconsenting stakeholder's ownership percentage from the source ownership definition. -
nonConsentingStakeholder: string
Title:
Nonconsenting Stakeholder
Read Only:true
Maximum Length:30
The name of the nonconsenting stakeholder on the carried interest distribution. -
projectName: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project. -
projectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The unique identifier of the project. -
source: string
Title:
Source
Read Only:true
Maximum Length:255
The source of the joint venture transaction that the distribution was created from. -
status: string
Title:
Status
Read Only:true
Maximum Length:80
The status of the carried interest distribution. -
taskName: string
Title:
Task Name
Read Only:true
Maximum Length:255
The name of the project task representing a subdivision of work. -
taskNumber: string
Title:
Task Number
Read Only:true
Maximum Length:100
The unique number of the project task. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The transaction date of the carried interest distribution.
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 a carried interest distribution by submitting a GET request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/vnd.oracle.adf.resourcecollection+json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestDistributions/100100940466980"
Response Body Example
The following shows an example of the response body in JSON format.
{ "distributionId":100100940466980, "jointVenture":"NWWYOMING", "jointVentureDescription":"North West Wyoming Oil Fields - Perm", "agreement":"CI_NWWYOMING_TEXARKANA", "agreementDescription":"Carried Interest Agreement for Non-consenting stakeholder Texarkana in NW Wyoming JV", "consentingStakeholder":"LARGEANDASSOCIATES", "consentingPercentage":20, "nonConsentingStakeholder":"TEXARKANAPETROLEUM", "nonConsentingPercentage":30, "transactionDate":"2017-02-18", "distributedAccountedDebit":null, "distributedAccountedCredit":300, "nonConsentingDistributedAccountedDebit":null, "nonConsentingDistributedAccountedCredit":1500, "accountedCurrencyCode":"USD", "distributedEnteredDebit":null, "distributedEnteredCredit":300, "nonConsentingDistributedEnteredDebit":null, "nonConsentingDistributedEnteredCredit":1500, "enteredCurrencyCode":"USD", "projectName":null, "projectNumber":null, "taskName":null, "taskNumber":null, "expenditureType":null, "expenditureTypeDescription":null, "source":"Subledger", "createdBy":"username", "creationDate":"2022-11-04T11:20:04+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2022-11-04T11:20:04+00:00", "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestDistributions/100100940466980", "name":"carriedInterestDistributions", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestDistributions/100100940466980", "name":"carriedInterestDistributions", "kind":"item" } ] }