Create a carried interest agreement
post
/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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
-
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. -
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.
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
Nested Schema : carriedInterestAgreements-agreementDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AgreementId: integer
(int64)
Title:
Carried Interest Agreement ID
Nested Schema : carriedInterestAgreements-stakeholderGroups-item-post-request
Type:
Show Source
object
-
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. -
endDate: string
(date)
Title:
End Date
The end date of the effective date range of the stakeholder group. -
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
-
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.
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
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
Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-post-request
Type:
Show Source
object
-
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. -
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. -
ownershipDefinitionDescription: string
Title:
Description
Maximum Length:240
A description 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.
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
Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-post-request
Type:
Show Source
object
-
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 invoiced. -
percentageOfInterest: number
Title:
Ownership Percentage
Default Value:0
The percent of ownership 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. -
stakeholderName: string
Title:
Stakeholder
The name of the joint venture stakeholder.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
StakeholderGroupId: integer
(int64)
Title:
Stakeholder Group ID
Nested Schema : schema
Type:
Show Source
object
-
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. -
createJournalsFlag: boolean
Title:
Create Journals
Maximum Length:1
Indicates whether carried interest journals are created for carried interest distributions for the consenting stakeholder. -
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
Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
GroupLineId: integer
(int64)
Title:
Stakeholder Group Line ID
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.
Root Schema : carriedInterestAgreements-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : carriedInterestAgreements-agreementDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AgreementId: integer
(int64)
Title:
Carried Interest Agreement ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : carriedInterestAgreements-stakeholderGroups-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-item-response
Type:
Show Source
object
-
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: integer
Title:
Total Percentage
Read Only:true
The sum of all percentages of ownership in the ownership definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : carriedInterestAgreements-stakeholderGroups-ownershipDefinitions-ownershipPercentages-item-response
Type:
Show Source
object
-
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 invoiced. -
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 percent of ownership 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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderGroupDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StakeholderGroupId: integer
(int64)
Title:
Stakeholder Group ID
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
GroupLineId: integer
(int64)
Title:
Stakeholder Group Line ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- agreementDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/agreementDFFParameters:
- agreementId:
$request.path.agreementId
- agreementId:
- stakeholderGroups
-
Operation: /fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/stakeholderGroupsParameters:
- agreementId:
$request.path.agreementId
The stakeholder groups resource is used to view, create, update, or delete stakeholder groups for a carried interest agreement. - agreementId:
Examples
The following example shows how to create a carried interest agreement by submitting a POST request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X POST -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements"
Request Body Example
The following shows an example of the request body in JSON format.
{ "agreement":"CIALBERTA", "agreementDescription":"Carried interest for Alberta site", "endDate":"2022-11-17", "jointVenture":"ALBERTA", "startDate":"2022-11-10", "status":"Editing" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "agreementId":300100564212877, "agreement":"CIALBERTA", "agreementDescription":"Carried interest for Alberta site", "jointVenture":"ALBERTA", "jointVentureDescription":"Alberta OilSands", "startDate":"2022-11-10", "endDate":"2022-11-17", "status":"Editing", "createdBy":"username", "creationDate":"2022-11-10T08:12:08+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2022-11-10T08:12:08.022+00:00", "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100564212877", "name":"carriedInterestAgreements", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100564212877", "name":"carriedInterestAgreements", "kind":"item" }, { "rel":"child", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/300100564212877/child/stakeholderGroups", "name":"stakeholderGroups", "kind":"collection" } ] }