Jump to

• Request
• Response
• Examples

Get all carried interest agreements

get

/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements

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 agreement; string; that matches the primary key specified.
    Finder Variables
    • agreementId; integer; The unique identifier of the carried interest agreement; string; .
  • agreementFinder Finds all carried interest agreements that match the specified search criteria.
    Finder Variables
    • agreement; string; The name of the carried interest agreement; string; .
    • agreementDescription; string; The description of the carried interest agreement; string; .
    • endDate; string; The end date of the carried interest agreement; string; .
    • jointVenture; string; The unique name of the joint venture.
    • searchAllText; string; A search value to identify carried interest agreements that contain the specified text in any of the string attributes.
    • startDate; string; The start date of the carried interest agreement; string; .
    • status; string; The status; string; of the carried interest agreement; string; .
• 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:
  

  • agreement; string; The name of the carried interest agreement.
  • agreementDescription; string; The description of the carried interest agreement.
  • agreementId; integer; The unique identifier of the carried interest agreement.
  • createdBy; string; The user who created the resource item.
  • creationDate; string; The date and time when the resource item was created.
  • endDate; string; The end date of the carried interest agreement.
  • jointVenture; string; The unique name of the joint venture.
  • jointVentureDescription; string; The description of the joint venture.
  • lastUpdateDate; string; The date and time when the resource item was last updated.
  • lastUpdatedBy; string; The user who last updated the resource item.
  • startDate; string; The start date of the carried interest agreement.
  • status; string; The status of the carried interest agreement.
• 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: string
  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: string
  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 : carriedInterestAgreements

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/carriedInterestAgreements-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object carriedInterestAgreements-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-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 : carriedInterestAgreements-item-response

Type: object

Show Source

• agreement: string
  Title: Agreement

  Maximum Length: 30

  The name of the carried interest agreement.
• agreementDescription: string
  Title: Description

  Maximum Length: 240

  The description of the carried interest agreement.
• agreementDFF: array agreementDFF
• agreementId: integer (int64)
  Title: Carried Interest Agreement ID

  Read Only: true

  The unique identifier of the carried interest agreement.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• endDate: string (date)
  Title: End Date

  The end date of the carried interest agreement.
• jointVenture: string
  Title: Joint Venture

  Maximum Length: 80

  The unique name of the joint venture.
• jointVentureDescription: string
  Title: Description

  Maximum Length: 80

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• stakeholderGroups: array Stakeholder Groups
  Title: Stakeholder Groups

  The stakeholder groups resource is used to view, create, update, or delete stakeholder groups for a carried interest agreement.
• startDate: string (date)
  Title: Start Date

  The start date of the carried interest agreement.
• status: string
  Title: Status

  Maximum Length: 80

  The status of the carried interest agreement.

{
    "type":"object",
    "properties":{
        "stakeholderGroups":{
            "title":"Stakeholder Groups",
            "type":"array",
            "description":"The stakeholder groups resource is used to view, create, update, or delete stakeholder groups for a carried interest agreement.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-item-response"
            }
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"The name of the carried interest agreement.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the carried interest agreement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the carried interest agreement.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":80,
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementId":{
            "title":"Carried Interest Agreement ID",
            "type":"integer",
            "description":"The unique identifier of the carried interest agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Description",
            "maxLength":80,
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "agreementDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-agreementDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the carried interest agreement.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the carried interest agreement.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : agreementDFF

Type: array

Show Source

• Array of: object carriedInterestAgreements-agreementDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-agreementDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : Stakeholder Groups

Type: array

Title: Stakeholder Groups

The stakeholder groups resource is used to view, create, update, or delete stakeholder groups for a carried interest agreement.

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-item-response

{
    "title":"Stakeholder Groups",
    "type":"array",
    "description":"The stakeholder groups resource is used to view, create, update, or delete stakeholder groups for a carried interest agreement.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-item-response"
    }
}

Nested Schema : carriedInterestAgreements-agreementDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• AgreementId: integer (int64)
  Title: Carried Interest Agreement ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgreementId":{
            "title":"Carried Interest Agreement ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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."
        }
    }
}

Nested Schema : carriedInterestAgreements-stakeholderGroups-item-response

Type: object

Show Source

• changeReason: string
  Title: Change Reason

  Maximum Length: 80

  The reason for the change to the carried interest ownership definition.
• changeReasonDetails: string
  Title: Change Reason Details

  Maximum Length: 240

  Additional text to describe the reason the carried interest ownership definition was changed.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• distributionsExistFlag: boolean
  Title: Distributions Exist

  Read Only: true

  Maximum Length: 1

  Indicates whether there are existing joint venture distributions that are assigned a carried interest ownership definition for the stakeholder group.
• endDate: string (date)
  Title: End Date

  The end date of the effective date range of the stakeholder group.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ownershipDefinitions: array Ownership Definitions
  Title: Ownership Definitions

  The ownership definitions resource is used to view, create, update, or delete an ownership definition associated with a joint venture. Joint Venture Management uses the ownership definition to calculate the split of costs and revenue among the stakeholders or partners in a joint venture.
• stakeholderGroup: string
  Title: Stakeholder Group

  Maximum Length: 30

  The name of the stakeholder group.
• stakeholderGroupDescription: string
  Title: Description

  Maximum Length: 240

  The description of the stakeholder group.
• stakeholderGroupDFF: array stakeholderGroupDFF
• stakeholderGroupId: integer (int64)
  Title: Stakeholder Group ID

  Read Only: true

  The unique identifier of the stakeholder group.
• stakeholderPercentages: array Stakeholder Percentages
  Title: Stakeholder Percentages

  The stakeholder percentages resource is used to view, create, update, or delete stakeholder percentages for a stakeholder group.
• startDate: string (date)
  Title: Start Date

  The start date of the effective date range of the stakeholder group.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionsExistFlag":{
            "title":"Distributions Exist",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether there are existing joint venture distributions that are assigned a carried interest ownership definition for the stakeholder group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":240,
            "type":"string",
            "description":"Additional text to describe the reason the carried interest ownership definition was changed.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The reason for the change to the carried interest ownership definition.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the stakeholder group.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderGroupDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the stakeholder group.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderPercentages":{
            "title":"Stakeholder Percentages",
            "type":"array",
            "description":"The stakeholder percentages resource is used to view, create, update, or delete stakeholder percentages for a stakeholder group.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response"
            }
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderGroupId":{
            "title":"Stakeholder Group ID",
            "type":"integer",
            "description":"The unique identifier of the stakeholder group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "stakeholderGroupDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderGroupDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "stakeholderGroup":{
            "title":"Stakeholder Group",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder group.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the stakeholder group.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ownershipDefinitions":{
            "title":"Ownership Definitions",
            "type":"array",
            "description":"The ownership definitions resource is used to view, create, update, or delete an ownership definition associated with a joint venture. Joint Venture Management uses the ownership definition to calculate the split of costs and revenue among the stakeholders or partners in a joint venture.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-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 : Ownership Definitions

Type: array

Title: Ownership Definitions

The ownership definitions resource is used to view, create, update, or delete an ownership definition associated with a joint venture. Joint Venture Management uses the ownership definition to calculate the split of costs and revenue among the stakeholders or partners in a joint venture.

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-response

{
    "title":"Ownership Definitions",
    "type":"array",
    "description":"The ownership definitions resource is used to view, create, update, or delete an ownership definition associated with a joint venture. Joint Venture Management uses the ownership definition to calculate the split of costs and revenue among the stakeholders or partners in a joint venture.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-response"
    }
}

Nested Schema : stakeholderGroupDFF

Type: array

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-stakeholderGroupDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderGroupDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Stakeholder Percentages

Type: array

Title: Stakeholder Percentages

The stakeholder percentages resource is used to view, create, update, or delete stakeholder percentages for a stakeholder group.

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response

{
    "title":"Stakeholder Percentages",
    "type":"array",
    "description":"The stakeholder percentages resource is used to view, create, update, or delete stakeholder percentages for a stakeholder group.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response"
    }
}

Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-response

Type: object

Show Source

• activeFlag: boolean
  Title: Invoicing Partner Active

  Read Only: true

  Ownership Definition Active
• agreement: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  The name of the carried interest agreement.
• changeReason: string
  Title: Change Reason

  Maximum Length: 255

  Indicates the reason for changing the effective dates on the ownership definition.
• changeReasonAdditionalText: string
  Title: Change Reason Additional Information

  Maximum Length: 240

  Additional information describing the reason for changing the ownership definition.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the ownership definition.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time the ownership definition was created.
• defaultOwnershipDefinitionFlag: boolean
  Title: Default Ownership Definition

  Read Only: true

  Indicates that the ownership definition is the default ownership definition of the joint venture.
• distributionExist: string
  Title: Distributions Exist

  Read Only: true

  Indicates whether joint venture distributions exist for the ownership definition.
• effectiveEndDate: string (date)
  Title: End Date

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

  The start date of the effective date range of the ownership definition.
• externalStakeholderExistsFlag: boolean
  Title: External Stakeholder Exists

  Read Only: true

  Internal Stakeholder Exists
• internalStakeholderExistsFlag: boolean
  Title: Internal Stakeholder Exists

  Read Only: true

  External Stakeholder Exists
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• jointVentureName: string
  Title: Joint Venture Name

  Read Only: true

  Maximum Length: 30

  The name of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the ownership definition was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the ownership definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ownershipChangeFlag: boolean
  Title: Ownership Definition Changed

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled.
• ownershipDefinitionDescription: string
  Title: Description

  Maximum Length: 240

  A description of the ownership definition.
• ownershipDefinitionId: integer (int64)
  Title: Ownership Definition ID

  Read Only: true

  The unique identifier of the ownership definition.
• ownershipDefinitionShortName: string
  Title: Ownership Definition

  Maximum Length: 30

  The short name of the ownership definition that's used as an identifier across effective dates for the joint venture.
• ownershipDefinitionStatus: string
  Title: Status

  Maximum Length: 255

  The status of the ownership definition.
• ownershipPercentages: array Ownership Percentages
  Title: Ownership Percentages

  The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition.
• ownershipVersion: integer (int32)
  Title: Ownership Definition Version

  Read Only: true

  The version number of the ownership definition.
• 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.
• sourceOwnershipDefinitionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the ownership definition used as the basis for creating the carried interest ownership definition.
• stakeholderGroup: string
  Title: Stakeholder Group

  Read Only: true

  Maximum Length: 30

  The name of the stakeholder group associated with the carried interest ownership definition.
• stakeholderGroupDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the stakeholder group associated with the carried interest ownership definition.
• totalPercentage: number
  Title: Total Percentage

  Read Only: true

  The sum of all percentages of ownership in the ownership definition.

{
    "type":"object",
    "properties":{
        "effectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ownershipVersion":{
            "title":"Ownership Definition Version",
            "type":"integer",
            "description":"The version number of the ownership definition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the ownership definition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionShortName":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The short name of the ownership definition that's used as an identifier across effective dates for the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ownershipDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A description of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "effectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ownershipDefinitionId":{
            "title":"Ownership Definition ID",
            "type":"integer",
            "description":"The unique identifier of the ownership definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "externalStakeholderExistsFlag":{
            "title":"External Stakeholder Exists",
            "type":"boolean",
            "description":"Internal Stakeholder Exists",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalPercentage":{
            "title":"Total Percentage",
            "type":"number",
            "description":"The sum of all percentages of ownership in the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderGroup":{
            "title":"Stakeholder Group",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder group associated with the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "activeFlag":{
            "title":"Invoicing Partner Active",
            "type":"boolean",
            "description":"Ownership Definition Active",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ownership definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "agreement":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"The name of the carried interest agreement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "defaultOwnershipDefinitionFlag":{
            "title":"Default Ownership Definition",
            "type":"boolean",
            "description":"Indicates that the ownership definition is the default ownership definition of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the reason for changing the effective dates on the ownership definition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode1"
                ]
            },
            "x-queryable":true
        },
        "stakeholderGroupDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the stakeholder group associated with the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "sourceOwnershipDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the ownership definition used as the basis for creating the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ownershipPercentages":{
            "title":"Ownership Percentages",
            "type":"array",
            "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition.",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response"
            }
        },
        "jointVentureName":{
            "title":"Joint Venture Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the ownership definition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionExist":{
            "title":"Distributions Exist",
            "type":"string",
            "description":"Indicates whether joint venture distributions exist for the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "changeReasonAdditionalText":{
            "title":"Change Reason Additional Information",
            "maxLength":240,
            "type":"string",
            "description":"Additional information describing the reason for changing the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ownership definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipChangeFlag":{
            "title":"Ownership Definition Changed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "internalStakeholderExistsFlag":{
            "title":"Internal Stakeholder Exists",
            "type":"boolean",
            "description":"External Stakeholder Exists",
            "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 : Ownership Percentages

Type: array

Title: Ownership Percentages

The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition.

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response

{
    "title":"Ownership Percentages",
    "type":"array",
    "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder's percentage of ownership in an ownership definition. The percentages must total 100% for all stakeholders in the ownership definition.",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response"
    }
}

Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the ownership percentage.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the ownership percentage was created.
• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Indicates that the joint venture stakeholder is only participating in the transaction distribution and isn't being billed.
• internalStakeholderFlag: boolean
  Title: Stakeholder Type

  Read Only: true

  Maximum Length: 1

  Indicates that the joint venture stakeholder is an internal stakeholder.
• invoicingPartnerId: integer (int64)
  Title: Invoicing Partner ID

  Read Only: true

  The unique identifier of the invoicing partner.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the ownership percentage was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the ownership percentage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ownershipDefinitionName: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition.
• ownershipPercentageId: integer (int64)
  Title: Ownership Percentage ID

  Read Only: true

  The unique identifier of the ownership percentage.
• percentageOfInterest: number
  Title: Ownership Percentage

  Default Value: 0

  The ownership percentage a stakeholder has in a joint venture transaction.
• roundingPartnerFlag: boolean
  Title: Rounding Partner

  Maximum Length: 1

  Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.
• stakeholderDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture stakeholder.
• stakeholderName: string
  Title: Stakeholder

  The name of the joint venture stakeholder.

{
    "type":"object",
    "properties":{
        "roundingPartnerFlag":{
            "title":"Rounding Partner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ownership percentage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the ownership percentage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the ownership percentage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ownershipDefinitionName":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderName":{
            "title":"Stakeholder",
            "type":"string",
            "description":"The name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ownership percentage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipPercentageId":{
            "title":"Ownership Percentage ID",
            "type":"integer",
            "description":"The unique identifier of the ownership percentage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "internalStakeholderFlag":{
            "title":"Stakeholder Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is an internal stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "invoicingPartnerId":{
            "title":"Invoicing Partner ID",
            "type":"integer",
            "description":"The unique identifier of the invoicing partner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "percentageOfInterest":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The ownership percentage a stakeholder has in a joint venture transaction.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is only participating in the transaction distribution and isn't being billed.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "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 : carriedInterestAgreements-stakeholderGroups-stakeholderGroupDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StakeholderGroupId: integer (int64)
  Title: Stakeholder Group ID

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StakeholderGroupId":{
            "title":"Stakeholder Group ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response

Type: object

Show Source

• carriedInterestAccount: string
  Title: Carried Interest Account

  Maximum Length: 255

  The formatted account combination for the carried interest account used when creating a carried interest journal.
• carriedInterestPercentage: number
  Title: Percentage

  The percentage of a nonconsenting stakeholder's interest assumed by a consenting stakeholder.
• consentingStakeholder: string
  Title: Consenting Stakeholder

  Maximum Length: 80

  The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.
• consentingStakeholderDescription: string
  Title: Description

  Maximum Length: 240

  The description of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• createJournalsFlag: boolean
  Title: Create Journals

  Maximum Length: 1

  Indicates whether carried interest journals are created for carried interest distributions for the consenting stakeholder.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• nonConsentingStakeholder: string
  Title: Nonconsenting Stakeholder

  Maximum Length: 240

  The name of the nonconsenting stakeholder.
• nonConsentingStakeholderDescription: string
  Title: Description

  Maximum Length: 240

  The description of the nonconsenting stakeholder.
• stakeholderPercentageDFF: array stakeholderPercentageDFF
• stakeholderPercentageId: integer (int64)
  Title: Stakeholder Percentage ID

  Read Only: true

  The unique identifier of the stakeholder percentage.
• structureInstanceNumber: integer (int64)
  Title: Structure Instance Number

  Read Only: true

  The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderPercentageId":{
            "title":"Stakeholder Percentage ID",
            "type":"integer",
            "description":"The unique identifier of the stakeholder percentage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_StructureID":"defaultAccount",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderPercentageDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestAccount":{
            "title":"Carried Interest Account",
            "maxLength":255,
            "type":"string",
            "description":"The formatted account combination for the carried interest account used when creating a carried interest journal.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.definitions.model.view.StakeholderPercentageVO#defaultAccount",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "FND_ACFF_ResourceName":"stakeholderPercentages",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "coaInstanceNumberJV",
                    "structureInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "nonConsentingStakeholderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "nonConsentingStakeholder":{
            "title":"Nonconsenting Stakeholder",
            "maxLength":240,
            "type":"string",
            "description":"The name of the nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "stakeholderShortNameNCS"
                ]
            },
            "x-queryable":true
        },
        "consentingStakeholderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "createJournalsFlag":{
            "title":"Create Journals",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether carried interest journals are created for carried interest distributions for the consenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "consentingStakeholder":{
            "title":"Consenting Stakeholder",
            "maxLength":80,
            "type":"string",
            "description":"The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "stakeholderShortNameCS"
                ]
            },
            "x-queryable":true
        },
        "carriedInterestPercentage":{
            "title":"Percentage",
            "type":"number",
            "description":"The percentage of a nonconsenting stakeholder's interest assumed by a consenting stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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 : stakeholderPercentageDFF

Type: array

Show Source

• Array of: object carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• GroupLineId: integer (int64)
  Title: Stakeholder Group Line ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GroupLineId":{
            "title":"Stakeholder Group Line ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Back to Top

Examples

The following example shows how to retrieve all carried interest agreements 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/carriedInterestAgreements"

Response Body Example

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

{
   "items":[
      {
         "agreementId":300100563519843,
         "agreement":"CIPERM",
         "agreementDescription": "Carried interest for perm area",
         "jointVenture":"NWWYOMING",
         "jointVentureDescription":"North West Wyoming Oil Fields - Perm",
         "startDate":"2018-01-01",
         "endDate":null,
         "status":"Editing",
         "createdBy":"username",
         "creationDate":"2022-11-04T10:12:22+00:00",
         "lastUpdatedBy":"username",
         "lastUpdateDate":"2022-11-09T14:27:27.698+00:00",
         "links":[
            {
               "rel":"self",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519843",
               "name":"carriedInterestAgreements",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519843",
               "name":"carriedInterestAgreements",
               "kind":"item"
            },
            {
               "rel":"child",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519843/child/stakeholderGroups",
               "name":"stakeholderGroups",
               "kind":"collection"
            }
         ]
      },
      {
         "agreementId":300100563519829,
         "agreement":"CI_NWWYOMING_TEXARKANA",
         "agreementDescription":"Carried Interest Agreement for Non-consenting stakeholder Texarkana in NW Wyoming",
         "jointVenture":"NWWYOMING",
         "jointVentureDescription":"North West Wyoming Oil Fields - Perm",
         "startDate":"2017-01-01",
         "endDate":null,
         "status":"Editing",
         "createdBy":"username",
         "creationDate":"2022-11-04T09:29:03+00:00",
         "lastUpdatedBy":"username",
         "lastUpdateDate":"2022-11-09T14:27:27.703+00:00",
         "links":[
            {
               "rel":"self",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519829",
               "name":"carriedInterestAgreements",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519829",
               "name":"carriedInterestAgreements",
               "kind":"item"
            },
            {
               "rel":"child",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519829/child/stakeholderGroups",
               "name":"stakeholderGroups",
               "kind":"collection"
            }
         ]
      },
      {
         "agreementId":300100562536000,
         "agreement":"EQUITECHSOLUTION",
         "agreementDescription":"CI agreement with Equitech",
         "jointVenture":"BASINJV",
         "jointVentureDescription":"Basin area joint venture",
         "startDate":"2017-01-01",
         "endDate":"2017-12-31",
         "status":"Editing",
         "createdBy":"username",
         "creationDate":"2022-10-27T18:13:46+00:00",
         "lastUpdatedBy":"username",
         "lastUpdateDate":"2022-11-09T14:27:26.657+00:00",
         "links":[
            {
               "rel":"self",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100562536000",
               "name":"carriedInterestAgreements",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000778"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100562536000",
               "name":"carriedInterestAgreements",
               "kind":"item"
            },
            {
               "rel":"child",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100562536000/child/stakeholderGroups",
               "name":"stakeholderGroups",
               "kind":"collection"
            }
         ]
      },
      {
         "agreementId":300100563519858,
         "agreement":"CISEVENCORP",
         "agreementDescription":"Carried interest agreement for carrying the interest for Seven Corporation partner",
         "jointVenture":"DENVER13",
         "jointVentureDescription":"Joint venture for Denver13 area",
         "startDate":"2017-01-01",
         "endDate":"2017-12-27",
         "status":"Editing",
         "createdBy":"username",
         "creationDate":"2022-11-04T16:15:33+00:00",
         "lastUpdatedBy":"username",
         "lastUpdateDate":"2022-11-09T14:27:27.058+00:00",
         "links":[
            {
               "rel":"self",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519858",
               "name":"carriedInterestAgreements",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000878"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519858",
               "name":"carriedInterestAgreements",
               "kind":"item"
            },
            {
               "rel":"child",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100563519858/child/stakeholderGroups",
               "name":"stakeholderGroups",
               "kind":"collection"
            }
         ]
      },
 
   ],
   "count":4,
   "hasMore":false,
   "limit":25,
   "offset":0,
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements",
         "name":"carriedInterestAgreements",
         "kind":"collection"
      }
   ]
}

Back to Top