Update a joint venture distribution

patch

/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/{jointVentureDistributionsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Joint Venture Distributions resource and used to uniquely identify an instance of Joint Venture Distributions. The client should not generate the hash key value. Instead, the client should query on the Joint Venture Distributions collection resource in order to navigate to a specific instance of Joint Venture Distributions to get the hash key.
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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
  • 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: Distribution Only
    Maximum Length: 1
    Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
  • Title: Project Costing Status
    Maximum Length: 80
    The status of the export to Project Costing.
  • Title: Stakeholder
    Maximum Length: 30
    The name of the distribution stakeholder.
  • Title: Stakeholder Reporting Status
    Maximum Length: 80
    The status of the accounting for the stakeholder reporting distribution.
  • Title: Distribution Status
    Maximum Length: 80
    The status of the distribution of the joint venture transaction.
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 : jointVentureDistributions-item-response
Type: object
Show Source
  • Title: Account
    Read Only: true
    Maximum Length: 255
    The account assigned to the joint venture transaction.
  • Title: Transaction Accounted Credit
    Read Only: true
    The transaction credit amount in accounting currency.
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Transaction Accounted Debit
    Read Only: true
    The transaction debit amount in accounting currency.
  • Title: Accounting Date
    Read Only: true
    The date used to determine the accounting period for the transaction.
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 15
    The name of the fiscal period that the joint venture transaction is associated with.
  • Title: Account Segment 1
    Read Only: true
    Maximum Length: 25
    The segment 1 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 10
    Read Only: true
    Maximum Length: 25
    The segment 10 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 11
    Read Only: true
    Maximum Length: 25
    The segment 11 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 12
    Read Only: true
    Maximum Length: 25
    The segment 12 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 13
    Read Only: true
    Maximum Length: 25
    The segment 13 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 14
    Read Only: true
    Maximum Length: 25
    The segment 14 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 15
    Read Only: true
    Maximum Length: 25
    The segment 15 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 16
    Read Only: true
    Maximum Length: 25
    The segment 16 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 17
    Read Only: true
    Maximum Length: 25
    The segment 17 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 18
    Read Only: true
    Maximum Length: 25
    The segment 18 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 19
    Read Only: true
    Maximum Length: 25
    The segment 19 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 2
    Read Only: true
    Maximum Length: 25
    The segment 2 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 20
    Read Only: true
    Maximum Length: 25
    The segment 20 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 21
    Read Only: true
    Maximum Length: 25
    The segment 21 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 22
    Read Only: true
    Maximum Length: 25
    The segment 22 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 23
    Read Only: true
    Maximum Length: 25
    The segment 23 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 24
    Read Only: true
    Maximum Length: 25
    The segment 24 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 25
    Read Only: true
    Maximum Length: 25
    The segment 25 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 26
    Read Only: true
    Maximum Length: 25
    The segment 26 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 27
    Read Only: true
    Maximum Length: 25
    The segment 27 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 28
    Read Only: true
    Maximum Length: 25
    The segment 28 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 29
    Read Only: true
    Maximum Length: 25
    The segment 29 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 3
    Read Only: true
    Maximum Length: 25
    The segment 3 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 30
    Read Only: true
    Maximum Length: 25
    The segment 30 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 4
    Read Only: true
    Maximum Length: 25
    The segment 4 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 5
    Read Only: true
    Maximum Length: 25
    The segment 5 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 6
    Read Only: true
    Maximum Length: 25
    The segment 6 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 7
    Read Only: true
    Maximum Length: 25
    The segment 7 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 8
    Read Only: true
    Maximum Length: 25
    The segment 8 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 9
    Read Only: true
    Maximum Length: 25
    The segment 9 value of the account assigned to the joint venture transaction.
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the carried interest agreement associated with the joint venture transaction.
  • 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: Basis Source
    Read Only: true
    Maximum Length: 80
    The source of the overhead calculation amount.
  • 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: Partner Contribution ID
    Read Only: true
    The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
  • Title: Cost Center
    Read Only: true
    Maximum Length: 25
    The cost center segment value associated with the distribution 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: Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
  • Title: Distributed Accounted Credit
    Read Only: true
    The distributed credit amount for the stakeholder in accounting currency.
  • Title: Distributed Accounted Debit
    Read Only: true
    The distributed 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.
  • 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 Only
    Maximum Length: 1
    Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
  • Title: Transaction Entered Credit
    Read Only: true
    The transaction credit amount in the entered currency.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    The currency code entered on the original transaction.
  • Title: Transaction Entered Debit
    Read Only: true
    The transaction debit amount in the entered currency.
  • Title: Expenditure Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the expenditure business unit in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
  • Title: Expenditure Item Date
    Read Only: true
    The date of the expenditure in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
  • Title: Expenditure Organization
    Read Only: true
    Maximum Length: 240
    The name of the expenditure organization in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
  • Title: Expenditure Type
    Read Only: true
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Expenditure Type Description
    Read Only: true
    Maximum Length: 2000
    The description of the expenditure type.
  • 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: 150
    A unique value that identifies the invoice generated for the joint venture distribution.
  • Title: Invoice Type
    Read Only: true
    Maximum Length: 80
    Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The unique name of the joint venture.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture.
  • 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: 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
    Read Only: true
    Maximum Length: 30
    The name of the ledger.
  • Title: Legal Entity
    Read Only: true
    Maximum Length: 240
    The name of the legal entity associated with the joint venture.
  • Title: Distribution Line Type
    Read Only: true
    Maximum Length: 80
    The type of the distribution line for billing adjustments.
  • Links
  • Title: Method
    Read Only: true
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Net Transaction Accounted Amount
    Read Only: true
    The net transaction amount in the accounting currency.
  • Title: Net Distributed Accounted Amount
    Read Only: true
    The net distributed amount for the stakeholder in accounted currency.
  • Title: Net Distributed Entered Amount
    Read Only: true
    The net distributed amount for the stakeholder in entered currency.
  • Title: Net Transaction Entered Amount
    Read Only: true
    The net transaction amount in the entered currency.
  • Title: Net Original Distributed Accounted Amount
    Read Only: true
    The original net amount of the joint venture distribution in the accounted currency. This is the amount prior to being split by partner contributions.
  • Title: Net Original Distributed Entered Amount
    Read Only: true
    The original net amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
  • Title: Notes
    Read Only: true
    Maximum Length: 240
    Additional details about the joint venture source transaction.
  • 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: 30
    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 Definition
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition used to process the distribution.
  • Title: Ownership End Date
    Read Only: true
    The end date of the effective date range of the ownership definition.
  • Title: Ownership Start Date
    Read Only: true
    The start date of the effective date range of the ownership definition.
  • Title: Ownership Percentage
    Read Only: true
    The percentage of ownership a stakeholder has in a joint venture transaction.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Costing Status
    Maximum Length: 80
    The status of the export to Project Costing.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    The unique identifier of the project.
  • Title: Rounding Applied
    Read Only: true
    Maximum Length: 1
    An indicator that rounding was applied to the distribution amount.
  • Title: Source
    Read Only: true
    Maximum Length: 512
    The name of the application the transaction originated from, for example Payables or Cost Management.
  • Title: Stakeholder
    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: Distribution Status
    Maximum Length: 80
    The status of the distribution of the joint venture transaction.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    The name of the project task representing a subdivision of work.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    The unique number of the project task.
  • Title: Transaction Date
    Read Only: true
    The date when the joint venture source transaction occurred.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 240
    The description to include on the transactions created through invoice or internal transfer journal processing.
  • Title: Transaction ID
    Read Only: true
    The unique identifier of the joint venture transaction.
  • Title: Transaction Source
    Read Only: true
    Maximum Length: 255
    The source of the joint venture transaction, for example general ledger, subledger accounting, or joint venture.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 80
    The type of transaction the distribution represents, such as expense, revenue, and so forth.
Back to Top

Examples

The following example shows how to update a joint venture distribution by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH
"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/latest/jointVentureDistributions/100106787338832"

Example Request Body

The following shows an example of the request body in JSON format.

{
    "status": "On hold",
    "changeReason": "Setup issue"
}

Example Response Body

The following shows an example of the response body in JSON format.
{
    "distributionId": 100106787338832,
    "status": "On hold",
    "lineType": "Original",
    "distributionLineNumber": 1,
    "transactionType": "Manual cost",
    "source": "Joint Venture Management",
    "transactionSource": "Manual",
    "transactionId": 100106787338831,
    "transactionDate": "2017-02-27",
    "accountingDate": "2017-02-28",
    "accountingPeriod": "Feb-17",
    "ledger": "HEPPLedger US",
    "jointVenture": "APOLLOBASIN",
    "jointVentureDescription": "Oklahoma panhandle project",
    "businessUnit": "HEPP Petroleum USA BU1",
    "legalEntity": "HEPP Inc",
    "originalOwnershipDefinition": null,
    "ownershipDefinition": null,
    "ownershipDefinitionStartDate": null,
    "ownershipDefinitionEndDate": null,
    "originalStakeholder": null,
    "stakeholder": "GOILMEX_ASH6",
    "costCenter": null,
    "directBilledStakeholder": "GOILMEX_ASH6",
    "ownershipPercentage": 100,
    "roundAmountFlag": false,
    "distributionOnlyFlag": false,
    "account": "11-1001-11010-11-0001",
    "accountSegment1": "11",
    "accountSegment2": "1001",
    "accountSegment3": "11010",
    "accountSegment4": "11",
    "accountSegment5": "0001",
    "accountSegment6": null,
    "accountSegment7": null,
    "accountSegment8": null,
    "accountSegment9": null,
    "accountSegment10": null,
    "accountSegment11": null,
    "accountSegment12": null,
    "accountSegment13": null,
    "accountSegment14": null,
    "accountSegment15": null,
    "accountSegment16": null,
    "accountSegment17": null,
    "accountSegment18": null,
    "accountSegment19": null,
    "accountSegment20": null,
    "accountSegment21": null,
    "accountSegment22": null,
    "accountSegment23": null,
    "accountSegment24": null,
    "accountSegment25": null,
    "accountSegment26": null,
    "accountSegment27": null,
    "accountSegment28": null,
    "accountSegment29": null,
    "accountSegment30": null,
    "netAccounted": 220000,
    "accountedDebit": 220000,
    "accountedCredit": null,
    "netEntered": 220000,
    "enteredDebit": 220000,
    "enteredCredit": null,
    "transactionDescription": null,
    "assignmentRule": null,
    "agreement": null,
    "method": null,
    "basisSource": null,
    "notes": null,
    "netOriginalDistributedAccounted": 220000,
    "originalDistributedAccountedDebit": 220000,
    "originalDistributedAccountedCredit": null,
    "netDistributedAccounted": 220000,
    "distributedAccountedDebit": 220000,
    "distributedAccountedCredit": null,
    "accountedCurrencyCode": "USD",
    "netOriginalDistributedEntered": 0,
    "originalDistributedEnteredDebit": null,
    "originalDistributedEnteredCredit": null,
    "netDistributedEntered": 0,
    "distributedEnteredDebit": null,
    "distributedEnteredCredit": null,
    "enteredCurrencyCode": null,
    "invoiceNumber": null,
    "invoiceDate": null,
    "invoiceType": null,
    "journalNumber": null,
    "contributionId": 100106787332390,
    "projectCostingStatus": "Not applicable",
    "project": null,
    "projectNumber": null,
    "task": null,
    "taskNumber": null,
    "expenditureType": null,
    "expenditureTypeDescription": null,
    "expenditureOrganization": null,
    "expenditureBusinessUnit": null,
    "expenditureItemDate": null,
    "createdByJointVentureFlag": false,
    "stakeholderReportingHeaderId": null,
    "stakeholderReportingLedger": null,
    "stakeholderReportingDate": null,
    "stakeholderReportingStatus": "Available to process",
    "changeReason": null,
    "changeReasonDetails": null,
    "createdBy": "username",
    "creationDate": "2025-05-30T06:33:11+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2025-05-30T07:13:25+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106787338832",
            "name": "jointVentureDistributions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106787338832",
            "name": "jointVentureDistributions",
            "kind": "item"
        }
    ]
}
Back to Top