Jump to

• Request
• Response
• Examples

Update a distribution for a joint venture generated transaction

patch

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

Request

Path Parameters

• distributionId(required): integer(int64)
  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

• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• reassignedStakeholder: string
  Title: Reassigned Stakeholder

  Maximum Length: 30

  The name of the stakeholder that's reassigned to the joint venture distribution.
• status: string
  Title: Distribution Status

  Maximum Length: 80

  The status of the distribution of the joint venture transaction.

{
    "type":"object",
    "properties":{
        "distributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureGeneratedDistributions-distributionDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":240,
            "type":"string",
            "description":"Additional text to describe the reason the joint venture distribution line was canceled",
            "nullable":true
        },
        "reassignedStakeholder":{
            "title":"Reassigned Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder that's reassigned to the joint venture distribution.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "stakeholder"
                ]
            }
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The reason the joint venture distribution was canceled.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChangeReason"
                ]
            }
        },
        "status":{
            "title":"Distribution Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the distribution of the joint venture transaction.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.",
            "nullable":true
        }
    }
}

Nested Schema : distributionDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureGeneratedDistributions-distributionDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : jointVentureGeneratedDistributions-item-response

Type: object

Show Source

• accountingPeriod: string
  Title: Accounting Period

  Read Only: true

  Maximum Length: 15

  The name of the fiscal period that the source transaction is associated with.
• 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.
• basisSource: string
  Title: Basis Source

  Read Only: true

  Maximum Length: 80

  The source of the overhead calculation amount.
• businessUnit: 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.
• customer: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

  The name of the customer associated with the invoicing partner.
• directBilledStakeholder: string
  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.
• distributedCredit: number
  Title: Distributed Credit

  Read Only: true

  The distributed credit amount for the stakeholder in accounting currency.
• distributedDebit: number
  Title: Distributed Debit

  Read Only: true

  The distributed debit amount for the stakeholder in accounting currency.
• distributionDFF: array distributionDFF
• distributionId: integer (int64)
  Title: Distribution ID

  Read Only: true

  The unique identifier of the joint venture distribution.
• 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.
• distributionType: string
  Title: Distribution Type

  Read Only: true

  Maximum Length: 80

  Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
• expenditureType: string
  Title: Expenditure Type

  Read Only: true

  Maximum Length: 240

  The name identifying the expenditure classification.
• expenditureTypeDescription: string
  Title: Expenditure Type Description

  Read Only: true

  Maximum Length: 2000

  The description of the expenditure type.
• 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.
• invoicingPartner: string
  Title: Invoicing Partner

  Read Only: true

  Maximum Length: 30

  The name of the invoicing partner associated with the distribution stakeholder.
• jointVenture: string
  Title: Joint Venture

  Read Only: true

  Maximum Length: 30

  The name of the joint venture of the source transaction.
• 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: Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• 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.
• ledger: string
  Title: Ledger

  Read Only: true

  Maximum Length: 30

  The name of the ledger.
• 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.
• lineNumber: 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.
• lineType: string
  Title: Distribution Line Type

  Read Only: true

  Maximum Length: 80

  The type of the distribution line for billing adjustments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• method: string
  Title: Method

  Read Only: true

  Maximum Length: 30

  The unique name of the overhead method.
• methodDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the overhead method.
• methodType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The method type used to determine how the overhead amount is calculated.
• notes: string
  Title: Notes

  Read Only: true

  Maximum Length: 240

  Additional details about the joint venture source transaction.
• originalDirectBilledStakeholder: string
  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.
• originalDistributedCredit: number
  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.
• originalDistributedDebit: number
  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.
• originalDistributedEnteredCredit: 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.
• originalDistributedEnteredDebit: 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.
• originalOwnershipDefinition: 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.
• originalOwnershipDefinitionEndDate: 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.
• originalOwnershipDefinitionStartDate: 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.
• 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.
• ownershipDefinition: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition used to process the distribution.
• ownershipDefinitionEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the effective date range of the ownership definition.
• ownershipDefinitionStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the effective date range of the ownership definition.
• partnerOffsetAccount: string
  Title: Partner Account

  Read Only: true

  The combination of account segment values assigned to a partner's line in the receivables invoice.
• party: string
  Title: Party Name

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the stakeholder on the joint venture distribution.
• percentageOfInterest: number
  Title: Ownership Percentage

  Read Only: true

  The percentage of ownership a stakeholder has in a joint venture transaction.
• periodBasis: string
  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.
• project: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project.
• projectCostingStatus: string
  Title: Project Costing Status

  Read Only: true

  Maximum Length: 80

  The status of the joint venture accounting entries exported to the Project Costing system.
• projectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The unique identifier of the project.
• 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

  An indicator that rounding was applied to the distribution amount.
• splitLinesExistFlag: boolean
  Title: Split Lines Exist

  Read Only: true

  Default Value: false

  Indicates that split lines exist for the joint venture distribution.
• stakeholder: string
  Title: Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the distribution stakeholder.
• status: string
  Title: Distribution Status

  Maximum Length: 80

  The status of the distribution of the joint venture transaction.
• supplier: string
  Title: Supplier

  Read Only: true

  Maximum Length: 360

  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.
• task: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  The name of the project task representing a subdivision of work.
• taskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  The unique number of the project task.
• transactionCredit: number
  Title: Transaction Credit

  Read Only: true

  The credit amount of the joint venture source transaction.
• transactionCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency of the transaction amount.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  Indicates the default effective date for journal entries or the transaction date for subledger entries.
• transactionDebit: number
  Title: Transaction Debit

  Read Only: true

  The debit amount of the joint venture source transaction.
• transactionDescription: string
  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.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  The unique identifier for the joint venture transaction that the distribution was created from.
• transactionType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The type of the joint venture source transaction.
• 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.

{
    "type":"object",
    "properties":{
        "distributionType":{
            "title":"Distribution Type",
            "maxLength":80,
            "type":"string",
            "description":"Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnit":{
            "title":"Business Unit",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "maxLength":240,
            "type":"string",
            "description":"Additional details about the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "partnerOffsetAccount":{
            "title":"Partner Account",
            "type":"string",
            "description":"The combination of account segment values assigned to a partner's line in the receivables invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "partnerOffsetCodeCombinationId",
                    "partnerOffsetStructureInstanceNumber"
                ]
            }
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "projectCostingStatus":{
            "title":"Project Costing Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the joint venture accounting entries exported to the Project Costing system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "project":{
            "title":"Project Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDescription":{
            "title":"Transaction Description",
            "maxLength":240,
            "type":"string",
            "description":"A description that's passed into the joint venture invoice for the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "targetTransactionHeaderAccount":{
            "title":"Target Transaction Account",
            "type":"string",
            "description":"The combination of segment values for the receivable or liability account used when posting a receivables or payables invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "targetTransactionHeaderCcid",
                    "targetTransactionHeaderSin"
                ]
            }
        },
        "stakeholder":{
            "title":"Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the distribution stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedEnteredDebit":{
            "title":"Original Distributed Entered Debit",
            "type":"number",
            "description":"The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":30,
            "type":"string",
            "description":"The name of the joint venture of the source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "reassignedStakeholder":{
            "title":"Reassigned Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder that's reassigned to the joint venture distribution.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "stakeholder"
                ]
            },
            "x-queryable":true
        },
        "lineType":{
            "title":"Distribution Line Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the distribution line for billing adjustments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "supplier":{
            "title":"Supplier",
            "maxLength":360,
            "type":"string",
            "description":"The name of the supplier associated with invoicing partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "costCenterSegmentValue":{
            "title":"Cost Center",
            "maxLength":25,
            "type":"string",
            "description":"The cost center segment value associated with the distributed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "accountingPeriod":{
            "title":"Accounting Period",
            "maxLength":15,
            "type":"string",
            "description":"The name of the fiscal period that the source transaction is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "trxDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the invoice transaction generated for the joint venture distribution.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedEnteredCredit":{
            "title":"Original Distributed Entered Credit",
            "type":"number",
            "description":"The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expenditureType":{
            "title":"Expenditure Type",
            "maxLength":240,
            "type":"string",
            "description":"The name identifying the expenditure classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "basisSource":{
            "title":"Basis Source",
            "maxLength":80,
            "type":"string",
            "description":"The source of the overhead calculation amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCurrency":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the transaction amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Carried Interest Agreement",
            "maxLength":30,
            "type":"string",
            "description":"The name of the agreement of the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":240,
            "type":"string",
            "description":"Additional text to describe the reason the joint venture distribution line was canceled",
            "nullable":true,
            "x-queryable":true
        },
        "method":{
            "title":"Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionRequest":{
            "title":"Partner Contribution Request",
            "maxLength":30,
            "type":"string",
            "description":"The name of the partner contribution request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalOwnershipDefinitionStartDate":{
            "title":"Ownership Start Date",
            "type":"string",
            "description":"Effective start date of the ownership definition that was used to distribute the joint venture transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the agreement of the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier for the joint venture transaction that the distribution was created from.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ownershipDefinition":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition used to process the distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "invoiceTransactionType":{
            "title":"Invoice Type",
            "type":"string",
            "description":"Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "contributionAmount":{
            "title":"Contribution Amount",
            "type":"number",
            "description":"The partner contribution amount that's associated with a distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "task":{
            "title":"Task Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the project task representing a subdivision of work.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "invoicingPartner":{
            "title":"Invoicing Partner",
            "maxLength":30,
            "type":"string",
            "description":"The name of the invoicing partner associated with the distribution stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedCredit":{
            "title":"Original Distributed Credit",
            "type":"number",
            "description":"The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lineNumber":{
            "title":"Distribution Line Number",
            "type":"integer",
            "description":"The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "originalOwnershipDefinition":{
            "title":"Original Ownership Definition",
            "maxLength":20,
            "type":"string",
            "description":"The original ownership definition assigned to the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "party":{
            "title":"Party Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party associated with the stakeholder on the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalStakeholder":{
            "title":"Original Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder that was originally associated with the joint venture distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "targetTransactionId":{
            "title":"Target Transaction ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "distributedDebit":{
            "title":"Distributed Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "status":{
            "title":"Distribution Status",
            "maxLength":80,
            "type":"string",
            "description":"The status of the distribution of the joint venture transaction.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.",
            "nullable":true,
            "x-queryable":true
        },
        "ledgerCategoryCode":{
            "title":"Ledger Category Code",
            "maxLength":30,
            "type":"string",
            "description":"The code that identifies the ledger type, such as primary, secondary, and so on.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalOwnershipDefinitionEndDate":{
            "title":"Ownership End Date",
            "type":"string",
            "description":"Effective end date of the ownership definition that was used to distribute the joint venture transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expenditureTypeDescription":{
            "title":"Expenditure Type Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the expenditure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureClassification":{
            "title":"Joint Venture Classification",
            "maxLength":80,
            "type":"string",
            "description":"The classification of the joint venture associated with the distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionId":{
            "title":"Distribution ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "trxNumber":{
            "title":"Invoice Number",
            "maxLength":20,
            "type":"string",
            "description":"A unique value that identifies the invoice generated for the joint venture distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "methodType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"The method type used to determine how the overhead amount is calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedDebit":{
            "title":"Original Distributed Debit",
            "type":"number",
            "description":"The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDirectBilledStakeholder":{
            "title":"Original Direct Billed Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the original direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "roundAmountFlag":{
            "title":"Rounding Applied",
            "maxLength":1,
            "type":"boolean",
            "description":"An indicator that rounding was applied to the distribution amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedCredit":{
            "title":"Distributed Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "periodBasis":{
            "title":"Period Basis",
            "maxLength":80,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCredit":{
            "title":"Transaction Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ledger":{
            "title":"Ledger",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "methodDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":80,
            "type":"string",
            "description":"The reason the joint venture distribution was canceled.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChangeReason"
                ]
            },
            "x-queryable":true
        },
        "splitLinesExistFlag":{
            "title":"Split Lines Exist",
            "type":"boolean",
            "description":"Indicates that split lines exist for the joint venture distribution.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "projectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureGeneratedDistributions-distributionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Indicates the default effective date for journal entries or the transaction date for subledger entries.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "directBilledStakeholder":{
            "title":"Direct Billed Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the joint venture source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "percentageOfInterest":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of ownership a stakeholder has in a joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "taskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"The unique number of the project task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDebit":{
            "title":"Transaction Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "customer":{
            "title":"Customer",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer associated with the invoicing partner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : distributionDFF

Type: array

Show Source

• Array of: object jointVentureGeneratedDistributions-distributionDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureGeneratedDistributions-distributionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureGeneratedDistributions-distributionDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DistributionId":{
            "title":"Distribution ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

distributionDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureGeneratedDistributions/{distributionId}/child/distributionDFF

Parameters:

• distributionId: $request.path.distributionId

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