Jump to

• Request
• Response
• Examples

Get all carried interest overhead distributions

get

/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the carried interest distribution that matches the primary key criteria specified.
    Finder Variables
    • distributionId; integer; The unique identifier of a carried interest distribution.
  • distributionFinder Finds all carried interest overhead distributions that match the specified search criteria.
    Finder Variables
    • accountType; string; Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
    • agreement; string; The name of the agreement; string; of the carried interest distribution.
    • agreementDescription; string; The description of the agreement; string; of the carried interest distribution.
    • businessUnitId; string; The name of the business unit associated with the joint venture.
    • carriedInterestOwnershipDefinition; string; The name of the ownership definition used to process the distribution.
    • consentingPercentage; number; The percentage of the nonconsenting stakeholder's share that's assumed by the consenting stakeholder.
    • consentingStakeholder; string; The name of the consenting stakeholder on the carried interest distribution.
    • distributionLineType; string; The type of carried interest distribution line, such as original, canceled, reversed, and so forth.
    • endDate; string; The end date of the effective date range of the ownership definition.
    • jointVenture; string; The name of the joint venture associated with the carried interest distribution.
    • jointVentureDescription; string; The description of the joint venture associated with the carried interest distribution.
    • ledger; string; The name of the ledger; string; .
    • method; string; The unique name of the overhead method; string; .
    • methodDescription; string; The description of the overhead method; string; .
    • methodType; string; The method; string; type used to determine how the overhead amount is calculated.
    • nonConsentingPercentage; number; The nonconsenting stakeholder's ownership percentage from the source ownership definition.
    • nonConsentingStakeholder; string; The name of the nonconsenting stakeholder on the carried interest distribution.
    • originalConsentingStakeholder; string; The joint venture stakeholder that was the original consenting stakeholder assuming the share for the nonconsenting stakeholder on the distribution line.
    • searchAllText; string; A search value to identify carried interest distributions that contain the specified text in any of the string attributes.
    • sourceOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction that the distribution was created from.
    • startDate; string; The start date of the effective date range of the ownership definition.
    • status; string; The status; string; of the carried interest distribution.
    • transactionDate; string; The transaction date of the carried interest distribution.
    • transactionDescription; string; A description that's passed into the joint venture invoice for the joint venture source transaction.
    • transactionType; string; The type of the joint venture source transaction.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • accountType; string; Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • accountedCurrencyCode; string; The currency code of accounting currency of the source joint venture transaction.
  • accountingHeaderId; integer; The unique identifier of the joint venture accounting header.
  • agreement; string; The name of the agreement of the carried interest distribution.
  • agreementDescription; string; The description of the agreement of the carried interest distribution.
  • basisSource; string; The source of the overhead calculation amount.
  • businessUnit; string; The name of the business unit associated with the joint venture.
  • carriedInterestOwnershipDefinition; string; The name of the ownership definition used to process the distribution.
  • changeReason; string; The reason the carried interest distribution was changed.
  • changeReasonDetails; string; Additional text to describe the reason the carried interest distribution was changed.
  • consentingPercentage; number; The percentage of the nonconsenting stakeholder's share that's assumed by the consenting stakeholder.
  • consentingStakeholder; string; The name of the consenting stakeholder on the carried interest distribution.
  • createdBy; string; The user who created the joint venture distribution.
  • creationDate; string; The date and time when the joint venture distribution was created.
  • currencyCode; string; The currency of the transaction amount.
  • distributedAccountedCredit; number; The distributed credit amount for the stakeholder in accounting currency.
  • distributedAccountedDebit; number; The distributed debit amount for the stakeholder in accounting currency.
  • distributionId; integer; The unique identifier of a carried interest distribution.
  • distributionLineNumber; integer; The line number used when a carried interest distribution record is reversed, reassigned, or redistributed.
  • distributionLineType; string; The type of carried interest distribution line, such as original, canceled, reversed, and so forth.
  • endDate; string; The end date of the effective date range of the ownership definition.
  • jointVenture; string; The name of the joint venture associated with the carried interest distribution.
  • jointVentureDescription; string; The description of the joint venture associated with the carried interest distribution.
  • lastUpdateDate; string; The date and time when the joint venture distribution was last updated.
  • lastUpdatedBy; string; The user who last updated the joint venture distribution.
  • ledger; string; The name of the ledger.
  • method; string; The unique name of the overhead method.
  • methodDescription; string; The description of the overhead method.
  • methodType; string; The method type used to determine how the overhead amount is calculated.
  • nonConsentingDistributedAccountedCredit; number; The distributed credit amount for the nonconsenting stakeholder in the accounting currency.
  • nonConsentingDistributedAccountedDebit; number; The distributed debit amount for the nonconsenting stakeholder in the accounting currency.
  • nonConsentingPercentage; number; The name of the nonconsenting stakeholder on the carried interest distribution.
  • nonConsentingStakeholder; string; The distributed debit amount for the nonconsenting stakeholder in the entered currency.
  • originalConsentingStakeholder; string; The joint venture stakeholder that was the original consenting stakeholder assuming the share for the nonconsenting stakeholder on the distribution line.
  • originalDistributionId; integer; The unique identifier of the original carried interest distribution line.
  • sourceOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction that the distribution was created from.
  • sourceOwnershipEndDate; string; The end date of the effective date range of the ownership definition that's the source of the carried interest ownership definition.
  • sourceOwnershipStartDate; string; The start date of the effective date range of the ownership definition that's the source of the carried interest ownership definition.
  • startDate; string; The start date of the effective date range of the ownership definition.
  • status; string; The status of the carried interest distribution.
  • transactionCredit; number; The credit amount of the joint venture source transaction.
  • transactionDate; string; The transaction date of the carried interest distribution.
  • transactionDebit; number; The debit amount of the joint venture source transaction.
  • transactionDescription; string; A description that's passed into the joint venture invoice for the joint venture source transaction.
  • transactionId; integer; The unique identifier for the joint venture transaction that the distribution was created from.
  • transactionType; string; The type of the joint venture source transaction.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 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 : carriedInterestOverheadDistributions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestOverheadDistributions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object carriedInterestOverheadDistributions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestOverheadDistributions-item-response"
    }
}

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

{
    "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "transactionCredit":{
            "title":"Transaction Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "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
        },
        "methodDescription":{
            "title":"Method Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the overhead method.",
            "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":"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
        },
        "method":{
            "title":"Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the overhead method.",
            "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
        },
        "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 name of the nonconsenting stakeholder on the carried interest distribution.",
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "nonConsentingStakeholder":{
            "title":"Nonconsenting Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The distributed debit 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
        },
        "transactionDebit":{
            "title":"Transaction Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the transaction amount.",
            "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
        }
    }
}

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 retrieve all carried interest overhead distributions 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"

Response Body Example

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

{
   "items":[
      {
         "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"
            }
         ]
      },
      {
         "distributionId":100101009257283,
         "jointVenture":"TECHDEVPROJECTJV",
         "jointVentureDescription":"Technical enterprise project",
         "agreement":"TECHDEVCIAGREEMENT",
         "agreementDescription":"Carried Interest Agreement for Technical Development Project",
         "consentingStakeholder":"TECHDEVDRILLING",
         "consentingPercentage":40,
         "nonConsentingStakeholder":"TECHDEVPUMPING",
         "nonConsentingPercentage":30,
         "distributedAccountedDebit":7.2,
         "distributedAccountedCredit":null,
         "nonConsentingDistributedAccountedDebit":18,
         "nonConsentingDistributedAccountedCredit":null,
         "accountedCurrencyCode":"USD",
         "carriedInterestOwnershipDefinition":"TECHDEVCIAOPD",
         "startDate":"2017-01-01",
         "endDate":"2017-12-31",
         "sourceOwnershipDefinition":"EXPLORATIONDEVCIAOPD",
         "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/100101009257283",
               "name":"carriedInterestOverheadDistributions",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions/100101009257283",
               "name":"carriedInterestOverheadDistributions",
               "kind":"item"
            }
         ]
      },
     
   "count":2,
   "hasMore":false,
   "limit":25,
   "offset":0,
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestOverheadDistributions",
         "name":"carriedInterestOverheadDistributions",
         "kind":"collection"
      }
   ]
}

Back to Top