Get a joint venture partner contribution request
get
/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/{contributionRequestId}
Request
Path Parameters
-
contributionRequestId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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 : jointVentureContributionRequests-item-response
Type:
Show Source
object
-
contributionAccount: string
Title:
Joint Venture Partner Contribution Account
The combination of segment values for a joint venture partner contribution account. -
contributionRequestDFF: array
contributionRequestDFF
-
contributionRequestId: integer
(int64)
Title:
Contribution Request ID
Read Only:true
The unique identifier of the partner contribution request. -
contributionsExistFlag: boolean
Title:
Partner Contribution Exists
Read Only:true
Indicates whether there are existing partner contributions for the request. -
conversionDate: string
Title:
Conversion Date
The date used when retrieving the currency conversion rate for the partner contribution request. -
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. -
currencyCode: string
Title:
Currency
Maximum Length:15
The currency code used to create partner contributions from a request. -
endDate: string
(date)
Title:
End Date
The end date of the joint venture partner contribution request. -
frequency: string
Title:
Frequency
The frequency of processing partner contribution requests. -
jointVenture: string
Title:
Joint Venture
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture Description
The description of the joint venture. -
lastRunDate: string
(date)
Title:
Last Run Date
Read Only:true
The date the partner contribution request was last processed successfully. -
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. -
openDistributionAmountFlag: boolean
Title:
Use Open Distribution Amount
Maximum Length:1
Default Value:false
Indicates whether the amounts for the partner contributions are based on the open distribution amounts for the stakeholders. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The name of the ownership definition. -
request: string
Title:
Partner Contribution Request
Maximum Length:30
The unique name of the joint venture partner contribution request. -
requestDescription: string
Title:
Description
Maximum Length:240
The description of the joint venture partner contribution request. -
requestedGrossAmount: number
Title:
Requested Amount
The gross amount on the partner contribution request from which partner contributions will be created. -
runDay: string
Title:
Run Day
The run day of the joint venture partner contribution request, for example, the first day of the following week, last day of the current week, first day of the following month, or last day of the current month. -
stakeholder: string
Title:
Direct Billed Stakeholder
The unique name of the joint venture stakeholder. -
startDate: string
(date)
Title:
Start Date
The start date of the joint venture partner contribution request. -
status: string
Title:
Status
The status of the joint venture partner contribution request. -
structureInstanceNumber: integer
Title:
Structure Instance Number
The chart of accounts instance number associated with the joint venture's business unit. -
weekEndDay: string
Title:
End Day
The ending day of the week on the partner contribution request that's used when creating weekly partner contributions. -
weekStartDay: string
Title:
Start Day
The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureContributionRequests-contributionRequestDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ContributionRequestId: integer
(int64)
Title:
Contribution Request 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.
Links
- contributionRequestDFF
-
Parameters:
- contributionRequestId:
$request.path.contributionRequestId
- contributionRequestId:
Examples
The following example shows how to retrieve a joint venture partner contribution request by submitting a GET request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528"
Example Response Body
The following shows an example of the response body in JSON format.
{ "contributionRequestId":300100549966528, "request":"MONTHLYCONTRIBUTION", "requestDescription":"Monthly contribution request", "jointVenture":"GLOBALDEVPROJECTJV", "jointVentureDescription":"Global enterprise project", "startDate":"2022-03-07", "endDate":"2022-03-08", "openDistributionAmountFlag":false, "frequency":"Monthly", "requestedGrossAmount":7890, "status":"Pending", "stakeholder":"GLOBALDEV_BARNCASPER_S4", "ownershipDefinition":null, "weekStartDay":null, "weekEndDay":null, "runDay":"Last day of the current month", "currencyCode":"USD", "conversionDate":null, "contributionAccount":"", "lastRunDate":null, "contributionsExistFlag":false, "structureInstanceNumber":46521, "createdBy":"username", "creationDate":"2022-03-07T08:28:21+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2022-03-07T08:28:21.920+00:00", "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528", "name":"jointVentureContributionRequests", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528", "name":"jointVentureContributionRequests", "kind":"item" } ] }