Create joint venture options
post
/fscmRestApi/resources/11.13.18.05/jointVentureOptions
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-
carriedInterestEnabledFlag(required): boolean
Title:
Carried Interest EnabledMaximum Length:1Indicates whether carried interest processing is enabled for Joint Venture Management. -
defaultGeneralLedgerTransactionDate: string
Title:
Default GL Transaction DateThe default transaction date to assign to joint venture transactions when the date from the general ledger transaction date reference isn't found. -
defaultSubledgerAccountingTransactionDate: string
Title:
Default SLA Transaction DateThe default transaction date to assign to joint venture transactions when the date from the subledger accounting transaction date reference isn't found. -
emailBody: string
Title:
Email Message BodyMaximum Length:4000The body of the email used to deliver Joint Interest Billing reports. -
emailSubject: string
Title:
Email SubjectMaximum Length:250The subject line of the email used to deliver Joint Interest Billing reports. -
excludeNonDistributableTransactionsFlag(required): boolean
Title:
Exclude Project Related Transactions That Aren't DistributableMaximum Length:1Indicates whether to exclude transactions identified as not distributable from Joint Venture Management. -
generalLedgerReferenceDescription: string
Title:
GL Reference DescriptionMaximum Length:240The description of the general ledger date. -
generalLedgerTransactionDateReference: string
Title:
GL Transaction Date ReferenceThe general ledger date to assign to joint venture transactions as the transaction date. -
optionsDFF: array
optionsDFF
-
overrideExpenditureType: string
Title:
Override Expenditure Type NameThe name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideExpenditureTypeDescription: string
Title:
Override Expenditure Type DescriptionThe description of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideTaskNumber: string
Title:
Override Task NumberMaximum Length:100The overriding task number associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
primarySegmentLabelCode: string
Title:
Primary Segment Label CodeMaximum Length:30The segment label code used to identify the primary segment that Joint Venture Management uses to identify transactions. -
primarySegmentLabelName: string
Title:
Primary Segment Label NameThe name of the primary segment label code. -
projectAttribute: string
Title:
Project AttributeThe attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
subledgerAccountingExpenditureBusinessUnitIdReference: string
Title:
SLA Supporting Reference for Expenditure Business Unit IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure business unit ID from Project Costing. -
subledgerAccountingExpenditureItemDateReference: string
Title:
SLA Supporting Reference for Expenditure Item DateMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure item date from Project Costing. -
subledgerAccountingExpenditureOrganizationIdReference: string
Title:
SLA Supporting Reference for Expenditure Organization IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure organization ID from Project Costing. -
subledgerAccountingExpenditureTypeIdReference: string
Title:
SLA Supporting Reference for Expenditure Type IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure type ID from Project Costing. -
subledgerAccountingProjectIdReference: string
Title:
SLA Supporting Reference for Project IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives a project ID from Project Costing. -
subledgerAccountingTaskIdReference: string
Title:
SLA Supporting Reference for Task IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives a task ID from Project Costing. -
subledgerAccountingTransactionDateReference: string
Title:
SLA Supporting Reference for Transaction DateMaximum Length:30The short name of the supporting reference for subledger accounting that derives a transaction date for joint venture transactions.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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 : jointVentureOptions-item-response
Type:
Show Source
object-
applicationId: integer
(int64)
Title:
Application IDRead Only:trueDefault Value:10568The unique identifier of the Joint Venture Management functional area. -
carriedInterestEnabledFlag: boolean
Title:
Carried Interest EnabledMaximum Length:1Indicates whether carried interest processing is enabled for Joint Venture Management. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture options. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the joint venture options were created. -
defaultGeneralLedgerTransactionDate: string
Title:
Default GL Transaction DateThe default transaction date to assign to joint venture transactions when the date from the general ledger transaction date reference isn't found. -
defaultGeneralLedgerTransactionDateDescription: string
Title:
Default GL Transaction Date DescriptionRead Only:trueThe description of the default general ledger transaction date. -
defaultSubledgerAccountingTransactionDate: string
Title:
Default SLA Transaction DateThe default transaction date to assign to joint venture transactions when the date from the subledger accounting transaction date reference isn't found. -
defaultSubledgerAccountingTransactionDateDescription: string
Title:
Default SLA Transaction Date DescriptionRead Only:trueThe description of the default subledger accounting transaction date. -
emailBody: string
Title:
Email Message BodyMaximum Length:4000The body of the email used to deliver Joint Interest Billing reports. -
emailSubject: string
Title:
Email SubjectMaximum Length:250The subject line of the email used to deliver Joint Interest Billing reports. -
excludeNonDistributableTransactionsFlag: boolean
Title:
Exclude Project Related Transactions That Aren't DistributableMaximum Length:1Indicates whether to exclude transactions identified as not distributable from Joint Venture Management. -
generalLedgerReferenceDescription: string
Title:
GL Reference DescriptionMaximum Length:240The description of the general ledger date. -
generalLedgerTransactionDateReference: string
Title:
GL Transaction Date ReferenceThe general ledger date to assign to joint venture transactions as the transaction date. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the joint venture options were last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the joint venture options. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
optionsDFF: array
optionsDFF
-
overrideExpenditureType: string
Title:
Override Expenditure Type NameThe name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideExpenditureTypeDescription: string
Title:
Override Expenditure Type DescriptionThe description of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideTaskNumber: string
Title:
Override Task NumberMaximum Length:100The overriding task number associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
primarySegmentLabelCode: string
Title:
Primary Segment Label CodeMaximum Length:30The segment label code used to identify the primary segment that Joint Venture Management uses to identify transactions. -
primarySegmentLabelDescription: string
Title:
Primary Segment Label DescriptionRead Only:trueMaximum Length:240The description of the primary segment label code. -
primarySegmentLabelName: string
Title:
Primary Segment Label NameThe name of the primary segment label code. -
projectAttribute: string
Title:
Project AttributeThe attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
projectAttributeAPIName: string
Title:
Project Attribute API NameRead Only:trueThe API name of the attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
projectAttributeSegment: string
Title:
Project Attribute SegmentRead Only:trueThe name of the attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
subledgerAccountingExpenditureBusinessUnitIdReference: string
Title:
SLA Supporting Reference for Expenditure Business Unit IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure business unit ID from Project Costing. -
subledgerAccountingExpenditureBusinessUnitIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Business Unit ID DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for expenditure business unit ID. -
subledgerAccountingExpenditureBusinessUnitIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Business Unit ID NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for expenditure business unit ID. -
subledgerAccountingExpenditureItemDateReference: string
Title:
SLA Supporting Reference for Expenditure Item DateMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure item date from Project Costing. -
subledgerAccountingExpenditureItemDateReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Item Date DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for expenditure item date. -
subledgerAccountingExpenditureItemDateReferenceName: string
Title:
SLA Supporting Reference Expenditure Item Date NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for expenditure item date. -
subledgerAccountingExpenditureOrganizationIdReference: string
Title:
SLA Supporting Reference for Expenditure Organization IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure organization ID from Project Costing. -
subledgerAccountingExpenditureOrganizationIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Organization ID DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for expenditure organization ID. -
subledgerAccountingExpenditureOrganizationIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Organization ID NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for expenditure organization ID. -
subledgerAccountingExpenditureTypeIdReference: string
Title:
SLA Supporting Reference for Expenditure Type IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives an expenditure type ID from Project Costing. -
subledgerAccountingExpenditureTypeIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Type ID DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for expenditure type ID. -
subledgerAccountingExpenditureTypeIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Type ID NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for expenditure type ID. -
subledgerAccountingProjectIdReference: string
Title:
SLA Supporting Reference for Project IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives a project ID from Project Costing. -
subledgerAccountingProjectIdReferenceDescription: string
Title:
SLA Supporting Reference Project ID DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for project ID. -
subledgerAccountingProjectIdReferenceName: string
Title:
SLA Supporting Reference Project ID NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for project ID. -
subledgerAccountingReferenceDescription: string
Title:
SLA Supporting Reference DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference. -
subledgerAccountingReferenceName: string
Title:
SLA Supporting Reference NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference. -
subledgerAccountingTaskIdReference: string
Title:
SLA Supporting Reference for Task IDMaximum Length:30The short name of the supporting reference for subledger accounting that derives a task ID from Project Costing. -
subledgerAccountingTaskIdReferenceDescription: string
Title:
SLA Supporting Reference Task ID DescriptionRead Only:trueMaximum Length:240The description of the subledger accounting supporting reference for task ID. -
subledgerAccountingTaskIdReferenceName: string
Title:
SLA Supporting Reference Task ID NameRead Only:trueMaximum Length:80The name of the subledger accounting supporting reference for task ID. -
subledgerAccountingTransactionDateReference: string
Title:
SLA Supporting Reference for Transaction DateMaximum Length:30The short name of the supporting reference for subledger accounting that derives a transaction date for joint venture transactions.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : jointVentureOptions-optionsDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
ApplicationId: integer
(int64)
Title:
Application IDRead Only:trueDefault Value:10568 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- optionsDFF
-
Parameters:
- applicationId:
$request.path.applicationId
- applicationId:
Examples
The following example shows how to create a joint venture option 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 @JVOptionCreate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions
Request Body Example
The following shows an example of the request body in JSON format.
{
"generalLedgerTransactionDateReference": "General ledger reference date",
"subledgerAccountingTransactionDateReference": "TRANSACTION_DATE"
}Response Body Example
The following shows an example of the response body in JSON format.
{
"applicationId": 10568,
"generalLedgerTransactionDateReference": "General ledger reference date",
"generalLedgerReferenceDescription": "Use the GL reference date as the transaction date on joint venture transactions.",
"subledgerAccountingTransactionDateReference": "TRANSACTION_DATE",
"subledgerAccountingReferenceName": "JV Transaction Date",
"subledgerAccountingReferenceDescription": "Joint venture transaction date",
"createdBy": "username",
"creationDate": "2020-05-29T20:55:06+00:00",
"lastUpdatedBy": "username",
"lastUpdateDate": "2020-05-29T20:55:06.194+00:00",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions/10568",
"name": "jointVentureOptions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions/10568",
"name": "jointVentureOptions",
"kind": "item"
}
]
}