Update a joint venture partner contribution request

patch

/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/{contributionRequestId}

Request

Path Parameters
  • 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=
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Joint Venture Partner Contribution Account
    The combination of segment values for a joint venture partner contribution account.
  • Title: Conversion Date
    The date used when retrieving the currency conversion rate for the partner contribution request.
  • Title: Currency
    Maximum Length: 15
    The currency code used to create partner contributions from a request.
  • Title: End Date
    The end date of the joint venture partner contribution request.
  • Title: Frequency
    The frequency of processing partner contribution requests.
  • Title: Joint Venture
    The unique name of the joint venture.
  • Title: Joint Venture Description
    The description of the joint venture.
  • 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.
  • Title: Ownership Definition
    Maximum Length: 30
    The name of the ownership definition.
  • Title: Description
    Maximum Length: 240
    The description of the joint venture partner contribution request.
  • Title: Requested Amount
    The gross amount on the partner contribution request from which partner contributions will be created.
  • 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.
  • Title: Direct Billed Stakeholder
    The unique name of the joint venture stakeholder.
  • Title: Start Date
    The start date of the joint venture partner contribution request.
  • Title: Status
    The status of the joint venture partner contribution request.
  • Title: Structure Instance Number
    The chart of accounts instance number associated with the joint venture's business unit.
  • Title: End Day
    The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.
  • Title: Start Day
    The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.
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 : jointVentureContributionRequests-item-response
Type: object
Show Source
  • Title: Joint Venture Partner Contribution Account
    The combination of segment values for a joint venture partner contribution account.
  • Title: Contribution Request ID
    Read Only: true
    The unique identifier of the partner contribution request.
  • Title: Partner Contribution Exists
    Read Only: true
    Indicates whether there are existing partner contributions for the request.
  • Title: Conversion Date
    The date used when retrieving the currency conversion rate for the partner contribution request.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the resource item.
  • Title: Creation Date
    Read Only: true
    The date and time when the resource item was created.
  • Title: Currency
    Maximum Length: 15
    The currency code used to create partner contributions from a request.
  • Title: End Date
    The end date of the joint venture partner contribution request.
  • Title: Frequency
    The frequency of processing partner contribution requests.
  • Title: Joint Venture
    The unique name of the joint venture.
  • Title: Joint Venture Description
    The description of the joint venture.
  • Title: Last Run Date
    Read Only: true
    The date the partner contribution request was last processed successfully.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the resource item was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the resource item.
  • Links
  • 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.
  • Title: Ownership Definition
    Maximum Length: 30
    The name of the ownership definition.
  • Title: Partner Contribution Request
    Maximum Length: 30
    The unique name of the joint venture partner contribution request.
  • Title: Description
    Maximum Length: 240
    The description of the joint venture partner contribution request.
  • Title: Requested Amount
    The gross amount on the partner contribution request from which partner contributions will be created.
  • 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.
  • Title: Direct Billed Stakeholder
    The unique name of the joint venture stakeholder.
  • Title: Start Date
    The start date of the joint venture partner contribution request.
  • Title: Status
    The status of the joint venture partner contribution request.
  • Title: Structure Instance Number
    The chart of accounts instance number associated with the joint venture's business unit.
  • Title: End Day
    The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.
  • Title: Start Day
    The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.
Back to Top

Examples

The following example shows how to update a joint venture partner contribution request by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528" 

Example Request Body

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

{
   "contributionAccount":"",
   "contributionRequestId":300100549966528,
   "contributionsExistFlag":false,
   "conversionDate":null,
   "createdBy":"username",
   "creationDate":"2022-03-07T08:28:21+00:00",
   "currencyCode":"USD",
   "endDate":"2022-03-24",
   "frequency":"Weekly",
   "jointVenture":"GLOBALDEVPROJECTJV",
   "jointVentureDescription":"Global enterprise project",
   "lastRunDate":null,
   "openDistributionAmountFlag":false,
   "ownershipDefinition":null,
   "request":"weekly contribution",
   "requestDescription":"Weekly contribution request",
   "requestedGrossAmount":7890890,
   "runDay":"First day of the following week",
   "stakeholder":"GLOBALTECH_CASPRO_S3",
   "startDate":"2022-03-15",
   "status":"Pending",
   "structureInstanceNumber":46521,
   "weekEndDay":"Sunday",
   "weekStartDay":"Saturday"
}

Example Response Body

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

{
   "contributionRequestId":300100549966528,
   "request":"WEEKLYCONTRIBUTION",
   "requestDescription":"Weekly contribution request",
   "jointVenture":"GLOBALDEVPROJECTJV",
   "jointVentureDescription":"Global enterprise project",
   "startDate":"2022-03-15",
   "endDate":"2022-03-24",
   "openDistributionAmountFlag":false,
   "frequency":"Weekly",
   "requestedGrossAmount":7890890,
   "status":"Pending",
   "stakeholder":"GLOBALTECH_CASPRO_S3",
   "ownershipDefinition":null,
   "weekStartDay":"Saturday",
   "weekEndDay":"Sunday",
   "runDay":"First day of the following week",
   "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:43:01+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":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
         }
      },
      {
         "rel":"canonical",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528",
         "name":"jointVentureContributionRequests",
         "kind":"item"
      }
   ]
}
Back to Top