Update a joint venture general ledger distribution
patch
/fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}
Request
Path Parameters
-
distributionId(required): integer(int64)
The unique identifier of the joint venture distribution.
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
-
Account: 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, and expenses. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason the joint venture distribution was canceled. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture distribution line was canceled -
distributionDFF: array
distributionDFF
-
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced. -
distributionStatus: string
Title:
Distribution Status
Maximum Length:255
The status code to identify the state of the distribution of the joint venture transaction. It is based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth. -
partnerOffsetAccount: array
Offset Account Key Flexfields
Title:
Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses. -
reassignedStakeholder: string
Title:
Reassigned Stakeholder
Maximum Length:30
The name of the stakeholder that's reassigned to the joint venture distribution. -
splitLinesExistFlag: boolean
Title:
Split Lines Exist
Default Value:false
Indicates that split lines exist for the joint venture distribution.
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, and expenses.
Show Source
Nested Schema : Offset Account Key Flexfields
Type:
array
Title:
Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Show Source
Nested Schema : jointVentureGLDistributions-Account-item-patch-request
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. -
AccountType: string
Title:
Account Type
Maximum Length:1
Key flexfield combination type (Asset, Liability, etc). -
DetailBudgetingAllowedFlag: string
Maximum Length:
1
Detail budgeting flag. -
DetailPostingAllowedFlag: string
Title:
Allow Posting
Maximum Length:1
Detail posting flag. -
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. -
FinancialCategory: string
Maximum Length:
30
Key flexfield financial category. -
JgzzReconFlag: string
Maximum Length:
1
Global reconciliation descriptive flexfield segment. -
Reference3: string
Maximum Length:
25
Control account flag. -
StartDateActive: string
(date)
Title:
From Date
Date before which key flexfield combination is invalid. -
SummaryFlag: string
Title:
Code Combination Summary
Maximum Length:1
Summary account flag.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : jointVentureGLDistributions-partnerOffsetAccount-item-patch-request
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. -
AccountType: string
Title:
Account Type
Maximum Length:1
Key flexfield combination type (Asset, Liability, etc). -
DetailBudgetingAllowedFlag: string
Maximum Length:
1
Detail budgeting flag. -
DetailPostingAllowedFlag: string
Title:
Allow Posting
Maximum Length:1
Detail posting flag. -
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. -
FinancialCategory: string
Maximum Length:
30
Key flexfield financial category. -
JgzzReconFlag: string
Maximum Length:
1
Global reconciliation descriptive flexfield segment. -
Reference3: string
Maximum Length:
25
Control account flag. -
StartDateActive: string
(date)
Title:
From Date
Date before which key flexfield combination is invalid. -
SummaryFlag: string
Title:
Code Combination Summary
Maximum Length:1
Summary account flag.
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 : jointVentureGLDistributions-item-response
Type:
Show Source
object
-
Account: 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, and expenses. -
agreement: string
Title:
Carried Interest Agreement
Read Only:true
Maximum Length:30
The name of the agreement of the carried interest distribution. -
agreementDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the agreement of the carried interest distribution. -
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. -
businessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the joint venture. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason the joint venture distribution was canceled. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture distribution line was canceled -
contributionAmount: number
Title:
Contribution Amount
Read Only:true
The partner contribution amount that's associated with a distribution. -
contributionId: integer
(int64)
Title:
Partner Contribution ID
Read Only:true
The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from. -
contributionRequest: string
Title:
Partner Contribution Request
Read Only:true
Maximum Length:30
The name of the partner contribution request. -
costCenterSegmentValue: string
Title:
Cost Center
Read Only:true
Maximum Length:25
The cost center segment value associated with the distributed stakeholder. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture distribution. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture distribution was created. -
currencyCode: string
Title:
Accounting Currency
Read Only:true
Maximum Length:15
The currency code of accounting currency of the source joint venture transaction. -
customerName: string
Title:
Customer
Read Only:true
The name of the customer associated with the invoicing partner. -
directBilledStakeholderName: string
Title:
Direct Billed Stakeholder
Read Only:true
Maximum Length:30
Unique identifier of the stakeholder that is to be directly billed for the transaction. -
distributedAccountInformation: string
Title:
Account
Read Only:true
The combination of the values of the account segments assigned to the transaction. -
distributedCreditAmount: number
Title:
Distributed Accounted Credit
Read Only:true
The distribution credit amount for the stakeholder in accounting currency. -
distributedDebitAmount: number
Title:
Distributed Accounted Debit
Read Only:true
The distribution debit amount for the stakeholder in accounting currency. -
distributedEnteredCreditAmount: number
Title:
Distributed Entered Credit
Read Only:true
The distributed credit amount for the stakeholder in the entered currency. -
distributedEnteredDebitAmount: number
Title:
Distributed Entered Debit
Read Only:true
The distributed debit amount for the stakeholder in the entered currency. -
distributionDFF: array
distributionDFF
-
distributionId: integer
(int64)
Title:
Distribution ID
Read Only:true
The unique identifier of the joint venture distribution. -
distributionLineNumber: integer
(int32)
Title:
Distribution Line Number
Read Only:true
The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws. -
distributionLineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of the distribution line for billing adjustments. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced. -
distributionStatus: string
Title:
Distribution Status
Maximum Length:255
The status code to identify the state of the distribution of the joint venture transaction. It is based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth. -
distributionType: string
Title:
Account Type
Read Only:true
Maximum Length:255
Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth. -
enteredCurrencyCode: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
The currency code entered on the original transaction. -
invoiceTransactionType: string
Title:
Invoice Type
Read Only:true
Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo. -
invoicingPartnerName: string
Title:
Invoicing Partner
Read Only:true
Maximum Length:30
The name of the invoicing partner associated with the distribution stakeholder. -
jointVentureClassification: string
Title:
Joint Venture Classification
Read Only:true
Maximum Length:80
The classification of the joint venture associated with the distribution. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture of the source transaction. -
jointVentureName: string
Title:
Joint Venture
Read Only:true
Maximum Length:30
The name of the joint venture of the source transaction. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture distribution was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture distribution. -
ledgerCategoryCode: string
Title:
Ledger Category Code
Read Only:true
Maximum Length:30
The code that identifies the ledger type, such as primary, secondary, and so on. -
ledgerName: string
Title:
Ledger
Read Only:true
Maximum Length:30
The name of the ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
originalDirectBilledStakeholderName: string
Title:
Original Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The original stakeholder assigned to the joint venture transaction that the distribution was created from. -
originalDistributedCreditAmount: number
Title:
Original Distributed Accounted Credit
Read Only:true
The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions. -
originalDistributedDebitAmount: number
Title:
Original Distributed Accounted Debit
Read Only:true
The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions. -
originalDistributedEnteredCreditAmount: number
Title:
Original Distributed Entered Credit
Read Only:true
The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions. -
originalDistributedEnteredDebitAmount: number
Title:
Original Distributed Entered Debit
Read Only:true
The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions. -
originalOwnershipDefinitionName: string
Title:
Original Ownership Definition
Read Only:true
Maximum Length:20
The original ownership definition assigned to the joint venture transaction that the distribution was created from. -
originalStakeholder: string
Title:
Original Stakeholder
Read Only:true
Maximum Length:30
The name of the stakeholder that was originally associated with the joint venture distribution. -
ownershipDefinitionEndDate: string
(date)
Title:
Ownership End Date
Read Only:true
Effective end date of the ownership definition that was used to distribute the joint venture transaction. -
ownershipDefinitionName: string
Title:
Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used to process the distribution. -
ownershipDefinitionStartDate: string
(date)
Title:
Ownership Start Date
Read Only:true
Effective start date of the ownership definition that was used to distribute the joint venture transaction. -
ownershipEffectiveEndDate: string
(date)
Title:
End Date
Read Only:true
The end date of the effective date range of the ownership definition. -
ownershipEffectiveStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date of the effective date range of the ownership definition. -
partnerOffsetAccount: array
Offset Account Key Flexfields
Title:
Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses. -
partnerOffsetAccountInformation: string
Title:
Partner Account
Read Only:true
The combination of account segment values assigned to a partner's line in the receivables invoice. -
percentageOfInterest: number
Title:
Ownership Percentage
Read Only:true
The percentage of ownership a stakeholder has in a joint venture transaction. -
periodName: string
Title:
Period Name
Read Only:true
Maximum Length:15
The accounting period name in a calendar. -
reassignedStakeholder: string
Title:
Reassigned Stakeholder
Maximum Length:30
The name of the stakeholder that's reassigned to the joint venture distribution. -
roundAmountFlag: boolean
Title:
Rounding Applied
Read Only:true
Maximum Length:1
A flag to identify if rounding was applied to the distribution amount. -
sourceOwnershipDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The original ownership definition assigned to the joint venture transaction that the distribution was created from. -
splitLinesExistFlag: boolean
Title:
Split Lines Exist
Default Value:false
Indicates that split lines exist for the joint venture distribution. -
stakeholderName: string
Title:
Stakeholder
Read Only:true
Maximum Length:30
The name of the distribution stakeholder. -
statisticalAmount: number
Title:
Units
Read Only:true
The statistical unit of measure of the journal entry line. -
supplierName: string
Title:
Supplier
Read Only:true
The name of the supplier associated with invoicing partner. -
targetTransactionHeaderAccount: string
Title:
Target Transaction Account
Read Only:true
The combination of segment values for the receivable or liability account used when posting a receivables or payables invoice. -
targetTransactionId: integer
(int64)
Title:
Target Transaction ID
Read Only:true
The unique identifier for the external transaction created for joint venture distributions. For example, accounts receivable invoice, credit memo, accounts payable invoice, or journal entry. -
transactionCreditAmount: number
Title:
Transaction Accounted Credit
Read Only:true
The transaction credit amount in accounting currency. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
Indicates the default effective date for journal entries or the transaction date for subledger entries. -
transactionDebitAmount: number
Title:
Transaction Accounted Debit
Read Only:true
The transaction debit amount in accounting currency. -
transactionDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
The description of the general ledger journal entry line. -
transactionEnteredCreditAmount: number
Title:
Transaction Entered Credit
Read Only:true
The transaction credit amount in the entered currency. -
transactionEnteredDebitAmount: number
Title:
Transaction Entered Debit
Read Only:true
The transaction debit amount in the entered currency. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier for the joint venture transaction that the distribution was created from. -
trxDate: string
(date)
Title:
Invoice Date
Read Only:true
The date of the invoice transaction generated for the joint venture distribution. -
trxNumber: string
Title:
Invoice Number
Read Only:true
Maximum Length:20
A unique value that identifies the invoice generated for the joint venture distribution.
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, and expenses.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Offset Account Key Flexfields
Type:
array
Title:
Offset Account Key Flexfields
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
Show Source
Nested Schema : jointVentureGLDistributions-Account-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. -
AccountType: string
Title:
Account Type
Maximum Length:1
Key flexfield combination type (Asset, Liability, etc). -
DetailBudgetingAllowedFlag: string
Maximum Length:
1
Detail budgeting flag. -
DetailPostingAllowedFlag: string
Title:
Allow Posting
Maximum Length:1
Detail posting flag. -
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. -
FinancialCategory: string
Maximum Length:
30
Key flexfield financial category. -
JgzzReconFlag: string
Maximum Length:
1
Global reconciliation descriptive flexfield segment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Reference3: string
Maximum Length:
25
Control account flag. -
StartDateActive: string
(date)
Title:
From Date
Date before which key flexfield combination is invalid. -
SummaryFlag: string
Title:
Code Combination Summary
Maximum Length:1
Summary account flag.
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.
Nested Schema : jointVentureGLDistributions-distributionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
DistributionId: integer
(int64)
Title:
Distribution 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 : jointVentureGLDistributions-partnerOffsetAccount-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. -
AccountType: string
Title:
Account Type
Maximum Length:1
Key flexfield combination type (Asset, Liability, etc). -
DetailBudgetingAllowedFlag: string
Maximum Length:
1
Detail budgeting flag. -
DetailPostingAllowedFlag: string
Title:
Allow Posting
Maximum Length:1
Detail posting flag. -
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. -
FinancialCategory: string
Maximum Length:
30
Key flexfield financial category. -
JgzzReconFlag: string
Maximum Length:
1
Global reconciliation descriptive flexfield segment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Reference3: string
Maximum Length:
25
Control account flag. -
StartDateActive: string
(date)
Title:
From Date
Date before which key flexfield combination is invalid. -
SummaryFlag: string
Title:
Code Combination Summary
Maximum Length:1
Summary account flag.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Account
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}/child/AccountParameters:
- distributionId:
$request.path.distributionId
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses. - distributionId:
- distributionDFF
-
Parameters:
- distributionId:
$request.path.distributionId
- distributionId:
- partnerOffsetAccount
-
Parameters:
- distributionId:
$request.path.distributionId
The code identifying the subledger accounting offset account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses. - distributionId:
Examples
The following example shows how to update the status of a distribution originating from the general ledger 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 @JVGLDistributionUpdate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/100100134929670
Request Body Example
The following shows an example of the request body in JSON format.
{ "distributionStatus" : "On hold" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "createdBy" : "username", "creationDate" : "2020-02-19T18:01:44+00:00", "currencyCode" : "USD", "distributedCreditAmount" : null, "distributedDebitAmount" : 1649.76, "distributionId" : 100100134929670, "lastUpdateDate" : "2020-02-20T21:22:16+00:00", "lastUpdatedBy" : "username", "percentageOfInterest" : 35, "roundAmountFlag" : false, "transactionDate" : "2006-08-05", "transactionId" : 100100134927101, "jointVentureName" : "APOLLOBASIN", "jointVentureDescription" : "Oklahoma panhandle project.\nLot32, Parcel 1TR5-A", "ownershipDefinitionName" : "BASINOD", "stakeholderName" : "APOLLOTRANS", "invoicingPartnerName" : null, "costCenterSegmentValue" : "112", "periodName" : "Aug-06", "distributionStatus" : "On hold", "distributionType" : "Expense", "supplierName" : null, "customerName" : null, "distributedAccountInformation" : "01-510-7420-0000-000", "distributionOnlyFlag" : false, "ledgerName" : "Vision Operations (USA)", "transactionCreditAmount" : null, "transactionDebitAmount" : 4713.6, "transactionDescription" : "Journal Import Created", "originalOwnershipDefinitionName" : "BASINOD", "ownershipEffectiveEndDate" : "2006-12-31", "ownershipEffectiveStartDate" : "2006-01-01", "originalDirectBilledStakeholderName" : null, "directBilledStakeholderName" : null, "businessUnitName" : "Vision Operations", "statisticalAmount" : null, }