Get all transaction references for a joint venture partner contribution
get
/fscmRestApi/resources/11.13.18.05/jointVentureContributions/{contributionId}/child/contributionReferences
Request
Path Parameters
-
contributionId(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 -
finder: string
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 partner contribution transaction reference that matches the primary key criteria specified.
Finder Variables- contributionReferenceId; integer; The unique identifier of the partner contribution transaction reference.
- PrimaryKey Finds the partner contribution transaction reference that matches the primary key criteria specified.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- agreementDefaultCharge; number; The amount charged to the partner when the partner contribution is closed.
- agreementDefaultChargeAccount; string; The account used to record the agreement default charge when closing a partner contribution.
- cancelDate; string; The date the partner contribution is canceled.
- closeDate; string; The date the partner contribution was closed.
- contributionReferenceId; integer; The unique identifier of the partner contribution transaction reference.
- lastUpdateDate; string; The date and time when the transaction reference for the partner contribution was last updated.
- lastUpdatedBy; string; The user who last updated the transaction reference for partner contribution.
- priorContributionStatus; string; The status assigned to the partner contribution before it was canceled, closed, or transferred.
- refundAmount; number; The amount to refund to the partner when the partner contribution is closed.
- relatedContributionId; integer; The unique identifier of the partner contribution that the transaction was transferred from or transferred to.
- status; string; The status of the partner contribution transaction.
- structureInstanceNumber; integer; The chart of accounts instance number associated with the joint venture's business unit.
- transactionAmount; number; The amount of the transaction for the partner contribution.
- transactionCurrencyCode; string; The currency code of the partner contribution transaction.
- transactionDate; string; The date on the transaction that was created for the partner contribution.
- transactionId; integer; The unique identifier of the transaction created for the partner contribution.
- transactionNumber; string; The unique number of the transaction created for the partner contribution.
- transactionReason; string; The reason for the partner contribution transaction.
- transactionType; string; The type of transaction associated with the partner contribution.
-
totalResults: boolean
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
-
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 : jointVentureContributions-contributionReferences
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureContributions-contributionReferences-item-response
Type:
Show Source
object
-
agreementDefaultCharge: number
Title:
Agreement Default Charge
The amount charged to the partner when the partner contribution is closed. -
agreementDefaultChargeAccount: string
Title:
Agreement Default Charge Account
Maximum Length:255
The account used to record the agreement default charge when closing a partner contribution. -
cancelDate: string
(date)
Title:
Cancel Date
The date the partner contribution is canceled. -
closeDate: string
(date)
Title:
Close Date
The date the partner contribution was closed. -
contributionReferenceDFF: array
contributionReferenceDFF
-
contributionReferenceId: integer
(int64)
Title:
Contribution Reference ID
Read Only:true
The unique identifier of the partner contribution transaction reference. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the transaction reference for the partner contribution was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the transaction reference for partner contribution. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
priorContributionStatus: string
Title:
Prior Contribution Status
Read Only:true
Maximum Length:80
The status assigned to the partner contribution before it was canceled, closed, or transferred. -
refundAmount: number
Title:
Refund Amount
The amount to refund to the partner when the partner contribution is closed. - relatedContributionId: integer (int64)
-
status: string
Title:
Transaction Status
Read Only:true
Maximum Length:80
The status of the partner contribution transaction. -
structureInstanceNumber: integer
(int64)
Title:
Structure Instance Number
Read Only:true
The chart of accounts instance number associated with the joint venture's business unit. -
transactionAmount: number
Title:
Transaction Amount
The amount of the transaction for the partner contribution. -
transactionCurrencyCode: string
Title:
Transaction Currency
Read Only:true
Maximum Length:15
The currency code of the partner contribution transaction. -
transactionDate: string
(date)
Title:
Transaction Date
The date on the transaction that was created for the partner contribution. -
transactionId: integer
(int64)
Title:
Transaction ID
Default Value:0
The unique identifier of the transaction created for the partner contribution. -
transactionNumber: string
Title:
Transaction Number
Maximum Length:20
The unique number of the transaction created for the partner contribution. -
transactionReason: string
Title:
Transaction Reason
The reason for the partner contribution transaction. -
transactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
The type of transaction associated with the partner contribution.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureContributions-contributionReferences-contributionReferenceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ContributionReferenceId: integer
(int64)
Title:
Contribution Reference ID
Read Only:true
-
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.
Examples
The following example shows how to retrieve all transaction references for a joint venture partner contribution by submitting a GET request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100210656676/child/contributionReferences
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "contributionReferenceId": 300100210656677, "transactionType": "AR invoice used to open partner contribution", "transactionNumber": "3334441", "transactionDate": "2017-01-01", "transactionAmount": 10000000, "lastUpdatedBy": "username", "lastUpdateDate": "2020-10-26T17:59:30.148+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100210656676/child/contributionReferences/300100210656677", "name": "contributionReferences", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100210656676/child/contributionReferences/300100210656677", "name": "contributionReferences", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributions/300100210656676", "name": "jointVentureContributions", "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/jointVentureContributions/300100210656676/child/contributionReferences", "name": "contributionReferences", "kind": "collection" } ] }