Get a carried interest overhead distribution
get
/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/{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 : carriedInterestOverheadDistributions-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. -
accountingHeaderId: integer
(int64)
Title:
Accounting Header ID
Read Only:true
The unique identifier of the joint venture accounting header. -
accountType: string
Title:
Account Type
Read Only:true
Maximum Length:80
Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth. -
agreement: string
Title:
Carried Interest 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. -
basisSource: string
Title:
Basis Source
Read Only:true
Maximum Length:80
The source of the overhead calculation amount. -
businessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the joint venture. -
carriedInterestOwnershipDefinition: string
Title:
Carried Interest Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used to process the distribution. -
changeReason: string
Title:
Change Reason
Read Only:true
Maximum Length:80
The reason the carried interest distribution was changed. -
changeReasonDetails: string
Title:
Change Reason Details
Read Only:true
Maximum Length:240
Additional text to describe the reason the carried interest distribution was changed. -
consentingPercentage: number
Title:
Consenting Stakeholder 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. -
currencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
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. -
distributionId: integer
(int64)
Title:
Carried Interest 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. -
endDate: string
(date)
Title:
End Date
Read Only:true
The end date of the effective date range of the ownership definition. -
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. -
ledger: string
Title:
Ledger
Read Only:true
Maximum Length:30
The name of the ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
method: string
Title:
Method
Read Only:true
Maximum Length:30
The unique name of the overhead method. -
methodDescription: string
Title:
Method Description
Read Only:true
Maximum Length:240
The description of the overhead method. -
methodType: string
Title:
Type
Read Only:true
Maximum Length:80
The method type used to determine how the overhead amount is calculated. -
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. -
nonConsentingPercentage: number
Title:
Nonconsenting Stakeholder Source Percentage
Read Only:true
The name of the nonconsenting stakeholder on the carried interest distribution. -
nonConsentingStakeholder: string
Title:
Nonconsenting Stakeholder
Read Only:true
Maximum Length:30
The distributed debit amount for the nonconsenting stakeholder in the entered currency. -
originalConsentingStakeholder: string
Title:
Original Consenting Stakeholder
Read Only:true
Maximum Length:30
The joint venture stakeholder that was the original consenting stakeholder assuming the share for the nonconsenting stakeholder on the distribution line. -
originalDistributionId: integer
(int64)
Title:
Original Distribution ID
Read Only:true
The unique identifier of the original carried interest distribution line. -
sourceOwnershipDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The original ownership definition assigned to the joint venture transaction that the distribution was created from. -
sourceOwnershipEndDate: string
(date)
Title:
End Date
Read Only:true
The end date of the effective date range of the ownership definition that's the source of the carried interest ownership definition. -
sourceOwnershipStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the effective date range of the ownership definition that's the source of the carried interest ownership definition. -
startDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the effective date range of the ownership definition. -
status: string
Title:
Status
Maximum Length:80
The status of the carried interest distribution. -
transactionCredit: number
Title:
Transaction Credit
Read Only:true
The credit amount of the joint venture source transaction. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The transaction date of the carried interest distribution. -
transactionDebit: number
Title:
Transaction Debit
Read Only:true
The debit amount of the joint venture source transaction. -
transactionDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
A description that's passed into the joint venture invoice for the joint venture source transaction. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier for the joint venture transaction that the distribution was created from. -
transactionType: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the joint venture source transaction.
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 overhead 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/carriedInterestOverheadDistributions/100101009257284"
Response Body Example
The following shows an example of the response body in JSON format.
{ "distributionId":100101009257284, "jointVenture":"GLOBALDEVPROJECTJV", "jointVentureDescription":"Global enterprise project", "agreement":"GLOBALDEVCIAGREEMENT", "agreementDescription":"Carried Interest Agreement for Global Development Project", "consentingStakeholder":"GLOBALDEVDRILLING", "consentingPercentage":60, "nonConsentingStakeholder":"GLOBALDEVTECHNICAL", "nonConsentingPercentage":30, "distributedAccountedDebit":10.8, "distributedAccountedCredit":null, "nonConsentingDistributedAccountedDebit":18, "nonConsentingDistributedAccountedCredit":null, "accountedCurrencyCode":"USD", "carriedInterestOwnershipDefinition":"GLOBALDEVCIAOPD", "startDate":"2017-01-01", "endDate":"2017-12-31", "sourceOwnershipDefinition":"AUTODEVCIAOPD", "transactionDate":"2017-01-01", "transactionDebit":60, "transactionCredit":null, "currencyCode":"USD", "transactionType":"Overhead", "method":"OHJVMCI110720220602", "methodDescription":"CI Automation OH", "methodType":"Percentage of cost", "transactionDescription":"OHJVMCI110720220602", "basisSource":"General ledger and subledger transactions", "accountType":"Overhead", "transactionId":100101009257269, "businessUnit":"HEPP Petroleum USA BU1", "ledger":"HEPPLedger US", "createdBy":"username", "creationDate":"2022-11-10T12:41:15+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2022-11-10T12:41:15+00:00", "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/100101009257284", "name":"carriedInterestOverheadDistributions", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/100101009257284", "name":"carriedInterestOverheadDistributions", "kind":"item" } ] }