Update a carried interest overhead distribution

patch

/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/{distributionId}

Request

Path Parameters
  • 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=
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : carriedInterestOverheadDistributions-item-response
Type: object
Show Source
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency code of accounting currency of the source joint venture transaction.
  • Title: Accounting Header ID
    Read Only: true
    The unique identifier of the joint venture accounting header.
  • Title: Account Type
    Read Only: true
    Maximum Length: 80
    Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the agreement of the carried interest distribution.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the agreement of the carried interest distribution.
  • Title: Basis Source
    Read Only: true
    Maximum Length: 80
    The source of the overhead calculation amount.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the business unit associated with the joint venture.
  • Title: Carried Interest Ownership Definition
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition used to process the distribution.
  • Title: Change Reason
    Read Only: true
    Maximum Length: 80
    The reason the carried interest distribution was changed.
  • Title: Change Reason Details
    Read Only: true
    Maximum Length: 240
    Additional text to describe the reason the carried interest distribution was changed.
  • Title: Consenting Stakeholder Carried Percentage
    Read Only: true
    The percentage of the nonconsenting stakeholder's share that's assumed by the consenting stakeholder.
  • Title: Consenting Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the consenting stakeholder on the carried interest distribution.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture distribution.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture distribution was created.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Consenting Stakeholder Carried Accounted Credit
    Read Only: true
    The distributed credit amount for the stakeholder in accounting currency.
  • Title: Consenting Stakeholder Carried Accounted Debit
    Read Only: true
    The distributed debit amount for the stakeholder in accounting currency.
  • Title: Carried Interest Distribution ID
    Read Only: true
    The unique identifier of a carried interest distribution.
  • Title: Distribution Line Number
    Read Only: true
    The line number used when a carried interest distribution record is reversed, reassigned, or redistributed.
  • 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.
  • Title: End Date
    The end date of the effective date range of the ownership definition.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The name of the joint venture associated with the carried interest distribution.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture associated with the carried interest distribution.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the joint venture distribution was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the joint venture distribution.
  • Title: Ledger
    Read Only: true
    Maximum Length: 30
    The name of the ledger.
  • Links
  • Title: Method
    Read Only: true
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Method Description
    Read Only: true
    Maximum Length: 240
    The description of the overhead method.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The method type used to determine how the overhead amount is calculated.
  • Title: Nonconsenting Stakeholder Distributed Accounted Credit
    Read Only: true
    The distributed credit amount for the nonconsenting stakeholder in the accounting currency.
  • Title: Nonconsenting Stakeholder Distributed Accounted Debit
    Read Only: true
    The distributed debit amount for the nonconsenting stakeholder in the accounting currency.
  • Title: Nonconsenting Stakeholder Source Percentage
    Read Only: true
    The name of the nonconsenting stakeholder on the carried interest distribution.
  • Title: Nonconsenting Stakeholder
    Read Only: true
    Maximum Length: 30
    The distributed debit amount for the nonconsenting stakeholder in the entered currency.
  • 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.
  • Title: Original Distribution ID
    Read Only: true
    The unique identifier of the original carried interest distribution line.
  • 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.
  • 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.
  • 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.
  • Title: Start Date
    The start date of the effective date range of the ownership definition.
  • Title: Status
    Maximum Length: 80
    The status of the carried interest distribution.
  • Title: Transaction Credit
    Read Only: true
    The credit amount of the joint venture source transaction.
  • Title: Transaction Date
    Read Only: true
    The transaction date of the carried interest distribution.
  • Title: Transaction Debit
    Read Only: true
    The debit amount of the joint venture source transaction.
  • 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.
  • Title: Transaction ID
    Read Only: true
    The unique identifier for the joint venture transaction that the distribution was created from.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The type of the joint venture source transaction.
Back to Top

Examples

The following example shows how to update a carried interest overhead distribution by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestSLADistributions/100102502551503"

Request Body Example

The following shows an example of the request body in JSON format.

{
  "status": "On hold"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "distributionId": 100102502551503,
  "jointVenture": "PERMIAN2",
  "jointVentureDescription": "Permian zone 2",
  "agreement": "CIPERM2",
  "agreementDescription": "Carried interest for Permian zone 2",
  "consentingStakeholder": "JVOPERATOR",
  "consentingPercentage": 40,
  "nonConsentingStakeholder": "LARGEANDASSOCIATES",
  "nonConsentingPercentage": 30,
  "distributedAccountedDebit": 7.2,
  "distributedAccountedCredit": null,
  "nonConsentingDistributedAccountedDebit": 18,
  "nonConsentingDistributedAccountedCredit": null,
  "accountedCurrencyCode": "USD",
  "carriedInterestOwnershipDefinition": "CIOPD",
  "startDate": "2017-01-01",
  "endDate": "2017-12-31",
  "sourceOwnershipDefinition": "ORIGINAL",
  "transactionDate": "2017-01-01",
  "transactionDebit": 60,
  "transactionCredit": null,
  "currencyCode": "USD",
  "transactionType": "Overhead",
  "method": "OHJVMCI050523190519",
  "methodDescription": "Permian overhead",
  "methodType": "Percentage of cost",
  "transactionDescription": "JVMCI050523190519",
  "basisSource": "General ledger and subledger transactions",
  "accountType": "Overhead",
  "transactionId": 100102590158279,
  "businessUnit": "HEPP Petroleum USA BU1",
  "ledger": "HEPPLedger US",
  "createdBy": "username",
  "creationDate": "2023-05-05T18:46:30+00:00",
  "lastUpdatedBy": "username",
  "lastUpdateDate": "2023-05-05T18:46:30+00:00",
  "distributionLineType": "Original",
  "distributionLineNumber": 1,
  "status": "On hold",
  "sourceOwnershipStartDate": "2017-01-01",
  "sourceOwnershipEndDate": "2017-12-31",
  "originalDistributionId": null,
  "originalConsentingStakeholder": null,
  "changeReason": null,
  "changeReasonDetails": null,
  "accountingHeaderId": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/100102502551503",
      "name": "carriedInterestOverheadDistributions",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/100102502551503",
      "name": "carriedInterestOverheadDistributions",
      "kind": "item"
    }
  ]
}
Back to Top