Get a joint venture transaction
get
/fscmRestApi/resources/11.13.18.05/jointVentureTransactions/{jointVentureTransactionsUniqID}
Request
Path Parameters
-
jointVentureTransactionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Joint Venture Transactions resource and used to uniquely identify an instance of Joint Venture Transactions. The client should not generate the hash key value. Instead, the client should query on the Joint Venture Transactions collection resource in order to navigate to a specific instance of Joint Venture Transactions to get the hash key.
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
-
Effective-Of:
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:
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 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 : jointVentureTransactions-item-response
Type:
Show Source
object-
account: string
Title:
AccountRead Only:trueMaximum Length:255The account assigned to the joint venture transaction. -
accountedCredit: number
Title:
Accounted CreditRead Only:trueThe transaction credit amount in accounting currency. -
accountedDebit: number
Title:
Accounted DebitRead Only:trueThe transaction debit amount in accounting currency. -
accountingClassCode: string
Title:
Accounting ClassRead Only:trueMaximum Length:30The accounting classification of the joint venture transaction. -
accountingCurrency: string
Title:
Accounting CurrencyRead Only:trueMaximum Length:15The currency of the transaction amount. -
accountingDate: string
(date)
Title:
Accounting DateRead Only:trueThe date used to determine the accounting period for the transaction. -
accountingPeriod: string
Title:
Accounting PeriodRead Only:trueMaximum Length:15The name of the fiscal period that the joint venture transaction is associated with. -
accountSegment1: string
Title:
Account Segment 1Read Only:trueMaximum Length:25The segment 1 value of the account assigned to the joint venture transaction. -
accountSegment10: string
Title:
Account Segment 10Read Only:trueMaximum Length:25The segment 10 value of the account assigned to the joint venture transaction. -
accountSegment11: string
Title:
Account Segment 11Read Only:trueMaximum Length:25The segment 11 value of the account assigned to the joint venture transaction. -
accountSegment12: string
Title:
Account Segment 12Read Only:trueMaximum Length:25The segment 12 value of the account assigned to the joint venture transaction. -
accountSegment13: string
Title:
Account Segment 13Read Only:trueMaximum Length:25The segment 13 value of the account assigned to the joint venture transaction. -
accountSegment14: string
Title:
Account Segment 14Read Only:trueMaximum Length:25The segment 14 value of the account assigned to the joint venture transaction. -
accountSegment15: string
Title:
Account Segment 15Read Only:trueMaximum Length:25The segment 15 value of the account assigned to the joint venture transaction. -
accountSegment16: string
Title:
Account Segment 16Read Only:trueMaximum Length:25The segment 16 value of the account assigned to the joint venture transaction. -
accountSegment17: string
Title:
Account Segment 17Read Only:trueMaximum Length:25The segment 17 value of the account assigned to the joint venture transaction. -
accountSegment18: string
Title:
Account Segment 18Read Only:trueMaximum Length:25The segment 18 value of the account assigned to the joint venture transaction. -
accountSegment19: string
Title:
Account Segment 19Read Only:trueMaximum Length:25The segment 19 value of the account assigned to the joint venture transaction. -
accountSegment2: string
Title:
Account Segment 2Read Only:trueMaximum Length:25The segment 2 value of the account assigned to the joint venture transaction. -
accountSegment20: string
Title:
Account Segment 20Read Only:trueMaximum Length:25The segment 20 value of the account assigned to the joint venture transaction. -
accountSegment21: string
Title:
Account Segment 21Read Only:trueMaximum Length:25The segment 21 value of the account assigned to the joint venture transaction. -
accountSegment22: string
Title:
Account Segment 22Read Only:trueMaximum Length:25The segment 22 value of the account assigned to the joint venture transaction. -
accountSegment23: string
Title:
Account Segment 23Read Only:trueMaximum Length:25The segment 23 value of the account assigned to the joint venture transaction. -
accountSegment24: string
Title:
Account Segment 24Read Only:trueMaximum Length:25The segment 24 value of the account assigned to the joint venture transaction. -
accountSegment25: string
Title:
Account Segment 25Read Only:trueMaximum Length:25The segment 25 value of the account assigned to the joint venture transaction. -
accountSegment26: string
Title:
Account Segment 26Read Only:trueMaximum Length:25The segment 26 value of the account assigned to the joint venture transaction. -
accountSegment27: string
Title:
Account Segment 27Read Only:trueMaximum Length:25The segment 27 value of the account assigned to the joint venture transaction. -
accountSegment28: string
Title:
Account Segment 28Read Only:trueMaximum Length:25The segment 28 value of the account assigned to the joint venture transaction. -
accountSegment29: string
Title:
Account Segment 29Read Only:trueMaximum Length:25The segment 29 value of the account assigned to the joint venture transaction. -
accountSegment3: string
Title:
Account Segment 3Read Only:trueMaximum Length:25The segment 3 value of the account assigned to the joint venture transaction. -
accountSegment30: string
Title:
Account Segment 30Read Only:trueMaximum Length:25The segment 30 value of the account assigned to the joint venture transaction. -
accountSegment4: string
Title:
Account Segment 4Read Only:trueMaximum Length:25The segment 4 value of the account assigned to the joint venture transaction. -
accountSegment5: string
Title:
Account Segment 5Read Only:trueMaximum Length:25The segment 5 value of the account assigned to the joint venture transaction. -
accountSegment6: string
Title:
Account Segment 6Read Only:trueMaximum Length:25The segment 6 value of the account assigned to the joint venture transaction. -
accountSegment7: string
Title:
Account Segment 7Read Only:trueMaximum Length:25The segment 7 value of the account assigned to the joint venture transaction. -
accountSegment8: string
Title:
Account Segment 8Read Only:trueMaximum Length:25The segment 8 value of the account assigned to the joint venture transaction. -
accountSegment9: string
Title:
Account Segment 9Read Only:trueMaximum Length:25The segment 9 value of the account assigned to the joint venture transaction. -
agreement: string
Title:
Carried Interest AgreementRead Only:trueMaximum Length:30The name of the carried interest agreement associated with the joint venture transaction. -
agreementDescription: string
Title:
Carried Interest Agreement DescriptionRead Only:trueMaximum Length:240The description of the carried interest agreement associated with the joint venture transaction. -
assignmentRule: string
Title:
Assignment RuleRead Only:trueMaximum Length:30The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder. -
assignmentRuleDescription: string
Title:
Assignment Rule DescriptionRead Only:trueMaximum Length:240The description of the ownership definition assignment rule. -
basisSource: string
Title:
Basis SourceRead Only:trueMaximum Length:80The source of the overhead calculation amount. -
changeReason: string
Title:
Change ReasonMaximum Length:80The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason DetailsMaximum Length:240Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture transaction. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the joint venture transaction was created. -
directBilledStakeholder: string
Title:
Direct Billed StakeholderMaximum Length:30The name of the direct billed stakeholder assigned to the joint venture transaction. -
directBilledStakeholderDescription: string
Title:
Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The description of the direct billed stakeholder. -
distributionOnlyFlag: boolean
Title:
Distribution OnlyMaximum Length:1Indicates whether the transaction is for distribution only, not for invoicing. -
distributionType: string
Title:
Distribution TypeRead Only:trueMaximum Length:80Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals. -
enteredCredit: number
Title:
Entered CreditRead Only:trueThe transaction credit amount in the entered currency. -
enteredCurrency: string
Title:
Entered CurrencyRead Only:trueMaximum Length:15The currency code entered on the original transaction. -
enteredDebit: number
Title:
Entered DebitRead Only:trueThe transaction debit amount in the entered currency. -
expenditureBusinessUnit: string
Title:
Expenditure Business UnitRead Only:trueMaximum Length:240The 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 DateRead Only:trueThe date of the expenditure in Project Costing that's associated with the subledger accounting entry for the joint venture transaction. -
expenditureOrganization: string
Title:
Expenditure OrganizationRead Only:trueMaximum Length:240The 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 TypeRead Only:trueMaximum Length:240The name identifying the expenditure classification. -
expenditureTypeDescription: string
Title:
Expenditure Type DescriptionRead Only:trueMaximum Length:2000The description of the expenditure type. -
headerId: integer
(int64)
Title:
Header IDRead Only:trueThe unique identifier of the original transaction -
jointVenture: string
Title:
Joint VentureRead Only:trueMaximum Length:30The unique name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture DescriptionRead Only:trueMaximum Length:240The description of the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the joint venture transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the joint venture transaction. -
ledger: string
Title:
LedgerRead Only:trueMaximum Length:30The name of the ledger. -
lineNumber: integer
(int64)
Title:
Line NumberRead Only:trueThe number of the line in the original transaction. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
method: string
Title:
MethodRead Only:trueMaximum Length:30The unique name of the overhead method. -
methodDescription: string
Title:
Method DescriptionRead Only:trueMaximum Length:240The description of the overhead method. -
netAccounted: number
Title:
Net Accounted AmountRead Only:trueThe net transaction amount in the accounting currency. -
netEntered: number
Title:
Net Entered AmountRead Only:trueThe net transaction amount in the entered currency. -
notes: string
Title:
NotesRead Only:trueMaximum Length:240Additional details about the joint venture source transaction. -
originalDirectBilledStakeholder: string
Title:
Original Direct Billed StakeholderRead Only:trueMaximum Length:30The name of the original direct billed stakeholder assigned to the joint venture transaction. -
originalDirectBilledStakeholderDescription: string
Title:
Original Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The description of the original direct billed stakeholder. -
originalOwnershipDefinition: string
Title:
Original Ownership DefinitionRead Only:trueMaximum Length:30The original ownership definition assigned to the joint venture transaction. -
ownershipDefinition: string
Title:
Ownership DefinitionMaximum Length:30The name of the ownership definition assigned to the transaction, which can be overridden. -
project: string
Title:
Project NameRead Only:trueMaximum Length:240The name of the project. -
projectNumber: string
Title:
Project NumberRead Only:trueMaximum Length:25The unique identifier of the project. -
source: string
Title:
SourceRead Only:trueMaximum Length:512The name of the application the transaction originated from, for example Payables or Cost Management. -
status: string
Title:
Transaction StatusMaximum Length:80The status of the joint venture transaction. -
task: string
Title:
Task NameRead Only:trueMaximum Length:255The name of the project task representing a subdivision of work. -
taskNumber: string
Title:
Task NumberRead Only:trueMaximum Length:100The unique number of the project task. -
transactionChanges: array
Joint Venture Transaction Changes
Title:
Joint Venture Transaction ChangesThe joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionDate: string
(date)
Title:
Transaction DateThe date when the joint venture source transaction occurred. -
transactionDescription: string
Title:
Transaction DescriptionRead Only:trueMaximum Length:240The description to include on the transactions created through invoice or internal transfer journal processing. -
transactionId: integer
(int64)
Title:
Transaction IDRead Only:trueThe unique identifier of the joint venture transaction. -
transactionSource: string
Title:
Transaction SourceRead Only:trueMaximum Length:80The source of the joint venture transaction, for example general ledger, subledger accounting, or joint venture.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Joint Venture Transaction Changes
Type:
arrayTitle:
Joint Venture Transaction ChangesThe joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : jointVentureTransactions-transactionChanges-item-response
Type:
Show Source
object-
afterAssignmentRule: string
Title:
After Assignment RuleRead Only:trueMaximum Length:30The new ownership definition assignment rule assigned to the transaction. -
afterDistributionOnlyFlag: boolean
Title:
After Distribution OnlyRead Only:trueMaximum Length:1The new distribution only value assigned to the transaction. -
afterOwnershipDefinition: string
Title:
After Ownership DefinitionRead Only:trueMaximum Length:30The new ownership definition assigned to the transaction. -
afterStakeholder: string
Title:
After Direct Billed StakeholderRead Only:trueMaximum Length:30The new name of the direct billed stakeholder assigned to the transaction. -
afterStakeholderDescription: string
Title:
After Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The new description of the direct billed stakeholder assigned to the transaction. -
afterStatus: string
Title:
After StatusRead Only:trueMaximum Length:80The new status assigned to the transaction. -
afterTransactionDate: string
(date)
Title:
After Transaction DateRead Only:trueThe new transaction date assigned to the transaction. -
beforeAssignmentRule: string
Title:
Before Assignment RuleRead Only:trueMaximum Length:30The previous ownership definition assignment rule assigned to the transaction. -
beforeDistributionOnlyFlag: boolean
Title:
Before Distribution OnlyRead Only:trueMaximum Length:1The previous distribution only value assigned to the transaction. -
beforeOwnershipDefinition: string
Title:
Before Ownership DefinitionRead Only:trueMaximum Length:30The previous ownership definition assigned to the transaction. -
beforeStakeholder: string
Title:
Before Direct Billed StakeholderRead Only:trueMaximum Length:30The previous name of the direct billed stakeholder assigned to the transaction. -
beforeStakeholderDescription: string
Title:
Before Direct Billed Stakeholder DescriptionRead Only:trueMaximum Length:240The previous description of the direct billed stakeholder assigned to the transaction. -
beforeStatus: string
Title:
Before StatusRead Only:trueMaximum Length:80The previous status assigned to the transaction. -
beforeTransactionDate: string
(date)
Title:
Before Transaction DateRead Only:trueThe previous transaction date assigned to the transaction. -
changeReason: string
Title:
Change ReasonRead Only:trueMaximum Length:80The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason DetailsRead Only:trueMaximum Length:240Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the joint venture transaction change. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the joint venture transaction change was created. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
transactionChangeId: integer
(int64)
Title:
Transaction Change IDRead Only:trueThe unique identifier of the joint venture transaction change.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- transactionChanges
-
Parameters:
- jointVentureTransactionsUniqID:
$request.path.jointVentureTransactionsUniqID
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. - jointVentureTransactionsUniqID: