Create a set of ownership percentage for an ownership definition

post

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Distribution Only
    Maximum Length: 1
    Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced.
  • Ownership Percentage Descriptive Flexfields
    Title: Ownership Percentage Descriptive Flexfields
    The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
  • Title: Ownership Percentage
    Default Value: 0
    The percent of ownership a stakeholder has in a joint venture transaction.
  • 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.
  • Title: Stakeholder
    The name of the joint venture stakeholder.
Nested Schema : Ownership Percentage Descriptive Flexfields
Type: array
Title: Ownership Percentage Descriptive Flexfields
The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : jointVentures-ownershipDefinitions-ownershipPercentages-item-response
Type: object
Show Source
Nested Schema : Ownership Percentage Descriptive Flexfields
Type: array
Title: Ownership Percentage Descriptive Flexfields
The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
Show Source
Nested Schema : jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to specify an ownership percentage for a stakeholder by submitting a POST request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d @JVOwnershipPercentCreate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100184768422/child/ownershipDefinitions/300100184768458/child/ownershipPercentages

Request Body Example

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

{
    "distributionOnlyFlag" : false,
    "percentageOfInterest" : 10,
    "roundingPartnerFlag" : true,
	"stakeholderName" : "APOLLOTRANS"
}

Response Body Example

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

{
  "createdBy" : "username",
  "creationDate" : "2020-02-14T22:35:49+00:00",
  "distributionOnlyFlag" : false,
  "lastUpdateDate" : "2020-02-14T22:35:49.001+00:00",
  "lastUpdatedBy" : "username",
  "ownershipPercentageId" : 300100184961473,
  "percentageOfInterest" : 10,
  "roundingPartnerFlag" : true,
  "invoicingPartnerId" : null,
  "internalStakeholderFlag" : true,
  "stakeholderName" : "APOLLOTRANS",
  "stakeholderDescription" : "Apollo Field services",
  "ownershipDefinitionName" : "BASINOD",
}
Back to Top