Jump to

• Request
• Response
• Examples

Update a carried interest general ledger distribution

patch

/fscmRestApi/resources/11.13.18.05/carriedInterestGLDistributions/{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 : carriedInterestGLDistributions-item-response

Type: object

Show Source

• 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.
• accountTypeCode: string
  Title: Account Type

  Read Only: true

  Maximum Length: 30

  The code that identifies 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.
• assignmentRule: string
  Title: Assignment Rule

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.
• 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.
• 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.
• 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: 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.
• enteredCurrencyCode: string
  Title: Entered Currency

  Read Only: true

  Maximum Length: 15

  The currency code entered on the original transaction.
• 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.
• 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 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.
• 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.
• period: string
  Title: Period Name

  Read Only: true

  Maximum Length: 15

  The accounting period name in a calendar.
• 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.
• transactionAccountedCredit: number
  Title: Transaction Accounted Credit

  Read Only: true

  The transaction credit amount in accounting currency.
• transactionAccountedDebit: number
  Title: Transaction Accounted Debit

  Read Only: true

  The transaction debit amount in accounting currency.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The transaction date of the carried interest distribution.
• transactionDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 240

  The description of the general ledger journal entry line.
• transactionEnteredCredit: number
  Title: Transaction Entered Credit

  Read Only: true

  The transaction credit amount in the entered currency.
• transactionEnteredDebit: number
  Title: Transaction Entered Debit

  Read Only: true

  The transaction debit amount in the entered currency.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  The unique identifier for the joint venture transaction that the distribution was created from.

{
    "type":"object",
    "properties":{
        "assignmentRule":{
            "title":"Assignment Rule",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "accountedCurrencyCode":{
            "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
        },
        "transactionEnteredDebit":{
            "title":"Transaction Entered Debit",
            "type":"number",
            "description":"The transaction debit amount in the entered 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
        },
        "endDate":{
            "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
        },
        "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
        },
        "nonConsentingDistributedEnteredDebit":{
            "title":"Nonconsenting Stakeholder Distributed Entered Debit",
            "type":"number",
            "description":"The distributed debit amount for the nonconsenting stakeholder in the entered currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDescription":{
            "title":"Transaction Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the general ledger journal entry line.",
            "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
        },
        "distributedEnteredDebit":{
            "title":"Consenting Stakeholder Carried Entered Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in the entered currency.",
            "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
        },
        "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
        },
        "period":{
            "title":"Period Name",
            "maxLength":15,
            "type":"string",
            "description":"The accounting period name in a calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Carried Interest 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
        },
        "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
        },
        "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
        },
        "accountTypeCode":{
            "title":"Account Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the type of transaction the distribution represents, such as expense, revenue, and so forth.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipEndDate":{
            "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
        },
        "accountType":{
            "title":"Account Type",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.",
            "nullable":false,
            "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
        },
        "enteredCurrencyCode":{
            "title":"Entered Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code entered on the original transaction.",
            "nullable":true,
            "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
        },
        "distributedEnteredCredit":{
            "title":"Consenting Stakeholder Carried Entered Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in the entered currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "startDate":{
            "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
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the carried interest distribution.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "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
        },
        "sourceOwnershipStartDate":{
            "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
        },
        "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
        },
        "transactionAccountedCredit":{
            "title":"Transaction Accounted Credit",
            "type":"number",
            "description":"The transaction credit amount in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipDefinition":{
            "title":"Source Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The original ownership definition assigned to the joint venture transaction that the distribution was created from.",
            "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
        },
        "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-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
        },
        "transactionAccountedDebit":{
            "title":"Transaction Accounted Debit",
            "type":"number",
            "description":"The transaction debit amount in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionEnteredCredit":{
            "title":"Transaction Entered Credit",
            "type":"number",
            "description":"The transaction credit amount in the entered currency.",
            "nullable":true,
            "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
        },
        "nonConsentingDistributedEnteredCredit":{
            "title":"Nonconsenting Stakeholder Distributed Entered Credit",
            "type":"number",
            "description":"The distributed credit amount for the nonconsenting stakeholder in the entered currency.",
            "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
        }
    }
}

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 general ledger 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/carriedInterestGLDistributions/100102502551557" 

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": 100102502551557,
  "transactionId": 100102502551430,
  "jointVenture": "PERMIAN2",
  "jointVentureDescription": "Permian zone 2",
  "agreement": "CIPERM2",
  "agreementDescription": "Carried interest for Permian zone 2",
  "consentingStakeholder": "JVOPERATOR",
  "consentingPercentage": 60,
  "nonConsentingStakeholder": "LARGEANDASSOCIATES",
  "nonConsentingPercentage": 10,
  "distributedAccountedDebit": 60,
  "distributedAccountedCredit": null,
  "transactionAccountedDebit": 1000,
  "transactionAccountedCredit": null,
  "nonConsentingDistributedAccountedDebit": 100,
  "nonConsentingDistributedAccountedCredit": null,
  "accountedCurrencyCode": "USD",
  "distributedEnteredDebit": 60,
  "distributedEnteredCredit": null,
  "transactionEnteredDebit": 1000,
  "transactionEnteredCredit": null,
  "nonConsentingDistributedEnteredDebit": 100,
  "nonConsentingDistributedEnteredCredit": null,
  "enteredCurrencyCode": "USD",
  "carriedInterestOwnershipDefinition": "CIOPD`",
  "startDate": "2017-01-01",
  "endDate": "2017-12-31",
  "sourceOwnershipDefinition": "ORIGINAL",
  "transactionDate": "2017-01-15",
  "period": "Jan-17",
  "accountTypeCode": "E",
  "businessUnit": "HEPP Petroleum USA BU1",
  "ledger": "HEPPLedger US",
  "distributedAccount": "11-1525-56120-11-0001",
  "transactionDescription": null,
  "assignmentRule": null,
  "createdBy": "username",
  "creationDate": "2023-05-03T13:22:34.462+00:00",
  "lastUpdatedBy": "username",
  "lastUpdateDate": "2023-05-03T13:31:20.101+00:00",
  "distributionLineType": "Canceled",
  "distributionLineNumber": 1,
  "status": "On hold",
  "sourceOwnershipStartDate": "2017-01-01",
  "sourceOwnershipEndDate": "2017-12-31",
  "originalDistributionId": 100102502551501,
  "originalConsentingStakeholder": "SAVY-B",
  "accountType": "Expense",
  "changeReason": null,
  "changeReasonDetails": null,
  "accountingHeaderId": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestGLDistributions/100102502551557",
      "name": "carriedInterestGLDistributions",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestGLDistributions/100102502551557",
      "name": "carriedInterestGLDistributions",
      "kind": "item"
    }
  ]
}

Back to Top