Get a joint venture subledger distribution

get

/fscmRestApi/resources/11.13.18.05/jointVentureBasicSLADistributions/{distributionId}

Request

Path Parameters
  • The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : jointVentureBasicSLADistributions-item-response
Type: object
Show Source
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the agreement of the carried interest distribution.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the agreement of the carried interest distribution.
  • Title: Assignment Rule
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the business unit associated with the joint venture.
  • Title: Change Reason
    Maximum Length: 80
    The reason the joint venture distribution was canceled.
  • Title: Change Reason Details
    Maximum Length: 240
    Additional text to describe the reason the joint venture distribution line was canceled
  • Title: Partner Contribution ID
    Read Only: true
    The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture distribution.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture distribution was created.
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency code of accounting currency of the source joint venture transaction.
  • Title: Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    Unique identifier of the stakeholder that's to be directly billed for the transaction.
  • Title: Account
    Read Only: true
    Maximum Length: 255
    The combination of the values of the account segments assigned to the transaction.
  • Title: Distributed Accounted Credit
    Read Only: true
    The distributed credit amount for the stakeholder in accounting currency.
  • Title: Distributed Accounted Debit
    Read Only: true
    The distributed debit amount for the stakeholder in accounting currency.
  • Title: Distributed Entered Credit
    Read Only: true
    The distributed credit amount for the stakeholder in the entered currency.
  • Title: Distributed Entered Debit
    Read Only: true
    The distributed debit amount for the stakeholder in the entered currency.
  • distributionDFF
  • Title: Distribution ID
    Read Only: true
    The unique identifier of the joint venture distribution.
  • Title: Distribution Line Number
    Read Only: true
    The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.
  • Title: Distribution Line Type
    Read Only: true
    Maximum Length: 80
    The type of the distribution line for billing adjustments.
  • Title: Distribution Only
    Maximum Length: 1
    Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
  • Title: Distribution 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.
  • Title: Account Type
    Read Only: true
    Maximum Length: 80
    Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    The currency code entered on the original transaction.
  • Title: Expenditure Type
    Read Only: true
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Expenditure Type Description
    Read Only: true
    Maximum Length: 2000
    The description of the expenditure type.
  • Title: Invoice Type
    Read Only: true
    Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The name of the joint venture of the source transaction.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture of the source transaction.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the joint venture distribution was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the joint venture distribution.
  • Title: Ledger
    Read Only: true
    Maximum Length: 30
    The name of the ledger.
  • Links
  • 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.
  • 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.
  • Title: Original Distributed Entered Credit
    Read Only: true
    The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
  • Title: Original Distributed Entered Debit
    Read Only: true
    The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
  • Title: Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the stakeholder that was originally associated with the joint venture distribution.
  • Title: Ownership Definition
    Read Only: true
    Maximum Length: 30
    The original ownership definition assigned to the joint venture transaction that the distribution was created from.
  • Title: Ownership End Date
    Read Only: true
    Effective end date of the ownership definition that was used to distribute the joint venture transaction.
  • Title: Ownership Start Date
    Read Only: true
    Effective start date of the ownership definition that was used to distribute the joint venture transaction.
  • Title: Ownership Percentage
    Read Only: true
    The percentage of ownership a stakeholder has in a joint venture transaction.
  • Title: Period Name
    Read Only: true
    Maximum Length: 15
    The accounting period name in a calendar.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Costing Status
    The status of the joint venture accounting entries exported to the Project Costing system.
  • Title: Project Number
    Read Only: true
    Maximum Length: 25
    The unique identifier of the project.
  • Title: Reassigned Stakeholder
    Maximum Length: 30
    The name of the stakeholder that's reassigned to the joint venture distribution.
  • Title: Rounding Applied
    Read Only: true
    Maximum Length: 1
    An indicator that rounding was applied to the distribution amount.
  • Title: 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.
  • Title: Stakeholder
    Read Only: true
    Maximum Length: 30
    The name of the distribution stakeholder.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    The name of the project task representing a subdivision of work.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    The unique number of the project task.
  • Title: Transaction Accounted Credit
    Read Only: true
    The transaction credit amount in accounting currency.
  • Title: Transaction Date
    Read Only: true
    Indicates the default effective date for journal entries or the transaction date for subledger entries.
  • Title: Transaction Accounted Debit
    Read Only: true
    The transaction debit amount in accounting currency.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 1996
    The description of the subledger accounting journal line.
  • Title: Transaction Entered Credit
    Read Only: true
    The transaction credit amount in the entered currency.
  • Title: Transaction Entered Debit
    Read Only: true
    The transaction debit amount in the entered currency.
  • Title: Transaction ID
    Read Only: true
    The unique identifier for the joint venture transaction that the distribution was created from.
  • Title: Invoice Date
    Read Only: true
    The date of the invoice transaction generated for the joint venture distribution.
  • Title: Invoice Number
    Read Only: true
    Maximum Length: 20
    A unique value that identifies the invoice generated for the joint venture distribution.
Nested Schema : distributionDFF
Type: array
Show Source
Nested Schema : jointVentureBasicSLADistributions-distributionDFF-item-response
Type: object
Show Source
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