Get a joint venture general ledger transaction
get
/fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}
Request
Path Parameters
-
transactionId(required): integer(int64)
The unique identifier of the joint venture transaction.
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 : jointVentureGLTransactions-item-response
Type:
Show Source
object
-
account: string
Title:
Account
Read Only:true
The combination of the values of the account segments assigned to the transaction. -
accountedCreditAmount: number
Title:
Accounted Credit
Read Only:true
The transaction credit amount in accounting currency. -
accountedDebitAmount: number
Title:
Accounted Debit
Read Only:true
The transaction debit amount in accounting currency. -
assignmentRule: string
Title:
Assignment Rule
Read Only:true
Maximum Length:30
The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder. -
batchId: integer
(int64)
Title:
Batch ID
Read Only:true
The unique identifier of the batch. -
carriedInterestAgreement: string
Title:
Carried Interest Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement associated with the joint venture transaction. -
carriedInterestAgreementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the carried interest agreement associated with the joint venture transaction. -
carriedInterestSourceOwnerDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
chartOfAccountsId: integer
(int64)
Title:
Chart of Accounts
Read Only:true
The unique identifier of the chart of accounts structure instance. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction was created. -
currencyCode: string
Title:
Accounting Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Default Value:false
Indicates whether the transaction is for distribution only, not for invoicing. -
effectiveDate: string
(date)
Title:
Accounting Date
Read Only:true
The accounting date of the journal. -
enteredCreditAmount: number
Title:
Entered Credit
Read Only:true
The transaction credit amount in the entered currency. -
enteredCurrencyCode: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
The currency code entered on the original transaction. -
enteredDebitAmount: number
Title:
Entered Debit
Read Only:true
The transaction debit amount in the entered currency. -
headerId: integer
(int64)
Title:
Header ID
Read Only:true
The unique identifier of the journal. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
jointVentureShortName: string
Title:
Joint Venture
Read Only:true
Maximum Length:30
The unique name of the joint venture. -
journalDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
The description of the general ledger journal entry line. -
journalStatus: string
Title:
Journal Status
Read Only:true
Maximum Length:1
The journal entry line status code. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture transaction. -
ledgerName: string
Title:
Ledger Name
Read Only:true
Maximum Length:30
The name of the ledger. -
lineNumber: integer
(int64)
Title:
Line Number
Read Only:true
The number of the journal line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
originalOwnerDefinitionShortName: string
Title:
Original Ownership Definition
Read Only:true
Maximum Length:20
The original ownership definition assigned to the joint venture transaction. -
originalStakeholderDescription: string
Title:
Original Stakeholder Description
Read Only:true
Maximum Length:240
The description of the original stakeholder. -
originalStakeholderShortName: string
Title:
Original Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The original stakeholder assigned to the joint venture transaction. -
ownerDefinitionShortName: string
Title:
Ownership Definition
Maximum Length:30
The short name of the ownership definition assigned to the transaction as an override. -
periodName: string
Title:
Period Name
Read Only:true
Maximum Length:15
The accounting period name in a calendar. -
stakeholderDescription: string
Title:
Stakeholder Description
The description of the override joint venture stakeholder. -
stakeholderShortName: string
Title:
Direct Billed Stakeholder
The name of the joint venture stakeholder assigned to the transaction as an override. -
statisticalAmount: number
Title:
Units
Read Only:true
The statistical unit of measure of the journal entry line. -
transactionAccount: array
Account Key Flexfields
Title:
Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances. -
transactionChanges: array
Joint Venture Transaction Changes
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionChangesExistFlag: boolean
Title:
Transaction Changes Exist
Read Only:true
Maximum Length:255
Indicates whether manual changes have been made to a transaction. -
transactionDate: string
(date)
Title:
Transaction Date
The date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date. -
transactionDFF: array
transactionDFF
-
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier of the joint venture transaction. -
transactionStatus: string
Title:
Transaction Status
Maximum Length:80
The status of the joint venture transaction.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Account Key Flexfields
Type:
array
Title:
Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
Show Source
Nested Schema : Joint Venture Transaction Changes
Type:
array
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
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.
Nested Schema : jointVentureGLTransactions-transactionAccount-item-response
Type:
Show Source
object
-
_CHART_OF_ACCOUNTS_ID: integer
(int64)
Title:
Chart of Accounts
Key flexfield structure identifier. -
_CODE_COMBINATION_ID: integer
(int64)
Title:
Account
Key flexfield combination identifier. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Key flexfield enabled flag. -
EndDateActive: string
(date)
Title:
To Date
Date after which key flexfield combination is invalid. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StartDateActive: string
(date)
Title:
From Date
Date before which key flexfield combination is invalid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureGLTransactions-transactionChanges-item-response
Type:
Show Source
object
-
afterAssignmentRule: string
Title:
After Assignment Rule
Read Only:true
Maximum Length:30
The new ownership definition assignment rule assigned to the transaction. -
afterDistributionOnlyFlag: boolean
Title:
After Distribution Only
Read Only:true
Maximum Length:1
The new distribution only value assigned to the transaction. -
afterOwnershipDefinition: string
Title:
After Ownership Definition
Read Only:true
Maximum Length:30
The new ownership definition assigned to the transaction. -
afterStakeholder: string
Title:
After Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The new name of the direct billed stakeholder assigned to the transaction. -
afterStakeholderDescription: string
Title:
After Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The new description of the direct billed stakeholder assigned to the transaction. -
afterStatus: string
Title:
After Status
Read Only:true
Maximum Length:80
The new status assigned to the transaction. -
afterTransactionDate: string
(date)
Title:
After Transaction Date
Read Only:true
The new transaction date assigned to the transaction. -
beforeAssignmentRule: string
Title:
Before Assignment Rule
Read Only:true
Maximum Length:30
The previous ownership definition assignment rule assigned to the transaction. -
beforeDistributionOnlyFlag: boolean
Title:
Before Distribution Only
Read Only:true
Maximum Length:1
The previous distribution only value assigned to the transaction. -
beforeOwnershipDefinition: string
Title:
Before Ownership Definition
Read Only:true
Maximum Length:30
The previous ownership definition assigned to the transaction. -
beforeStakeholder: string
Title:
Before Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The previous name of the direct billed stakeholder assigned to the transaction. -
beforeStakeholderDescription: string
Title:
Before Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The previous description of the direct billed stakeholder assigned to the transaction. -
beforeStatus: string
Title:
Before Status
Read Only:true
Maximum Length:80
The previous status assigned to the transaction. -
beforeTransactionDate: string
(date)
Title:
Before Transaction Date
Read Only:true
The previous transaction date assigned to the transaction. -
changeReason: string
Title:
Change Reason
Read Only:true
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Read Only:true
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction change. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction change was created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
transactionChangeId: integer
(int64)
Title:
Transaction Change ID
Read Only:true
The unique identifier of the joint venture transaction change.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureGLTransactions-transactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- clearOwnershipAssignment
-
Parameters:
- transactionId:
$request.path.transactionId
Clears the ownership definition values assigned to the joint venture transactions so that the assignment rules process can assign new values. This action resets the values for the ownership definition, original ownership definition, stakeholder, original stakeholder, and assignment rule. - transactionId:
- transactionAccount
-
Parameters:
- transactionId:
$request.path.transactionId
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances. - transactionId:
- transactionChanges
-
Parameters:
- transactionId:
$request.path.transactionId
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. - transactionId:
- transactionDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}/child/transactionDFFParameters:
- transactionId:
$request.path.transactionId
- transactionId:
Examples
The following example shows how to retrieve a general ledger transaction identified by Joint Venture Management 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/jointVentureGLTransactions/100100132693415
Response Body Example
The following shows an example of the response body in JSON format.
{ "transactionId" : 100100132693415, "batchId" : 1633798, "headerId" : 1907291, "lineNumber" : 1, "jointVentureShortName" : "JVMESS01", "jointVentureDescription" : "Jade Valley Mesa Project\nParcel S01, Lot#34TY6", "transactionStatus" : "Available to process", "ownerDefinitionShortName" : "JVMESSOPD1", "originalOwnerDefinitionShortName" : "JVMESSOPD1", "stakeholderShortName" : null, "stakeholderDescription" : null, "originalStakeholderShortName" : null, "originalStakeholderDescription" : null, "ledgerName" : "Vision Operations (USA)", "periodName" : "Apr-18", "effectiveDate" : "2018-04-30", "journalStatus" : "P", "accountedDebitAmount" : 1500, "accountedCreditAmount" : null, "currencyCode" : "USD", "statisticalAmount" : null, "journalDescription" : null, "chartOfAccountsId" : 101, "account" : "01-110-1110-0000-000", "createdBy" : "username", "creationDate" : "2020-02-21T08:33:14.001+00:00", "lastUpdatedBy" : "username", "lastUpdateDate" : "2020-02-21T08:33:14.001+00:00", "transactionDate" : "2018-04-30", }