Jump to

• Request
• Response
• Examples

Update a carried interest generated distribution

patch

/fscmRestApi/resources/11.13.18.05/carriedInterestGeneratedDistributions/{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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• status: string
  Title: Status

  Maximum Length: 80

  The status of the carried interest distribution.

{
    "type":"object",
    "properties":{
        "status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the carried interest distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : carriedInterestGeneratedDistributions-item-response

Type: object

Show Source

• accountedCurrency: 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.
• accountingHeaderId: integer (int64)
  Title: Accounting Header ID

  Read Only: true

  The unique identifier of the joint venture accounting header.
• 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.
• 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.
• carriedInterestOwnershipDefinitionEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the effective date range of the ownership definition.
• carriedInterestOwnershipDefinitionStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the effective date range of the ownership definition.
• 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.
• distributedAccount: string
  Title: Account

  Read Only: true

  Maximum Length: 255

  The combination of the values of the account segments assigned to the transaction.
• 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.
• distributionType: string
  Title: Distribution Type

  Read Only: true

  Maximum Length: 80

  Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals.
• expenditureType: string
  Title: Expenditure Type

  Read Only: true

  Maximum Length: 240

  The name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments.
• expenditureTypeDescription: string
  Title: 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.
• 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: 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 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.
• notes: string
  Title: Notes

  Read Only: true

  Maximum Length: 240

  Additional details about the joint venture source transaction.
• 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.
• project: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project.
• projectCostingStatus: string
  Title: Project Costing Status

  Read Only: true

  Maximum Length: 80

  The status of the joint venture accounting entries exported to the Project Costing system.
• projectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The unique identifier of the project.
• sourceOwnershipDefinition: string
  Title: Source Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition used as the basis for creating the carried interest ownership definition.
• sourceOwnershipDefinitionEndDate: 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.
• sourceOwnershipDefinitionStartDate: 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.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the carried interest distribution.
• task: 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.
• transactionCredit: number
  Title: Transaction Credit

  Read Only: true

  The credit amount of the joint venture source transaction.
• transactionCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency of the transaction amount.
• 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.

{
    "type":"object",
    "properties":{
        "distributedAccountedDebit":{
            "title":"Consenting Stakeholder Carried Accounted Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnit":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionType":{
            "title":"Distribution Type",
            "maxLength":"80",
            "type":"string",
            "description":"Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "maxLength":"240",
            "type":"string",
            "description":"Additional details about the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "projectCostingStatus":{
            "title":"Project Costing Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the joint venture accounting entries exported to the Project Costing system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "project":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDescription":{
            "title":"Transaction Description",
            "maxLength":"240",
            "type":"string",
            "description":"A description that's passed into the joint venture invoice for the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipDefinitionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition that's the source of the carried interest ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the joint venture associated with the carried interest distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributionId":{
            "title":"Original Distribution ID",
            "type":"integer",
            "description":"The unique identifier of the original carried interest distribution line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture associated with the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "carriedInterestOwnershipDefinition":{
            "title":"Carried Interest Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition used to process the distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingPeriod":{
            "title":"Accounting Period",
            "maxLength":"15",
            "type":"string",
            "description":"The name of the fiscal period that the source transaction is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestOwnershipDefinitionStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expenditureType":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCurrency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the transaction amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "basisSource":{
            "title":"Basis Source",
            "maxLength":"80",
            "type":"string",
            "description":"The source of the overhead calculation amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the agreement of the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":"240",
            "type":"string",
            "description":"Additional text to describe the reason the carried interest distribution was changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "method":{
            "title":"Method",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "nonConsentingDistributedAccountedCredit":{
            "title":"Nonconsenting Stakeholder Distributed Accounted Credit",
            "type":"number",
            "description":"The distributed credit amount for the nonconsenting stakeholder in the accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipDefinitionStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition that's the source of the carried interest ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "nonConsentingPercentage":{
            "title":"Nonconsenting Stakeholder Source Percentage",
            "type":"number",
            "description":"The nonconsenting stakeholder's ownership percentage from the source ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the agreement of the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier for the joint venture transaction that the distribution was created from.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "task":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project task representing a subdivision of work.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "nonConsentingStakeholder":{
            "title":"Nonconsenting Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the nonconsenting stakeholder on the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the carried interest distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "accountedCurrency":{
            "title":"Accounting Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of accounting currency of the source joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestOwnershipDefinitionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expenditureTypeDescription":{
            "title":"Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the expenditure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture accounting header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "nonConsentingDistributedAccountedDebit":{
            "title":"Nonconsenting Stakeholder Distributed Accounted Debit",
            "type":"number",
            "description":"The distributed debit amount for the nonconsenting stakeholder in the accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionId":{
            "title":"Carried Interest Distribution ID",
            "type":"integer",
            "description":"The unique identifier of a carried interest distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "originalConsentingStakeholder":{
            "title":"Original Consenting Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The joint venture stakeholder that was the original consenting stakeholder assuming the share for the nonconsenting stakeholder on the distribution line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "methodType":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The method type used to determine how the overhead amount is calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipDefinition":{
            "title":"Source Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition used as the basis for creating the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCredit":{
            "title":"Transaction Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionLineNumber":{
            "title":"Distribution Line Number",
            "type":"integer",
            "description":"The line number used when a carried interest distribution record is reversed, reassigned, or redistributed.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ledger":{
            "title":"Ledger",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "methodDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingDate":{
            "title":"Accounting Date",
            "type":"string",
            "description":"The date used to determine the accounting period for the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason the carried interest distribution was changed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionLineType":{
            "title":"Distribution Line Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of carried interest distribution line, such as original, canceled, reversed, and so forth.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedAccount":{
            "title":"Account",
            "maxLength":"255",
            "type":"string",
            "description":"The combination of the values of the account segments assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "codeCombinationIdST",
                    "structureInstanceNumberJV"
                ]
            },
            "x-queryable":true
        },
        "projectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedAccountedCredit":{
            "title":"Consenting Stakeholder Carried Accounted Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The transaction date of the carried interest distribution.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionType":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the joint venture source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "taskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique number of the project task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "consentingStakeholder":{
            "title":"Consenting Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the consenting stakeholder on the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "consentingPercentage":{
            "title":"Consenting Stakeholder Carried Percentage",
            "type":"number",
            "description":"The percentage of the nonconsenting stakeholder's share that's assumed by the consenting stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDebit":{
            "title":"Transaction Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

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

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestGeneratedDistributions/100105348631606" 

Example Request Body

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

{
    "status": "On hold"
}

Example Response Body

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

{
    "distributionId": 100105348631606,
    "status": "On hold",
    "distributionLineType": "Original",
    "distributionLineNumber": 1,
    "originalDistributionId": null,
    "transactionId": 100105348630257,
    "jointVenture": "APOLLOBASIN",
    "jointVentureDescription": "Oklahoma panhandle project",
    "businessUnit": "HEPP Petroleum USA BU1",
    "agreement": "CIA2",
    "agreementDescription": null,
    "nonConsentingStakeholder": "GOILMEX_ASH6",
    "nonConsentingPercentage": 10,
    "consentingStakeholder": "BARNCASPER",
    "consentingPercentage": 40,
    "originalConsentingStakeholder": null,
    "distributedAccountedDebit": 36,
    "distributedAccountedCredit": null,
    "nonConsentingDistributedAccountedDebit": 90,
    "nonConsentingDistributedAccountedCredit": null,
    "accountedCurrency": "USD",
    "carriedInterestOwnershipDefinition": "CIOPD",
    "carriedInterestOwnershipDefinitionStartDate": "2017-01-01",
    "carriedInterestOwnershipDefinitionEndDate": "2017-12-31",
    "sourceOwnershipDefinition": "ORIGINAL",
    "sourceOwnershipDefinitionStartDate": "2017-01-01",
    "sourceOwnershipDefinitionEndDate": "2017-12-31",
    "transactionType": "Overhead",
    "distributionType": "Overhead",
    "transactionDate": "2017-02-02",
    "accountingPeriod": "Feb-17",
    "ledger": "HEPPLedger US",
    "transactionDebit": 900,
    "transactionCredit": null,
    "transactionCurrency": "USD",
    "transactionDescription": "OH_BA0505212350",
    "method": "OH_APOLLOGLOBAL1805210359",
    "methodDescription": "Overhead for APOLLOGLOBAL",
    "methodType": "Percentage of cost",
    "basisSource": "Joint venture billed transactions",
    "projectCostingStatus": "Not applicable",
    "projectNumber": null,
    "project": null,
    "taskNumber": null,
    "task": null,
    "expenditureType": null,
    "expenditureTypeDescription": null,
    "changeReason": null,
    "changeReasonDetails": null,
    "accountingHeaderId": null,
    "createdBy": "username",
    "creationDate": "2024-02-19T07:16:15+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2024-02-21T06:20:39+00:00",
    "distributedAccount": "11-1001-56120-11-0001",
    "notes": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestGeneratedDistributions/100105348631606",
            "name": "carriedInterestGeneratedDistributions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestGeneratedDistributions/100105348631606",
            "name": "carriedInterestGeneratedDistributions",
            "kind": "item"
        }
    ]
}

Back to Top