Update a distribution for a joint venture generated transaction

patch

/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedDistributions/{distributionId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 : distributionDFF
Type: array
Show Source
Nested Schema : schema
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 : jointVentureGeneratedDistributions-item-response
Type: object
Show Source
  • 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 source transaction is associated with.
  • 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: 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: Change Reason
    Maximum Length: 80
    The reason the joint venture distribution was canceled.
  • Title: Change Reason 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
    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: Creation Date
    Read Only: true
    The date and time when the joint venture distribution was created.
  • Title: Customer
    Read Only: true
    Maximum Length: 360
    The name of the customer associated with the invoicing partner.
  • 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 Credit
    Read Only: true
    The distributed credit amount for the stakeholder in accounting currency.
  • Title: Distributed Debit
    Read Only: true
    The distributed debit amount for the stakeholder in accounting currency.
  • distributionDFF
  • Title: Distribution ID
    Read Only: true
    The unique identifier of the joint venture distribution.
  • 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 Type
    Read Only: true
    Maximum Length: 80
    Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • 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 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
    Read Only: true
    Maximum Length: 30
    The name of the joint venture of the source transaction.
  • Title: Joint Venture Classification
    Read Only: true
    Maximum Length: 80
    The classification of the joint venture associated with the distribution.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture.
  • 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: Ledger Category Code
    Read Only: true
    Maximum Length: 30
    The code that identifies the ledger type, such as primary, secondary, and so on.
  • 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.
  • Links
  • Title: Method
    Read Only: true
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the overhead method.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The method type used to determine how the overhead amount is calculated.
  • Title: Notes
    Read Only: true
    Maximum Length: 240
    Additional details about the joint venture source transaction.
  • Title: Original Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the original direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
  • Title: Original Distributed 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.
  • Title: Original Distributed 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.
  • 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.
  • 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.
  • 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: Ownership End Date
    Read Only: true
    Effective end date of the ownership definition that was used to distribute the joint venture transaction.
  • Title: Ownership Start Date
    Read Only: true
    Effective start date of the ownership definition that was used to distribute the joint venture transaction.
  • 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: 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.
  • Title: Partner Account
    Read Only: true
    The combination of account segment values assigned to a partner's line in the receivables invoice.
  • Title: Party Name
    Read Only: true
    Maximum Length: 360
    The name of the party associated with the stakeholder on the joint venture distribution.
  • Title: Ownership Percentage
    Read Only: true
    The percentage of ownership a stakeholder has in a joint venture transaction.
  • Title: Period Basis
    Read Only: true
    Maximum Length: 80
    The value that determines how the period basis is derived for the overhead calculation. Valid values are: Period, Year to period, and Inception to period.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Costing Status
    Read Only: true
    Maximum Length: 80
    The status of the joint venture accounting entries exported to the Project Costing system.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    The unique identifier of the project.
  • 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
    An indicator that rounding was applied to the distribution amount.
  • 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: Distribution Status
    Maximum Length: 80
    The status of the distribution of the joint venture transaction.
  • Title: Supplier
    Read Only: true
    Maximum Length: 360
    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: 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 Credit
    Read Only: true
    The credit amount of the joint venture source transaction.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Transaction Date
    Read Only: true
    Indicates the default effective date for journal entries or the transaction date for subledger entries.
  • Title: Transaction Debit
    Read Only: true
    The debit amount of the joint venture source transaction.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 240
    A description that's passed into the joint venture invoice for the joint venture source transaction.
  • Title: Transaction ID
    Read Only: true
    The unique identifier for the joint venture transaction that the distribution was created from.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The type of the joint venture source transaction.
  • 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 : distributionDFF
Type: array
Show Source
Nested Schema : jointVentureGeneratedDistributions-distributionDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to update a joint venture generated 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/11.13.18.05/jointVentureGeneratedDistributions/100105341985651" 

Example Request Body

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

{
    "status": "On hold"
}

Example Response Body

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

    {
    "distributionId": 100105341985651,
    "status": "On hold",
    "distributionType": "Overhead",
    "lineType": "Original",
    "lineNumber": 1,
    "jointVenture": "APOLLOBASIN",
    "jointVentureDescription": "Oklahoma panhandle project",
    "businessUnit": "HEPP Petroleum USA BU1",
    "jointVentureClassification": "Operated",
    "ownershipDefinition": "CIOPD",
    "ownershipDefinitionStartDate": "2017-01-01",
    "ownershipDefinitionEndDate": "2017-12-31",
    "originalOwnershipDefinitionStartDate": "2017-01-01",
    "originalOwnershipDefinitionEndDate": "2017-12-31",
    "stakeholder": "GOILMEX_ASH6",
    "costCenterSegmentValue": "3020",
    "party": "w_Green Corp",
    "invoicingPartner": null,
    "customer": null,
    "supplier": null,
    "originalStakeholder": null,
    "reassignedStakeholder": "GOILMEX_ASH6",
    "percentageOfInterest": 29.5,
    "roundAmountFlag": false,
    "distributionOnlyFlag": false,
    "splitLinesExistFlag": false,
    "changeReason": null,
    "changeReasonDetails": null,
    "transactionDate": "2017-01-10",
    "transactionId": 100105341985477,
    "directBilledStakeholder": null,
    "originalDirectBilledStakeholder": null,
    "originalOwnershipDefinition": "CIOPD",
    "accountingPeriod": "Jan-17",
    "ledger": "HEPPLedger US",
    "ledgerCategoryCode": "PRIMARY",
    "transactionType": "Overhead",
    "method": "OH_APOLLOGLOBAL1805210359",
    "methodDescription": "Overhead for APOLLOGLOBAL",
    "methodType": "Percentage of cost",
    "basisSource": "Joint venture billed transactions",
    "periodBasis": null,
    "transactionDescription": "OH_BA0505212350",
    "partnerOffsetAccount": "",
    "targetTransactionHeaderAccount": "",
    "targetTransactionId": null,
    "trxNumber": null,
    "trxDate": null,
    "invoiceTransactionType": null,
    "distributedDebit": 83013,
    "distributedCredit": null,
    "originalDistributedDebit": 83013,
    "originalDistributedCredit": null,
    "originalDistributedEnteredDebit": null,
    "originalDistributedEnteredCredit": null,
    "transactionDebit": 281400,
    "transactionCredit": null,
    "transactionCurrency": "USD",
    "contributionId": null,
    "contributionAmount": null,
    "contributionRequest": null,
    "agreement": "CIAGREEMENT1",
    "agreementDescription": null,
    "projectCostingStatus": "Not applicable",
    "project": null,
    "projectNumber": null,
    "task": null,
    "taskNumber": null,
    "expenditureType": null,
    "expenditureTypeDescription": null,
    "createdBy": "username",
    "creationDate": "2024-02-15T07:35:37+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2024-02-21T06:42:50+00:00",
    "notes": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedDistributions/100105341985651",
            "name": "jointVentureGeneratedDistributions",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedDistributions/100105341985651",
            "name": "jointVentureGeneratedDistributions",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedDistributions/100105341985651/child/distributionDFF",
            "name": "distributionDFF",
            "kind": "collection"
        }
    ]
}
Back to Top