Update a joint venture general ledger transaction
patch
/fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/{transactionId}
Request
Path Parameters
-
transactionId(required): integer(int64)
The unique identifier of the joint venture transaction.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
changeReason: string
Title:
ReasonMaximum Length:80The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
DetailsMaximum Length:240Additional text to describe the reason the joint venture transaction was manually changed. -
distributionOnlyFlag: boolean
Title:
Distribution OnlyMaximum Length:1Default Value:falseIndicates whether the transaction is for distribution only, not for invoicing. -
ownerDefinitionShortName: string
Title:
Ownership DefinitionMaximum Length:30The short name of the ownership definition assigned to the transaction as an override. -
stakeholderDescription: string
Title:
Stakeholder DescriptionThe description of the override joint venture stakeholder. -
stakeholderShortName: string
Title:
Direct Billed StakeholderThe name of the joint venture stakeholder assigned to the transaction as an override. -
transactionAccount: array
Account Key Flexfields
Title:
Account Key FlexfieldsThe 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 ChangesThe joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionDate: string
(date)
Title:
Transaction DateThe date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date. -
transactionDFF: array
transactionDFF
-
transactionStatus: string
Title:
Transaction StatusMaximum Length:80The status of the joint venture transaction.
Nested Schema : Account Key Flexfields
Type:
arrayTitle:
Account Key FlexfieldsThe 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:
arrayTitle:
Joint Venture Transaction ChangesThe joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Show Source
Nested Schema : jointVentureGLTransactions-transactionAccount-item-patch-request
Type:
Show Source
object-
_CHART_OF_ACCOUNTS_ID: integer
(int64)
Title:
Chart of AccountsKey flexfield structure identifier. -
_CODE_COMBINATION_ID: integer
(int64)
Title:
AccountKey flexfield combination identifier. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Key flexfield enabled flag. -
EndDateActive: string
(date)
Title:
To DateDate after which key flexfield combination is invalid. -
StartDateActive: string
(date)
Title:
From DateDate before which key flexfield combination is invalid.
Nested Schema : jointVentureGLTransactions-transactionChanges-item-patch-request
Type:
Show Source
objectNested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment
Response
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:
AccountRead Only:trueThe combination of the values of the account segments assigned to the transaction. -
accountDescription: string
Title:
Account DescriptionRead Only:trueThe description of the account assigned to the joint venture transaction. -
accountedCreditAmount: number
Title:
Accounted CreditRead Only:trueThe transaction credit amount in accounting currency. -
accountedDebitAmount: number
Title:
Accounted DebitRead Only:trueThe transaction debit amount in accounting currency. -
assignmentRule: string
Title:
Assignment RuleRead Only:trueMaximum Length:30The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder. -
batchId: integer
(int64)
Title:
Batch IDRead Only:trueThe unique identifier of the batch. -
businessUnit: string
Title:
Business UnitRead Only:trueMaximum Length:240The name of the business unit associated with the joint venture. -
carriedInterestAgreement: string
Title:
Carried Interest AgreementRead Only:trueMaximum Length:30The name of the carried interest agreement associated with the joint venture transaction. -
carriedInterestAgreementDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the carried interest agreement associated with the joint venture transaction. -
carriedInterestSourceOwnerDefinition: string
Title:
Source Ownership DefinitionRead Only:trueMaximum Length:30The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction. -
changeReason: string
Title:
ReasonMaximum Length:80The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
DetailsMaximum Length:240Additional text to describe the reason the joint venture transaction was manually changed. -
chartOfAccountsId: integer
(int64)
Title:
Chart of AccountsRead Only:trueThe unique identifier of the chart of accounts structure instance. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture transaction. -
createdByJointVentureFlag: boolean
Title:
Created by Joint VentureRead Only:trueMaximum Length:1A flag indicating whether the source of the transaction is a joint venture invoice or journal created by joint venture processing. The source of the transaction can also be payments or receipts against an invoice created by joint venture processing. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the joint venture transaction was created. -
currencyCode: string
Title:
Accounting CurrencyRead Only:trueMaximum Length:15The currency of the transaction amount. -
distributionOnlyFlag: boolean
Title:
Distribution OnlyMaximum Length:1Default Value:falseIndicates whether the transaction is for distribution only, not for invoicing. -
effectiveDate: string
(date)
Title:
Accounting DateRead Only:trueThe accounting date of the journal. -
enteredCreditAmount: number
Title:
Entered CreditRead Only:trueThe transaction credit amount in the entered currency. -
enteredCurrencyCode: string
Title:
Entered CurrencyRead Only:trueMaximum Length:15The currency code entered on the original transaction. -
enteredDebitAmount: number
Title:
Entered DebitRead Only:trueThe transaction debit amount in the entered currency. -
headerId: integer
(int64)
Title:
Header IDRead Only:trueThe unique identifier of the journal. -
jointVentureDescription: string
Title:
Joint Venture DescriptionRead Only:trueMaximum Length:240The description of the joint venture. -
jointVentureShortName: string
Title:
Joint VentureRead Only:trueMaximum Length:30The unique name of the joint venture. -
journalDescription: string
Title:
Transaction DescriptionRead Only:trueMaximum Length:240The description of the general ledger journal entry line. -
journalStatus: string
Title:
Journal StatusRead Only:trueMaximum Length:1The journal entry line status code. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the joint venture transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the joint venture transaction. -
ledgerName: string
Title:
LedgerRead Only:trueMaximum Length:30The name of the ledger. -
lineNumber: integer
(int64)
Title:
Line NumberRead Only:trueThe number of the journal line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
originalOwnerDefinitionShortName: string
Title:
Original Ownership DefinitionRead Only:trueMaximum Length:20The original ownership definition assigned to the joint venture transaction. -
originalStakeholderDescription: string
Title:
Original Stakeholder DescriptionRead Only:trueMaximum Length:240The description of the original stakeholder. -
originalStakeholderShortName: string
Title:
Original Direct Billed StakeholderRead Only:trueMaximum Length:30The original stakeholder assigned to the joint venture transaction. -
ownerDefinitionShortName: string
Title:
Ownership DefinitionMaximum Length:30The short name of the ownership definition assigned to the transaction as an override. -
periodName: string
Title:
Accounting PeriodRead Only:trueMaximum Length:15The accounting period name in a calendar. -
stakeholderDescription: string
Title:
Stakeholder DescriptionThe description of the override joint venture stakeholder. -
stakeholderShortName: string
Title:
Direct Billed StakeholderThe name of the joint venture stakeholder assigned to the transaction as an override. -
statisticalAmount: number
Title:
UnitsRead Only:trueThe statistical unit of measure of the journal entry line. -
transactionAccount: array
Account Key Flexfields
Title:
Account Key FlexfieldsThe 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 ChangesThe joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionChangesExistFlag: boolean
Title:
Transaction Changes ExistRead Only:trueMaximum Length:255Indicates whether manual changes have been made to a transaction. -
transactionDate: string
(date)
Title:
Transaction DateThe 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 IDRead Only:trueThe unique identifier of the joint venture transaction. -
transactionStatus: string
Title:
Transaction StatusMaximum Length:80The status of the joint venture transaction. -
transactionType: string
Title:
Transaction TypeRead Only:trueMaximum Length:80The type of transaction to be processed, such as expense, revenue, asset, overhead, and so forth.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Account Key Flexfields
Type:
arrayTitle:
Account Key FlexfieldsThe 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:
arrayTitle:
Joint Venture Transaction ChangesThe 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 AccountsKey flexfield structure identifier. -
_CODE_COMBINATION_ID: integer
(int64)
Title:
AccountKey flexfield combination identifier. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Key flexfield enabled flag. -
EndDateActive: string
(date)
Title:
To DateDate after which key flexfield combination is invalid. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
StartDateActive: string
(date)
Title:
From DateDate before which key flexfield combination is invalid.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureGLTransactions-transactionChanges-item-response
Type:
Show Source
object-
afterAssignmentRule: string
Title:
After Assignment RuleRead Only:trueMaximum Length:30The new ownership definition assignment rule assigned to the transaction. -
afterDistributionOnlyFlag: boolean
Title:
After Distribution OnlyRead Only:trueMaximum Length:1The new distribution only value assigned to the transaction. -
afterOwnershipDefinition: string
Title:
After Ownership DefinitionRead Only:trueMaximum Length:30The new ownership definition assigned to the transaction. -
afterStakeholder: string
Title:
After Direct Billed StakeholderRead Only:trueMaximum Length:30The new name of the direct billed stakeholder assigned to the transaction. -
afterStakeholderDescription: string
Title:
After Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The new description of the direct billed stakeholder assigned to the transaction. -
afterStatus: string
Title:
After StatusRead Only:trueMaximum Length:80The new status assigned to the transaction. -
afterTransactionDate: string
(date)
Title:
After Transaction DateRead Only:trueThe new transaction date assigned to the transaction. -
beforeAssignmentRule: string
Title:
Before Assignment RuleRead Only:trueMaximum Length:30The previous ownership definition assignment rule assigned to the transaction. -
beforeDistributionOnlyFlag: boolean
Title:
Before Distribution OnlyRead Only:trueMaximum Length:1The previous distribution only value assigned to the transaction. -
beforeOwnershipDefinition: string
Title:
Before Ownership DefinitionRead Only:trueMaximum Length:30The previous ownership definition assigned to the transaction. -
beforeStakeholder: string
Title:
Before Direct Billed StakeholderRead Only:trueMaximum Length:30The previous name of the direct billed stakeholder assigned to the transaction. -
beforeStakeholderDescription: string
Title:
Before Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The previous description of the direct billed stakeholder assigned to the transaction. -
beforeStatus: string
Title:
Before StatusRead Only:trueMaximum Length:80The previous status assigned to the transaction. -
beforeTransactionDate: string
(date)
Title:
Before Transaction DateRead Only:trueThe previous transaction date assigned to the transaction. -
changeReason: string
Title:
ReasonRead Only:trueMaximum Length:80The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
DetailsRead Only:trueMaximum Length:240Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture transaction change. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the joint venture transaction change was created. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
transactionChangeId: integer
(int64)
Title:
Transaction Change IDRead Only:trueThe unique identifier of the joint venture transaction change.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureGLTransactions-transactionDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction IDRead Only:true
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 update the status of a general ledger transaction identified in Joint Venture Management by submitting a PATCH request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d @JVGLTransactionUpdate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGLTransactions/100100132693415
Request Body Example
The following shows an example of the request body in JSON format.
{
"transactionStatus" : "On hold"
}
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" : "On hold",
"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-21T21:13:22+00:00",
"transactionDate" : "2018-04-30",
}