Jump to

• Request
• Response
• Examples

Update a joint venture general ledger distribution

patch

/fscmRestApi/resources/11.13.18.05/jointVentureBasicGLDistributions/{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.
• distributionStatus: string
  Title: Distribution Status

  Maximum Length: 80

  The status of the distribution of the joint venture transaction. It's based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth.
• reassignedStakeholder: string
  Title: Reassigned Stakeholder

  Maximum Length: 30

  The name of the stakeholder that's reassigned to the joint venture distribution.

{
    "type":"object",
    "properties":{
        "distributionStatus":{
            "title":"Distribution Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the distribution of the joint venture transaction. It's based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        },
        "distributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureBasicGLDistributions-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
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason the joint venture distribution was canceled.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChgRsn"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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/jointVentureBasicGLDistributions-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 : jointVentureBasicGLDistributions-item-response

Type: object

Show Source

• agreement: string
  Title: Carried Interest Agreement

  Read Only: true

  Maximum Length: 30

  The name of the agreement of the carried interest distribution.
• agreementDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the agreement of the carried interest distribution.
• assignmentRule: string
  Title: Assignment Rule

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.
• 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
• 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.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture distribution.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the joint venture distribution was created.
• currencyCode: string
  Title: Accounting Currency

  Read Only: true

  Maximum Length: 15

  The currency code of accounting currency of the source joint venture transaction.
• directBilledStakeholder: string
  Title: Direct Billed Stakeholder

  Read Only: true

  Maximum Length: 30

  Unique identifier of the stakeholder that's to be directly billed for the transaction.
• distributedAccount: string
  Title: Account

  Read Only: true

  Maximum Length: 255

  The combination of the values of the account segments assigned to the transaction.
• distributedCreditAmount: number
  Title: Distributed Accounted Credit

  Read Only: true

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

  Read Only: true

  The distributed debit amount for the stakeholder in accounting currency.
• distributedEnteredCreditAmount: number
  Title: Distributed Entered Credit

  Read Only: true

  The distributed credit amount for the stakeholder in the entered currency.
• distributedEnteredDebitAmount: number
  Title: Distributed Entered Debit

  Read Only: true

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

  Read Only: true

  The unique identifier of the joint venture distribution.
• distributionLineNumber: integer (int32)
  Title: Distribution Line Number

  Read Only: true

  The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.
• distributionLineType: string
  Title: Distribution Line Type

  Read Only: true

  Maximum Length: 80

  The type of the distribution line for billing adjustments.
• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
• distributionStatus: string
  Title: Distribution Status

  Maximum Length: 80

  The status of the distribution of the joint venture transaction. It's based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth.
• distributionType: string
  Title: Account Type

  Read Only: true

  Maximum Length: 80

  Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
• enteredCurrencyCode: string
  Title: Entered Currency

  Read Only: true

  Maximum Length: 15

  The currency code entered on the original transaction.
• invoiceTransactionType: string
  Title: Invoice Type

  Read Only: true

  Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.
• jointVenture: string
  Title: Joint Venture

  Read Only: true

  Maximum Length: 30

  The name of the joint venture of the source transaction.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture of the source transaction.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the joint venture distribution was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture distribution.
• ledger: string
  Title: Ledger

  Read Only: true

  Maximum Length: 30

  The name of the ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• originalDistributedCreditAmount: number
  Title: Original Distributed Accounted Credit

  Read Only: true

  The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
• originalDistributedDebitAmount: number
  Title: Original Distributed Accounted Debit

  Read Only: true

  The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
• originalDistributedEnteredCreditAmount: number
  Title: Original Distributed Entered Credit

  Read Only: true

  The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
• originalDistributedEnteredDebitAmount: number
  Title: Original Distributed Entered Debit

  Read Only: true

  The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
• 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: Ownership End Date

  Read Only: true

  Effective end date of the ownership definition that was used to distribute the joint venture transaction.
• ownershipDefinitionStartDate: string (date)
  Title: Ownership Start Date

  Read Only: true

  Effective start date of the ownership definition that was used to distribute the joint venture transaction.
• percentageOfInterest: number
  Title: Ownership Percentage

  Read Only: true

  The percentage of ownership a stakeholder has in a joint venture transaction.
• period: string
  Title: Period Name

  Read Only: true

  Maximum Length: 15

  The accounting period name in a calendar.
• reassignedStakeholder: string
  Title: Reassigned Stakeholder

  Maximum Length: 30

  The name of the stakeholder that's reassigned to the joint venture distribution.
• roundAmountFlag: boolean
  Title: Rounding Applied

  Read Only: true

  Maximum Length: 1

  An indicator to identify if rounding was applied to the distribution amount.
• sourceOwnershipDefinition: string
  Title: Source Ownership Definition

  Read Only: true

  Maximum Length: 30

  The original ownership definition assigned to the joint venture transaction that the distribution was created from.
• stakeholder: string
  Title: Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the distribution stakeholder.
• transactionCreditAmount: number
  Title: Transaction Accounted Credit

  Read Only: true

  The transaction credit amount in accounting currency.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

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

  Read Only: true

  The transaction debit amount in accounting currency.
• transactionDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 240

  The description of the general ledger journal entry line.
• transactionEnteredCreditAmount: number
  Title: Transaction Entered Credit

  Read Only: true

  The transaction credit amount in the entered currency.
• transactionEnteredDebitAmount: number
  Title: Transaction Entered Debit

  Read Only: true

  The transaction debit amount in the entered currency.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  The unique identifier for the joint venture transaction that the distribution was created from.
• trxDate: string (date)
  Title: Invoice Date

  Read Only: true

  The date of the invoice transaction generated for the joint venture distribution.
• trxNumber: string
  Title: Invoice Number

  Read Only: true

  Maximum Length: 20

  A unique value that identifies the invoice generated for the joint venture distribution.

{
    "type":"object",
    "properties":{
        "assignmentRule":{
            "title":"Assignment Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionType":{
            "title":"Account 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
        },
        "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
        },
        "transactionDescription":{
            "title":"Transaction Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the general ledger journal entry line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholder":{
            "title":"Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the distribution stakeholder.",
            "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
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture of the source transaction.",
            "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"
            }
        },
        "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
        },
        "originalDistributedDebitAmount":{
            "title":"Original Distributed Accounted 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
        },
        "distributedEnteredCreditAmount":{
            "title":"Distributed Entered Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in the entered currency.",
            "nullable":true,
            "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
        },
        "period":{
            "title":"Period Name",
            "maxLength":"15",
            "type":"string",
            "description":"The accounting period name in a calendar.",
            "nullable":false,
            "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
        },
        "originalDistributedEnteredDebitAmount":{
            "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
        },
        "distributedEnteredDebitAmount":{
            "title":"Distributed Entered Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in the entered currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionStatus":{
            "title":"Distribution Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the distribution of the joint venture transaction. It's based on the ORA_JV_DISTRIBUTION_STATUS lookup codes such as Available to Process, Process Complete, and so forth.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "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
        },
        "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":"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
        },
        "distributedDebitAmount":{
            "title":"Distributed Accounted Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in accounting currency.",
            "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
        },
        "enteredCurrencyCode":{
            "title":"Entered Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code entered on the original transaction.",
            "nullable":true,
            "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
        },
        "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
        },
        "transactionCreditAmount":{
            "title":"Transaction Accounted Credit",
            "type":"number",
            "description":"The transaction credit amount in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionEndDate":{
            "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
        },
        "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
        },
        "originalDistributedCreditAmount":{
            "title":"Original Distributed Accounted 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
        },
        "roundAmountFlag":{
            "title":"Rounding Applied",
            "maxLength":"1",
            "type":"boolean",
            "description":"An indicator to identify if rounding was applied to the distribution amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceOwnershipDefinition":{
            "title":"Source Ownership Definition",
            "maxLength":"30",
            "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
        },
        "originalDistributedEnteredCreditAmount":{
            "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
        },
        "distributionLineNumber":{
            "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
        },
        "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
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason the joint venture distribution was canceled.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChgRsn"
                ]
            },
            "x-queryable":true
        },
        "distributionLineType":{
            "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
        },
        "transactionEnteredCreditAmount":{
            "title":"Transaction Entered Credit",
            "type":"number",
            "description":"The transaction credit amount in the entered currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedAccount":{
            "title":"Account",
            "maxLength":"255",
            "type":"string",
            "description":"The combination of the values of the account segments assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "chartOfAccountsId"
                ]
            },
            "x-queryable":true
        },
        "transactionDebitAmount":{
            "title":"Transaction Accounted Debit",
            "type":"number",
            "description":"The transaction debit amount in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureBasicGLDistributions-distributionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "distributedCreditAmount":{
            "title":"Distributed Accounted Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "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":"Unique identifier of the stakeholder that's to be directly billed for the transaction.",
            "nullable":true,
            "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
        },
        "transactionEnteredDebitAmount":{
            "title":"Transaction Entered Debit",
            "type":"number",
            "description":"The transaction debit amount in the entered currency.",
            "nullable":true,
            "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
        },
        "currencyCode":{
            "title":"Accounting Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of accounting currency of the source joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : distributionDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureBasicGLDistributions-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 : jointVentureBasicGLDistributions-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/jointVentureBasicGLDistributions/{distributionId}/child/distributionDFF

Parameters:

• distributionId: $request.path.distributionId

Back to Top

Examples

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

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGLDistributions/100101078815244"

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
  "distributionStatus": "On hold",
  "distributionOnlyFlag": "true"
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
  "createdBy" : "username",
  "creationDate" : "2020-02-19T18:01:44+00:00",
  "currencyCode" : "USD",
  "distributedCreditAmount" : null,
  "distributedDebitAmount" : 1649.76,
  "distributionId" : 100101078815244,
  "lastUpdateDate" : "2020-02-20T21:22:16+00:00",
  "lastUpdatedBy" : "username",
  "percentageOfInterest" : 35,
  "roundAmountFlag" : false,
  "transactionDate" : "2006-08-05",
  "transactionId" : 100100134927101,
  "jointVentureName" : "APOLLOBASIN",
  "jointVentureDescription" : "Oklahoma panhandle project.\nLot32, Parcel 1TR5-A",
  "ownershipDefinitionName" : "BASINOD",
  "stakeholderName" : "APOLLOTRANS",
  "invoicingPartnerName" : null,
  "costCenterSegmentValue" : "112",
  "periodName" : "Aug-06",
  "distributionStatus" : "On hold",
  "distributionType" : "Expense",
  "supplierName" : null,
  "customerName" : null,
  "distributedAccountInformation" : "01-510-7420-0000-000",
  "distributionOnlyFlag" : true,
  "ledgerName" : "Vision Operations (USA)",
  "transactionCreditAmount" : null,
  "transactionDebitAmount" : 4713.6,
  "transactionDescription" : "Journal Import Created",
  "originalOwnershipDefinitionName" : "BASINOD",
  "ownershipEffectiveEndDate" : "2006-12-31",
  "ownershipEffectiveStartDate" : "2006-01-01",
  "originalDirectBilledStakeholderName" : null,
  "directBilledStakeholderName" : null,
  "businessUnitName" : "Vision Operations",
  "statisticalAmount" : null,
}

Back to Top