1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Joint Venture General Ledger Distributions

Update a joint venture general ledger distribution

patch

/fscmRestApi/resources/11.13.18.05/jointVentureGLDistributions/{distributionId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
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, and expenses.
Show Source
Nested Schema : distributionDFF
Type: array
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: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : jointVentureGLDistributions-partnerOffsetAccount-item-patch-request
Type: object
Show Source
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 : jointVentureGLDistributions-item-response
Type: object
Show Source
  • 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.
  • Title: Account Description
    Read Only: true
    The description of the account assigned to the joint venture transaction.
  • Title: Accounting Date
    Read Only: true
    The date used to determine the accounting period for the transaction.
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the agreement of the carried interest distribution.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the agreement of the carried interest distribution.
  • 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.
  • Title: Batch ID
    Read Only: true
    The unique identifier of the batch.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the business unit associated with the joint venture.
  • Title: Reason
    Maximum Length: 80
    The reason the joint venture distribution was canceled.
  • Title: Details
    Maximum Length: 240
    Additional text to describe the reason the joint venture distribution line was canceled
  • Title: Contribution Amount
    Read Only: true
    The partner contribution amount that's associated with a distribution.
  • Title: Partner Contribution ID
    Read Only: true
    The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
  • Title: Partner Contribution Request
    Read Only: true
    Maximum Length: 30
    The name of the partner contribution request.
  • Title: Cost Center Description
    Read Only: true
    The description of the cost center segment value associated with the joint venture stakeholder.
  • Title: Cost Center
    Read Only: true
    Maximum Length: 25
    The cost center segment value associated with the distributed stakeholder.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture distribution.
  • Title: Created by Joint Venture
    Read Only: true
    Maximum Length: 1
    A 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.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture distribution was created.
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency code of accounting currency of the source joint venture transaction.
  • Title: Customer
    Read Only: true
    The name of the customer associated with the invoicing partner.
  • Title: Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    Unique identifier of the stakeholder that is to be directly billed for the transaction.
  • Title: Account
    Read Only: true
    The combination of the values of the account segments assigned to the transaction.
  • Title: Distributed Accounted Credit
    Read Only: true
    The distribution credit amount for the stakeholder in accounting currency.
  • Title: Distributed Accounted Debit
    Read Only: true
    The distribution debit amount for the stakeholder in accounting currency.
  • Title: Distributed Entered Credit
    Read Only: true
    The distributed credit amount for the stakeholder in the entered currency.
  • Title: Distributed Entered Debit
    Read Only: true
    The distributed debit amount for the stakeholder in the entered currency.
  • distributionDFF
  • Title: Distribution ID
    Read Only: true
    The unique identifier of the joint venture distribution.
  • 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.
  • Title: Distribution Line Type
    Read Only: true
    Maximum Length: 80
    The type of the distribution line for billing adjustments.
  • Title: Distribution Only
    Maximum Length: 1
    Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
  • 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.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 255
    Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    The currency code entered on the original transaction.
  • Title: General Ledger Category
    Read Only: true
    Maximum Length: 25
    The financial category associated with the account on the joint venture transaction.
  • Title: Header ID
    Read Only: true
    The unique identifier of the journal.
  • 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.
  • Title: Invoicing Partner
    Read Only: true
    Maximum Length: 30
    The name of the invoicing partner associated with the distribution stakeholder.
  • Title: Joint Venture Classification
    Read Only: true
    Maximum Length: 80
    The classification of the joint venture associated with the distribution.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture of the source transaction.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The name of the joint venture of the source transaction.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the joint venture distribution was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the joint venture distribution.
  • Title: Ledger Category Code
    Read Only: true
    Maximum Length: 30
    The code that identifies the ledger type, such as primary, secondary, and so on.
  • Title: Ledger
    Read Only: true
    Maximum Length: 30
    The name of the ledger.
  • Links
  • 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.
  • 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 between partner contributions.
  • 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 between partner contributions.
  • 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 between partner contributions.
  • 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 between partner contributions.
  • 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.
  • Title: Original Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the stakeholder that was originally associated with the joint venture distribution.
  • Title: Ownership End Date
    Read Only: true
    Effective end date of the ownership definition that was used to distribute the joint venture transaction.
  • Title: Ownership Definition
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition used to process the distribution.
  • Title: Ownership Start Date
    Read Only: true
    Effective start date of the ownership definition that was used to distribute the joint venture transaction.
  • Title: End Date
    Read Only: true
    The end date of the effective date range of the ownership definition.
  • Title: Start Date
    Read Only: true
    The start date of the effective date range of the ownership definition.
  • 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.
  • Title: Partner Account
    Read Only: true
    The combination of account segment values assigned to a partner's line in the receivables invoice.
  • Title: Ownership Percentage
    Read Only: true
    The percentage of ownership a stakeholder has in a joint venture transaction.
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 15
    The accounting period name in a calendar.
  • Title: Reassigned Stakeholder
    Maximum Length: 30
    The name of the stakeholder that's reassigned to the joint venture distribution.
  • Title: Rounding Applied
    Read Only: true
    Maximum Length: 1
    A flag to identify if rounding was applied to the distribution amount.
  • 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.
  • Title: Split Lines Exist
    Read Only: true
    Default Value: false
    Indicates that split lines exist for the joint venture distribution.
  • Title: Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the distribution stakeholder.
  • Title: Stakeholder Reporting Date
    Read Only: true
    The date the stakeholder reporting journal was created.
  • Title: Stakeholder Reporting Header ID
    Read Only: true
    The unique identifier of the stakeholder reporting journal created for the distribution.
  • Title: Stakeholder Reporting Ledger
    Read Only: true
    Maximum Length: 30
    The name of the ledger which will be used for stakeholder reporting.
  • Title: Stakeholder Reporting Status
    Maximum Length: 80
    The status of the accounting for the stakeholder reporting distribution.
  • Title: Units
    Read Only: true
    The statistical unit of measure of the journal entry line.
  • Title: Supplier
    Read Only: true
    The name of the supplier associated with invoicing partner.
  • 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.
  • 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.
  • Title: Transaction Accounted Credit
    Read Only: true
    The transaction credit amount in accounting currency.
  • Title: Transaction Date
    Read Only: true
    Indicates the default effective date for journal entries or the transaction date for subledger entries.
  • Title: Transaction Accounted Debit
    Read Only: true
    The transaction debit amount in accounting currency.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 240
    The description of the general ledger journal entry line.
  • Title: Transaction Entered Credit
    Read Only: true
    The transaction credit amount in the entered currency.
  • Title: Transaction Entered Debit
    Read Only: true
    The transaction debit amount in the entered currency.
  • Title: Transaction ID
    Read Only: true
    The unique identifier for the joint venture transaction that the distribution was created from.
  • Title: Invoice Date
    Read Only: true
    The date of the invoice transaction generated for the joint venture distribution.
  • 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 : distributionDFF
Type: array
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: object
Show Source
Nested Schema : jointVentureGLDistributions-distributionDFF-item-response
Type: object
Show Source
Nested Schema : jointVentureGLDistributions-partnerOffsetAccount-item-response
Type: object
Show Source
Links
Account
Parameters:
  • distributionId: $request.path.distributionId
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, and expenses.
distributionDFF
Parameters:
  • distributionId: $request.path.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.
Back to Top

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,
}
Back to Top