Get all joint venture partner contribution requests

get

/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the joint venture partner contribution request; string; that matches the primary key criteria specified.
      Finder Variables
      • contributionRequestId; integer; The unique identifier of the partner contribution request; string; .
    • contributionRequestFinder Finds all joint venture partner contribution requests that match the specified search criteria.
      Finder Variables
      • endDate; string; The end date of the joint venture partner contribution request; string; .
      • jointVenture; string; The unique name of the joint venture.
      • ownershipDefinition; string; The name of the ownership definition.
      • request; string; The unique name of the joint venture partner contribution request; string; .
      • requestDescription; string; The description of the joint venture partner contribution request; string; .
      • runDay; string; The run day of the joint venture partner contribution request; string; , 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.
      • searchAllText; string; A search value to identify joint venture contribution requests that contain the specified text in any of the string attributes.
      • stakeholder; string; The unique name of the joint venture stakeholder; string; .
      • startDate; string; The start date of the joint venture partner contribution request; string; .
      • status; string; The status; string; of the joint venture partner contribution request; string; .
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • contributionAccount; string; The combination of segment values for a joint venture partner contribution account.
    • contributionRequestId; integer; The unique identifier of the partner contribution request.
    • conversionDate; string; The date used when retrieving the currency conversion rate for the partner contribution request.
    • createdBy; string; The user who created the resource item.
    • creationDate; string; The date and time when the resource item was created.
    • currencyCode; string; The currency code used to create partner contributions from a request.
    • endDate; string; The end date of the joint venture partner contribution request.
    • frequency; string; The frequency of processing partner contribution requests.
    • jointVenture; string; The unique name of the joint venture.
    • jointVentureDescription; string; The description of the joint venture.
    • lastRunDate; string; The date the partner contribution request was last processed successfully.
    • lastUpdateDate; string; The date and time when the resource item was last updated.
    • lastUpdatedBy; string; The user who last updated the resource item.
    • openDistributionAmountFlag; boolean; Indicates whether the amounts for the partner contributions are based on the open distribution amounts for the stakeholders.
    • ownershipDefinition; string; The name of the ownership definition.
    • request; string; The unique name of the joint venture partner contribution request.
    • requestDescription; string; The description of the joint venture partner contribution request.
    • requestedGrossAmount; number; The gross amount on the partner contribution request from which partner contributions will be created.
    • runDay; string; 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; The unique name of the joint venture stakeholder.
    • startDate; string; The start date of the joint venture partner contribution request.
    • status; string; The status of the joint venture partner contribution request.
    • weekEndDay; string; The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.
    • weekStartDay; string; The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.

There's no request body for this operation.

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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested 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 retrieve all joint venture partner contribution requests 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" 

Example Response Body

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

{
   "items":[
      {
         "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"
            }
         ]
      }
   ],
   "count":1,
   "hasMore":false,
   "limit":25,
   "offset":0,
   "links":[
      {
         "rel":"self",
         "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests",
         "name":"jointVentureContributionRequests",
         "kind":"collection"
      }
   ]
}
Back to Top