Get all joint venture distributions
get
/fscmRestApi/resources/11.13.18.05/jointVentureDistributions
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the joint venture distribution that matches the primary key criteria specified.
Finder Variables- distributionId; integer; The unique identifier of the joint venture distribution.
- distributionFinder Finds all joint venture distributions that match the specified search criteria.
Finder Variables- SysEffectiveDate; object;
- accountingPeriod; string; The name of the fiscal period that the joint venture transaction is associated with.
- distributionOnlyFlag; string; Indicates whether the joint venture stakeholder; string; is only participating in the transaction distribution and not being invoiced.
- expenditureType; string; The name identifying the expenditure classification.
- jointVenture; string; The unique name of the joint venture.
- lineType; string; The type of the distribution line for billing adjustments.
- ownershipDefinition; string; The name of the ownership definition used to process the distribution.
- project; string; The name of the project; string; .
- projectCostingStatus; string; The status; string; of the export to Project Costing.
- projectNumber; string; The unique identifier of the project; string; .
- searchAllText; string; A search value to identify joint venture distributions that contain the specified text in any of the attributes.
- stakeholder; string; The name of the distribution stakeholder; string; .
- status; string; The status; string; of the distribution of the joint venture transaction.
- task; string; The name of the project; string; task; string; representing a subdivision of work.
- taskNumber; string; The unique number of the project; string; task; string; .
- PrimaryKey Finds the joint venture distribution that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- accountSegment1; string; The segment 1 value of the account assigned to the joint venture transaction.
- accountSegment10; string; The segment 10 value of the account assigned to the joint venture transaction.
- accountSegment11; string; The segment 11 value of the account assigned to the joint venture transaction.
- accountSegment12; string; The segment 12 value of the account assigned to the joint venture transaction.
- accountSegment13; string; The segment 13 value of the account assigned to the joint venture transaction.
- accountSegment14; string; The segment 14 value of the account assigned to the joint venture transaction.
- accountSegment15; string; The segment 15 value of the account assigned to the joint venture transaction.
- accountSegment16; string; The segment 16 value of the account assigned to the joint venture transaction.
- accountSegment17; string; The segment 17 value of the account assigned to the joint venture transaction.
- accountSegment18; string; The segment 18 value of the account assigned to the joint venture transaction.
- accountSegment19; string; The segment 19 value of the account assigned to the joint venture transaction.
- accountSegment2; string; The segment 2 value of the account assigned to the joint venture transaction.
- accountSegment20; string; The segment 20 value of the account assigned to the joint venture transaction.
- accountSegment21; string; The segment 21 value of the account assigned to the joint venture transaction.
- accountSegment22; string; The segment 22 value of the account assigned to the joint venture transaction.
- accountSegment23; string; The segment 23 value of the account assigned to the joint venture transaction.
- accountSegment24; string; The segment 24 value of the account assigned to the joint venture transaction.
- accountSegment25; string; The segment 25 value of the account assigned to the joint venture transaction.
- accountSegment26; string; The segment 26 value of the account assigned to the joint venture transaction.
- accountSegment27; string; The segment 27 value of the account assigned to the joint venture transaction.
- accountSegment28; string; The segment 28 value of the account assigned to the joint venture transaction.
- accountSegment29; string; The segment 29 value of the account assigned to the joint venture transaction.
- accountSegment3; string; The segment 3 value of the account assigned to the joint venture transaction.
- accountSegment30; string; The segment 30 value of the account assigned to the joint venture transaction.
- accountSegment4; string; The segment 4 value of the account assigned to the joint venture transaction.
- accountSegment5; string; The segment 5 value of the account assigned to the joint venture transaction.
- accountSegment6; string; The segment 6 value of the account assigned to the joint venture transaction.
- accountSegment7; string; The segment 7 value of the account assigned to the joint venture transaction.
- accountSegment8; string; The segment 8 value of the account assigned to the joint venture transaction.
- accountSegment9; string; The segment 9 value of the account assigned to the joint venture transaction.
- accountedCredit; number; The transaction credit amount in accounting currency.
- accountedCurrencyCode; string; The currency of the transaction amount.
- accountedDebit; number; The transaction debit amount in accounting currency.
- accountingDate; string; The date used to determine the accounting period for the transaction.
- accountingPeriod; string; The name of the fiscal period that the joint venture transaction is associated with.
- agreement; string; The name of the carried interest agreement associated with the joint venture transaction.
- assignmentRule; string; The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.
- basisSource; string; The source of the overhead calculation amount.
- businessUnit; string; The name of the business unit associated with the joint venture.
- changeReason; string; The reason the joint venture distribution was canceled.
- changeReasonDetails; string; Additional text to describe the reason the joint venture distribution line was canceled
- contributionId; integer; The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
- costCenter; string; The cost center segment value associated with the distribution stakeholder.
- createdBy; string; The user who created the joint venture distribution.
- createdByJointVentureFlag; boolean; A flag indicating whether the source of the transaction is a joint venture invoice or journal created by joint venture processing. The source of the transaction can also be payments or receipts against an invoice created by joint venture processing.
- creationDate; string; The date and time when the joint venture distribution was created.
- directBilledStakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
- distributedAccountedCredit; number; The distributed credit amount for the stakeholder in accounting currency.
- distributedAccountedDebit; number; The distributed debit amount for the stakeholder in accounting currency.
- distributedEnteredCredit; number; The distributed credit amount for the stakeholder in the entered currency.
- distributedEnteredDebit; number; The distributed debit amount for the stakeholder in the entered currency.
- distributionId; integer; The unique identifier of the joint venture distribution.
- distributionLineNumber; integer; The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.
- distributionOnlyFlag; boolean; Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
- enteredCredit; number; The transaction credit amount in the entered currency.
- enteredCurrencyCode; string; The currency code entered on the original transaction.
- enteredDebit; number; The transaction debit amount in the entered currency.
- expenditureBusinessUnit; string; The name of the expenditure business unit in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
- expenditureItemDate; string; The date of the expenditure in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
- expenditureOrganization; string; The name of the expenditure organization in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
- expenditureType; string; The name identifying the expenditure classification.
- expenditureTypeDescription; string; The description of the expenditure type.
- invoiceDate; string; The date of the invoice transaction generated for the joint venture distribution.
- invoiceNumber; string; A unique value that identifies the invoice generated for the joint venture distribution.
- jointVenture; string; The unique name of the joint venture.
- jointVentureDescription; string; The description of the joint venture.
- journalNumber; integer; The unique identifier for the external transaction created for joint venture distributions, for example accounts receivable invoice, credit memo, accounts payable invoice, or journal entry.
- lastUpdateDate; string; The date and time when the joint venture distribution was last updated.
- lastUpdatedBy; string; The user who last updated the joint venture distribution.
- ledger; string; The name of the ledger.
- legalEntity; string; The name of the legal entity associated with the joint venture.
- lineType; string; The type of the distribution line for billing adjustments.
- method; string; The unique name of the overhead method.
- netAccounted; number; The net transaction amount in the accounting currency.
- netDistributedAccounted; number; The net distributed amount for the stakeholder in accounted currency.
- netDistributedEntered; number; The net distributed amount for the stakeholder in entered currency.
- netEntered; number; The net transaction amount in the entered currency.
- netOriginalDistributedAccounted; number; The original net amount of the joint venture distribution in the accounted currency. This is the amount prior to being split by partner contributions.
- netOriginalDistributedEntered; number; The original net amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
- notes; string; Additional details about the joint venture source transaction.
- originalDistributedAccountedCredit; number; The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split between partner contributions.
- originalDistributedAccountedDebit; number; The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split between partner contributions.
- originalDistributedEnteredCredit; number; The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split between partner contributions.
- originalDistributedEnteredDebit; number; The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split between partner contributions.
- originalOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction that the distribution was created from.
- originalStakeholder; string; The name of the stakeholder that was originally associated with the joint venture distribution.
- ownershipDefinition; string; The name of the ownership definition used to process the distribution.
- ownershipDefinitionEndDate; string; The end date of the effective date range of the ownership definition.
- ownershipDefinitionStartDate; string; The start date of the effective date range of the ownership definition.
- ownershipPercentage; number; The percentage of ownership a stakeholder has in a joint venture transaction.
- project; string; The name of the project.
- projectCostingStatus; string; The status of the export to Project Costing.
- projectNumber; string; The unique identifier of the project.
- roundAmountFlag; boolean; An indicator that rounding was applied to the distribution amount.
- source; string; The name of the application the transaction originated from, for example Payables or Cost Management.
- stakeholder; string; The name of the distribution stakeholder.
- stakeholderReportingHeaderId; integer; The unique identifier of the stakeholder reporting journal created for the distribution.
- stakeholderReportingLedger; string; The name of the ledger which will be used for stakeholder reporting.
- stakeholderReportingStatus; string; The status of the accounting for the stakeholder reporting distribution.
- status; string; The status of the distribution of the joint venture transaction.
- task; string; The name of the project task representing a subdivision of work.
- taskNumber; string; The unique number of the project task.
- transactionDate; string; The date when the joint venture source transaction occurred.
- transactionDescription; string; The description to include on the transactions created through invoice or internal transfer journal processing.
- transactionId; integer; The unique identifier of the joint venture transaction.
- transactionType; string; The type of transaction the distribution represents, such as expense, revenue, and so forth.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
Metadata-Context: string
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: string
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 TopResponse
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.
Root Schema : jointVentureDistributions
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureDistributions-item-response
Type:
Show Source
object
-
account: string
Title:
Account
Read Only:true
Maximum Length:255
The account assigned to the joint venture transaction. -
accountedCredit: number
Title:
Transaction Accounted Credit
Read Only:true
The transaction credit amount in accounting currency. -
accountedCurrencyCode: string
Title:
Accounting Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
accountedDebit: number
Title:
Transaction Accounted Debit
Read Only:true
The transaction debit amount in accounting currency. -
accountingDate: string
(date)
Title:
Accounting Date
Read Only:true
The date used to determine the accounting period for the transaction. -
accountingPeriod: string
Title:
Accounting Period
Read Only:true
Maximum Length:15
The name of the fiscal period that the joint venture transaction is associated with. -
accountSegment1: string
Title:
Account Segment 1
Read Only:true
Maximum Length:25
The segment 1 value of the account assigned to the joint venture transaction. -
accountSegment10: string
Title:
Account Segment 10
Read Only:true
Maximum Length:25
The segment 10 value of the account assigned to the joint venture transaction. -
accountSegment11: string
Title:
Account Segment 11
Read Only:true
Maximum Length:25
The segment 11 value of the account assigned to the joint venture transaction. -
accountSegment12: string
Title:
Account Segment 12
Read Only:true
Maximum Length:25
The segment 12 value of the account assigned to the joint venture transaction. -
accountSegment13: string
Title:
Account Segment 13
Read Only:true
Maximum Length:25
The segment 13 value of the account assigned to the joint venture transaction. -
accountSegment14: string
Title:
Account Segment 14
Read Only:true
Maximum Length:25
The segment 14 value of the account assigned to the joint venture transaction. -
accountSegment15: string
Title:
Account Segment 15
Read Only:true
Maximum Length:25
The segment 15 value of the account assigned to the joint venture transaction. -
accountSegment16: string
Title:
Account Segment 16
Read Only:true
Maximum Length:25
The segment 16 value of the account assigned to the joint venture transaction. -
accountSegment17: string
Title:
Account Segment 17
Read Only:true
Maximum Length:25
The segment 17 value of the account assigned to the joint venture transaction. -
accountSegment18: string
Title:
Account Segment 18
Read Only:true
Maximum Length:25
The segment 18 value of the account assigned to the joint venture transaction. -
accountSegment19: string
Title:
Account Segment 19
Read Only:true
Maximum Length:25
The segment 19 value of the account assigned to the joint venture transaction. -
accountSegment2: string
Title:
Account Segment 2
Read Only:true
Maximum Length:25
The segment 2 value of the account assigned to the joint venture transaction. -
accountSegment20: string
Title:
Account Segment 20
Read Only:true
Maximum Length:25
The segment 20 value of the account assigned to the joint venture transaction. -
accountSegment21: string
Title:
Account Segment 21
Read Only:true
Maximum Length:25
The segment 21 value of the account assigned to the joint venture transaction. -
accountSegment22: string
Title:
Account Segment 22
Read Only:true
Maximum Length:25
The segment 22 value of the account assigned to the joint venture transaction. -
accountSegment23: string
Title:
Account Segment 23
Read Only:true
Maximum Length:25
The segment 23 value of the account assigned to the joint venture transaction. -
accountSegment24: string
Title:
Account Segment 24
Read Only:true
Maximum Length:25
The segment 24 value of the account assigned to the joint venture transaction. -
accountSegment25: string
Title:
Account Segment 25
Read Only:true
Maximum Length:25
The segment 25 value of the account assigned to the joint venture transaction. -
accountSegment26: string
Title:
Account Segment 26
Read Only:true
Maximum Length:25
The segment 26 value of the account assigned to the joint venture transaction. -
accountSegment27: string
Title:
Account Segment 27
Read Only:true
Maximum Length:25
The segment 27 value of the account assigned to the joint venture transaction. -
accountSegment28: string
Title:
Account Segment 28
Read Only:true
Maximum Length:25
The segment 28 value of the account assigned to the joint venture transaction. -
accountSegment29: string
Title:
Account Segment 29
Read Only:true
Maximum Length:25
The segment 29 value of the account assigned to the joint venture transaction. -
accountSegment3: string
Title:
Account Segment 3
Read Only:true
Maximum Length:25
The segment 3 value of the account assigned to the joint venture transaction. -
accountSegment30: string
Title:
Account Segment 30
Read Only:true
Maximum Length:25
The segment 30 value of the account assigned to the joint venture transaction. -
accountSegment4: string
Title:
Account Segment 4
Read Only:true
Maximum Length:25
The segment 4 value of the account assigned to the joint venture transaction. -
accountSegment5: string
Title:
Account Segment 5
Read Only:true
Maximum Length:25
The segment 5 value of the account assigned to the joint venture transaction. -
accountSegment6: string
Title:
Account Segment 6
Read Only:true
Maximum Length:25
The segment 6 value of the account assigned to the joint venture transaction. -
accountSegment7: string
Title:
Account Segment 7
Read Only:true
Maximum Length:25
The segment 7 value of the account assigned to the joint venture transaction. -
accountSegment8: string
Title:
Account Segment 8
Read Only:true
Maximum Length:25
The segment 8 value of the account assigned to the joint venture transaction. -
accountSegment9: string
Title:
Account Segment 9
Read Only:true
Maximum Length:25
The segment 9 value of the account assigned to the joint venture transaction. -
agreement: string
Title:
Carried Interest Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement associated with the joint venture transaction. -
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. -
basisSource: string
Title:
Basis Source
Read Only:true
Maximum Length:80
The source of the overhead calculation amount. -
businessUnit: string
Title:
Business Unit
Read Only:true
Maximum Length:240
The name of the business unit associated with the joint venture. -
changeReason: string
Title:
Reason
Maximum Length:80
The reason the joint venture distribution was canceled. -
changeReasonDetails: string
Title:
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. -
costCenter: string
Title:
Cost Center
Read Only:true
Maximum Length:25
The cost center segment value associated with the distribution stakeholder. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture distribution. -
createdByJointVentureFlag: boolean
Title:
Created by Joint Venture
Read Only:true
Maximum Length:1
A flag indicating whether the source of the transaction is a joint venture invoice or journal created by joint venture processing. The source of the transaction can also be payments or receipts against an invoice created by joint venture processing. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture distribution was created. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from. -
distributedAccountedCredit: number
Title:
Distributed Accounted Credit
Read Only:true
The distributed credit amount for the stakeholder in accounting currency. -
distributedAccountedDebit: number
Title:
Distributed Accounted Debit
Read Only:true
The distributed debit amount for the stakeholder in accounting currency. -
distributedEnteredCredit: number
Title:
Distributed Entered Credit
Read Only:true
The distributed credit amount for the stakeholder in the entered currency. -
distributedEnteredDebit: number
Title:
Distributed Entered Debit
Read Only:true
The distributed debit amount for the stakeholder in the entered currency. -
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. -
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. -
enteredCredit: number
Title:
Transaction Entered Credit
Read Only:true
The transaction credit amount in the entered currency. -
enteredCurrencyCode: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
The currency code entered on the original transaction. -
enteredDebit: number
Title:
Transaction Entered Debit
Read Only:true
The transaction debit amount in the entered currency. -
expenditureBusinessUnit: string
Title:
Expenditure Business Unit
Read Only:true
Maximum Length:240
The name of the expenditure business unit in Project Costing that's associated with the subledger accounting entry for the joint venture transaction. -
expenditureItemDate: string
(date)
Title:
Expenditure Item Date
Read Only:true
The date of the expenditure in Project Costing that's associated with the subledger accounting entry for the joint venture transaction. -
expenditureOrganization: string
Title:
Expenditure Organization
Read Only:true
Maximum Length:240
The name of the expenditure organization in Project Costing that's associated with the subledger accounting entry for the joint venture 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. -
invoiceDate: string
(date)
Title:
Invoice Date
Read Only:true
The date of the invoice transaction generated for the joint venture distribution. -
invoiceNumber: string
Title:
Invoice Number
Read Only:true
Maximum Length:150
A unique value that identifies the invoice generated for the joint venture distribution. -
invoiceType: string
Title:
Invoice Type
Read Only:true
Maximum Length:80
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 unique name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
journalNumber: integer
Read Only:
true
The unique identifier for the external transaction created for joint venture distributions, for example accounts receivable invoice, credit memo, accounts payable invoice, or journal entry. -
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. -
legalEntity: string
Title:
Legal Entity
Read Only:true
Maximum Length:240
The name of the legal entity associated with the joint venture. -
lineType: string
Title:
Distribution Line Type
Read Only:true
Maximum Length:80
The type of the distribution line for billing adjustments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
method: string
Title:
Method
Read Only:true
Maximum Length:30
The unique name of the overhead method. -
netAccounted: number
Title:
Net Transaction Accounted Amount
Read Only:true
The net transaction amount in the accounting currency. -
netDistributedAccounted: number
Title:
Net Distributed Accounted Amount
Read Only:true
The net distributed amount for the stakeholder in accounted currency. -
netDistributedEntered: number
Title:
Net Distributed Entered Amount
Read Only:true
The net distributed amount for the stakeholder in entered currency. -
netEntered: number
Title:
Net Transaction Entered Amount
Read Only:true
The net transaction amount in the entered currency. -
netOriginalDistributedAccounted: number
Title:
Net Original Distributed Accounted Amount
Read Only:true
The original net amount of the joint venture distribution in the accounted currency. This is the amount prior to being split by partner contributions. -
netOriginalDistributedEntered: number
Title:
Net Original Distributed Entered Amount
Read Only:true
The original net amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions. -
notes: string
Title:
Notes
Read Only:true
Maximum Length:240
Additional details about the joint venture source transaction. -
originalDistributedAccountedCredit: 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 between partner contributions. -
originalDistributedAccountedDebit: 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 between partner contributions. -
originalDistributedEnteredCredit: number
Title:
Original Distributed Entered Credit
Read Only:true
The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split between partner contributions. -
originalDistributedEnteredDebit: number
Title:
Original Distributed Entered Debit
Read Only:true
The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split between partner contributions. -
originalOwnershipDefinition: string
Title:
Original Ownership Definition
Read Only:true
Maximum Length:30
The original ownership definition assigned to the joint venture transaction that the distribution was created from. -
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
The end date of the effective date range of the ownership definition. -
ownershipDefinitionStartDate: string
(date)
Title:
Ownership Start Date
Read Only:true
The start date of the effective date range of the ownership definition. -
ownershipPercentage: number
Title:
Ownership Percentage
Read Only:true
The percentage of ownership a stakeholder has in a joint venture transaction. -
project: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project. -
projectCostingStatus: string
Title:
Project Costing Status
Maximum Length:80
The status of the export to Project Costing. -
projectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The unique identifier of the project. -
roundAmountFlag: boolean
Title:
Rounding Applied
Read Only:true
Maximum Length:1
An indicator that rounding was applied to the distribution amount. -
source: string
Title:
Source
Read Only:true
Maximum Length:512
The name of the application the transaction originated from, for example Payables or Cost Management. -
stakeholder: string
Title:
Stakeholder
Maximum Length:30
The name of the distribution stakeholder. -
stakeholderReportingDate: string
(date)
Title:
Stakeholder Reporting Date
Read Only:true
The date the stakeholder reporting journal was created. -
stakeholderReportingHeaderId: integer
(int64)
Title:
Stakeholder Reporting Header ID
Read Only:true
The unique identifier of the stakeholder reporting journal created for the distribution. -
stakeholderReportingLedger: string
Title:
Stakeholder Reporting Ledger
Read Only:true
Maximum Length:30
The name of the ledger which will be used for stakeholder reporting. -
stakeholderReportingStatus: string
Title:
Stakeholder Reporting Status
Maximum Length:80
The status of the accounting for the stakeholder reporting distribution. -
status: string
Title:
Distribution Status
Maximum Length:80
The status of the distribution of the joint venture transaction. -
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. -
transactionDate: string
(date)
Title:
Transaction Date
Read Only:true
The date when the joint venture source transaction occurred. -
transactionDescription: string
Title:
Transaction Description
Read Only:true
Maximum Length:240
The description to include on the transactions created through invoice or internal transfer journal processing. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier of the joint venture transaction. -
transactionSource: string
Title:
Transaction Source
Read Only:true
Maximum Length:255
The source of the joint venture transaction, for example general ledger, subledger accounting, or joint venture. -
transactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
The type of transaction the distribution represents, such as expense, revenue, and so forth.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
The following example shows how to retrieve all joint venture distributions 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/jointVentureDistributions"
Example Response Body
The following shows an example of the response body in JSON format.{ "items": [ { "distributionId": 100106784546204, "status": "Available to process", "lineType": "Original", "distributionLineNumber": 1, "transactionType": "Manual cost", "source": "Joint Venture Management", "transactionSource": "Manual", "transactionId": 100106784546203, "transactionDate": "2017-01-31", "accountingDate": "2017-01-31", "accountingPeriod": "Jan-17", "ledger": "HEPPLedger US", "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "businessUnit": "HEPP Petroleum USA BU1", "legalEntity": "HEPP Inc", "originalOwnershipDefinition": null, "ownershipDefinition": null, "ownershipDefinitionStartDate": null, "ownershipDefinitionEndDate": null, "originalStakeholder": null, "stakeholder": "GOILMEX_ASH6", "costCenter": "1031", "directBilledStakeholder": "GOILMEX_ASH6", "ownershipPercentage": 100, "roundAmountFlag": false, "distributionOnlyFlag": false, "account": "11-1001-11010-11-0001", "accountSegment1": "11", "accountSegment2": "1001", "accountSegment3": "11010", "accountSegment4": "11", "accountSegment5": "0001", "accountSegment6": null, "accountSegment7": null, "accountSegment8": null, "accountSegment9": null, "accountSegment10": null, "accountSegment11": null, "accountSegment12": null, "accountSegment13": null, "accountSegment14": null, "accountSegment15": null, "accountSegment16": null, "accountSegment17": null, "accountSegment18": null, "accountSegment19": null, "accountSegment20": null, "accountSegment21": null, "accountSegment22": null, "accountSegment23": null, "accountSegment24": null, "accountSegment25": null, "accountSegment26": null, "accountSegment27": null, "accountSegment28": null, "accountSegment29": null, "accountSegment30": null, "netAccounted": 650, "accountedDebit": 650, "accountedCredit": null, "netEntered": 650, "enteredDebit": 650, "enteredCredit": null, "transactionDescription": null, "assignmentRule": null, "agreement": null, "method": null, "basisSource": null, "notes": null, "netOriginalDistributedAccounted": 650, "originalDistributedAccountedDebit": 650, "originalDistributedAccountedCredit": null, "netDistributedAccounted": 650, "distributedAccountedDebit": 650, "distributedAccountedCredit": null, "accountedCurrencyCode": "USD", "netOriginalDistributedEntered": 0, "originalDistributedEnteredDebit": null, "originalDistributedEnteredCredit": null, "netDistributedEntered": 0, "distributedEnteredDebit": null, "distributedEnteredCredit": null, "enteredCurrencyCode": null, "invoiceNumber": null, "invoiceDate": null, "invoiceType": null, "journalNumber": null, "contributionId": 100106784462507, "projectCostingStatus": "Not applicable", "project": null, "projectNumber": null, "task": null, "taskNumber": null, "expenditureType": null, "expenditureTypeDescription": null, "expenditureOrganization": null, "expenditureBusinessUnit": null, "expenditureItemDate": null, "createdByJointVentureFlag": false, "stakeholderReportingHeaderId": null, "stakeholderReportingLedger": null, "stakeholderReportingDate": null, "stakeholderReportingStatus": "Available to process", "changeReason": null, "changeReasonDetails": null, "createdBy": "username", "creationDate": "2025-05-29T02:11:06+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2025-05-29T02:11:37.144+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106784546204", "name": "jointVentureDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106784546204", "name": "jointVentureDistributions", "kind": "item" } ] }, { "distributionId": 100106784462532, "status": "Available to process", "lineType": "Original", "distributionLineNumber": 1, "transactionType": "Manual cost", "source": "Joint Venture Management", "transactionSource": "Manual", "transactionId": 100106784546165, "transactionDate": "2017-01-31", "accountingDate": "2017-01-31", "accountingPeriod": "Jan-17", "ledger": "HEPPLedger US", "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "businessUnit": "HEPP Petroleum USA BU1", "legalEntity": "HEPP Inc", "originalOwnershipDefinition": null, "ownershipDefinition": null, "ownershipDefinitionStartDate": null, "ownershipDefinitionEndDate": null, "originalStakeholder": null, "stakeholder": "BARNCASPER", "costCenter": "1520", "directBilledStakeholder": "BARNCASPER", "ownershipPercentage": 100, "roundAmountFlag": false, "distributionOnlyFlag": false, "account": "11-1001-11010-11-0001", "accountSegment1": "11", "accountSegment2": "1001", "accountSegment3": "11010", "accountSegment4": "11", "accountSegment5": "0001", "accountSegment6": null, "accountSegment7": null, "accountSegment8": null, "accountSegment9": null, "accountSegment10": null, "accountSegment11": null, "accountSegment12": null, "accountSegment13": null, "accountSegment14": null, "accountSegment15": null, "accountSegment16": null, "accountSegment17": null, "accountSegment18": null, "accountSegment19": null, "accountSegment20": null, "accountSegment21": null, "accountSegment22": null, "accountSegment23": null, "accountSegment24": null, "accountSegment25": null, "accountSegment26": null, "accountSegment27": null, "accountSegment28": null, "accountSegment29": null, "accountSegment30": null, "netAccounted": 200, "accountedDebit": 200, "accountedCredit": null, "netEntered": 200, "enteredDebit": 200, "enteredCredit": null, "transactionDescription": null, "assignmentRule": null, "agreement": null, "method": null, "basisSource": null, "notes": null, "netOriginalDistributedAccounted": 200, "originalDistributedAccountedDebit": 200, "originalDistributedAccountedCredit": null, "netDistributedAccounted": 200, "distributedAccountedDebit": 200, "distributedAccountedCredit": null, "accountedCurrencyCode": "USD", "netOriginalDistributedEntered": 0, "originalDistributedEnteredDebit": null, "originalDistributedEnteredCredit": null, "netDistributedEntered": 0, "distributedEnteredDebit": null, "distributedEnteredCredit": null, "enteredCurrencyCode": null, "invoiceNumber": null, "invoiceDate": null, "invoiceType": null, "journalNumber": null, "contributionId": 100106784462509, "projectCostingStatus": "Not applicable", "project": null, "projectNumber": null, "task": null, "taskNumber": null, "expenditureType": null, "expenditureTypeDescription": null, "expenditureOrganization": null, "expenditureBusinessUnit": null, "expenditureItemDate": null, "createdByJointVentureFlag": false, "stakeholderReportingHeaderId": null, "stakeholderReportingLedger": null, "stakeholderReportingDate": null, "stakeholderReportingStatus": "Available to process", "changeReason": null, "changeReasonDetails": null, "createdBy": "username", "creationDate": "2025-05-29T01:37:47+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2025-05-29T01:38:47.247+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106784462532", "name": "jointVentureDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106784462532", "name": "jointVentureDistributions", "kind": "item" } ] }, { "distributionId": 100106783888854, "status": "Available to process", "lineType": "Original", "distributionLineNumber": 1, "transactionType": "Manual cost", "source": "Joint Venture Management", "transactionSource": "Manual", "transactionId": 100106783888851, "transactionDate": "2017-01-31", "accountingDate": "2017-01-31", "accountingPeriod": "Jan-17", "ledger": "HEPPLedger US", "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "businessUnit": "HEPP Petroleum USA BU1", "legalEntity": "HEPP Inc", "originalOwnershipDefinition": null, "ownershipDefinition": null, "ownershipDefinitionStartDate": null, "ownershipDefinitionEndDate": null, "originalStakeholder": null, "stakeholder": "ACMEXPLORATION", "costCenter": null, "directBilledStakeholder": "ACMEXPLORATION", "ownershipPercentage": 100, "roundAmountFlag": false, "distributionOnlyFlag": false, "account": "11-1001-11010-11-0001", "accountSegment1": "11", "accountSegment2": "1001", "accountSegment3": "11010", "accountSegment4": "11", "accountSegment5": "0001", "accountSegment6": null, "accountSegment7": null, "accountSegment8": null, "accountSegment9": null, "accountSegment10": null, "accountSegment11": null, "accountSegment12": null, "accountSegment13": null, "accountSegment14": null, "accountSegment15": null, "accountSegment16": null, "accountSegment17": null, "accountSegment18": null, "accountSegment19": null, "accountSegment20": null, "accountSegment21": null, "accountSegment22": null, "accountSegment23": null, "accountSegment24": null, "accountSegment25": null, "accountSegment26": null, "accountSegment27": null, "accountSegment28": null, "accountSegment29": null, "accountSegment30": null, "netAccounted": 550, "accountedDebit": 550, "accountedCredit": null, "netEntered": 550, "enteredDebit": 550, "enteredCredit": null, "transactionDescription": null, "assignmentRule": null, "agreement": null, "method": null, "basisSource": null, "notes": null, "netOriginalDistributedAccounted": 550, "originalDistributedAccountedDebit": 550, "originalDistributedAccountedCredit": null, "netDistributedAccounted": 550, "distributedAccountedDebit": 550, "distributedAccountedCredit": null, "accountedCurrencyCode": "USD", "netOriginalDistributedEntered": 0, "originalDistributedEnteredDebit": null, "originalDistributedEnteredCredit": null, "netDistributedEntered": 0, "distributedEnteredDebit": null, "distributedEnteredCredit": null, "enteredCurrencyCode": null, "invoiceNumber": null, "invoiceDate": null, "invoiceType": null, "journalNumber": null, "contributionId": 100106784462506, "projectCostingStatus": "Not applicable", "project": null, "projectNumber": null, "task": null, "taskNumber": null, "expenditureType": null, "expenditureTypeDescription": null, "expenditureOrganization": null, "expenditureBusinessUnit": null, "expenditureItemDate": null, "createdByJointVentureFlag": false, "stakeholderReportingHeaderId": null, "stakeholderReportingLedger": null, "stakeholderReportingDate": null, "stakeholderReportingStatus": "Available to process", "changeReason": null, "changeReasonDetails": null, "createdBy": "username", "creationDate": "2025-05-29T01:23:48+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2025-05-29T01:25:04.337+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106783888854", "name": "jointVentureDistributions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions/100106783888854", "name": "jointVentureDistributions", "kind": "item" } ] }, "count": 3, "hasMore": true, "limit": 3, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureDistributions", "name": "jointVentureDistributions", "kind": "collection" } ] }