Jump to

• Request
• Response
• Examples

Get a joint venture subledger distribution

get

/fscmRestApi/resources/11.13.18.05/jointVentureBasicSLADistributions/{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=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

There's no request body for this operation.

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 : jointVentureBasicSLADistributions-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.
• 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.
• 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: 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 original ownership definition assigned to the joint venture transaction that the distribution was created from.
• 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.
• project: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

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

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

  The description of the subledger accounting journal 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
        },
        "projectCostingStatus":{
            "title":"Project Costing Status",
            "type":"string",
            "description":"The status of the joint venture accounting entries exported to the Project Costing system.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeProjCost"
                ]
            },
            "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":"1996",
            "type":"string",
            "description":"The description of the subledger accounting journal 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
        },
        "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
        },
        "period":{
            "title":"Period Name",
            "maxLength":"15",
            "type":"string",
            "description":"The accounting period name in a calendar.",
            "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
        },
        "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 original ownership definition assigned to the joint venture transaction that the distribution was created from.",
            "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
        },
        "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
        },
        "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":"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
        },
        "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":"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 that 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-queryable":false,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChgRsn"
                ]
            }
        },
        "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
        },
        "projectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "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/jointVentureBasicSLADistributions-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
        },
        "taskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique number of the project task.",
            "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 jointVentureBasicSLADistributions-distributionDFF-item-response

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

Parameters:

• distributionId: $request.path.distributionId

Back to Top

Examples

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

curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicSLADistributions/100101078815222"

Example Response Body

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

{
  "distributionId": 100101078815222,
  "distributionStatus": "Available to process",
  "distributionType": "Expense",
  "distributionLineType": "Original",
  "distributionLineNumber": 1,
  "jointVenture": "APOLLOBASIN",
  "jointVentureDescription": "Apollo Basin production",
  "businessUnit": "HEPP Petroleum USA BU1",
  "ownershipDefinition": "OPDAPOLLO170822:23:25",
  "ownershipDefinitionStartDate": "2017-01-01",
  "ownershipDefinitionEndDate": "2017-12-31",
  "stakeholder": "BARNCASPER_INTERNAL_S3",
  "percentageOfInterest": 40,
  "roundAmountFlag": false,
  "transactionId": 100101078815216,
  "transactionDate": "2017-01-31",
  "directBilledStakeholder": null,
  "trxNumber": null,
  "trxDate": null,
  "invoiceTransactionType": null,
  "distributedDebitAmount": 1000,
  "distributedCreditAmount": null,
  "originalDistributedDebitAmount": 1000,
  "originalDistributedCreditAmount": null,
  "currencyCode": "USD",
  "distributedEnteredDebitAmount": 1000,
  "distributedEnteredCreditAmount": null,
  "originalDistributedEnteredDebitAmount": 1000,
  "originalDistributedEnteredCreditAmount": null,
  "enteredCurrencyCode": "USD",
  "transactionDebitAmount": 2500,
  "transactionCreditAmount": null,
  "transactionEnteredDebitAmount": 2500,
  "transactionEnteredCreditAmount": null,
  "transactionDescription": "BA002GLAR1708222318J",
  "period": "Jan-17",
  "ledger": "HEPPLedger US",
  "distributedAccount": "11-2004-56120-11-0001",
  "distributionOnlyFlag": false,
  "changeReason": null,
  "changeReasonDetails": null,
  "contributionId": null,
  "assignmentRule": null,
  "createdBy": "username",
  "creationDate": "2022-08-18T06:47:44+00:00",
  "lastUpdatedBy": "username",
  "lastUpdateDate": "2022-08-18T06:47:44+00:00",
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGLDistributions/100101078815222",
      "name": "jointVentureBasicSLADistributions",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
      }
    },
    {
      "rel": "canonical",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGLDistributions/100101078815222",
      "name": "jointVentureBasicSLADistributions",
      "kind": "item"
    },
    {
      "rel": "child",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicSLADistributions/100101078815222/child/distributionDFF",
      "name": "distributionDFF",
      "kind": "collection"
    }
  ]
}

Back to Top