Update a joint venture transaction
patch
/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.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
Maximum Length:30
The name of the direct billed stakeholder assigned to the joint venture transaction. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates whether the transaction is for distribution only, not for invoicing. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The name of the ownership definition assigned to the transaction, which can be overridden. -
status: string
Title:
Transaction Status
Maximum Length:80
The status of the joint venture transaction. -
transactionChanges: array
Joint Venture Transaction Changes
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionDate: string
(date)
Title:
Transaction Date
The date when the joint venture source transaction occurred.
Nested Schema : Joint Venture Transaction Changes
Type:
array
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.
Show Source
Nested Schema : jointVentureTransactions-transactionChanges-item-patch-request
Type:
Show Source
object
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.
Root Schema : jointVentureTransactions-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:
Accounted Credit
Read Only:true
The transaction credit amount in accounting currency. -
accountedDebit: number
Title:
Accounted Debit
Read Only:true
The transaction debit amount in accounting currency. -
accountingClassCode: string
Title:
Accounting Class
Read Only:true
Maximum Length:30
The accounting classification of the joint venture transaction. -
accountingCurrency: string
Title:
Accounting Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
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. -
agreementDescription: string
Title:
Carried Interest Agreement Description
Read Only:true
Maximum Length:240
The description 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. -
assignmentRuleDescription: string
Title:
Assignment Rule Description
Read Only:true
Maximum Length:240
The description of the ownership definition assignment rule. -
basisSource: string
Title:
Basis Source
Read Only:true
Maximum Length:80
The source of the overhead calculation amount. -
changeReason: string
Title:
Change Reason
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction was created. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
Maximum Length:30
The name of the direct billed stakeholder assigned to the joint venture transaction. -
directBilledStakeholderDescription: string
Title:
Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The description of the direct billed stakeholder. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates whether the transaction is for distribution only, not for invoicing. -
distributionType: string
Title:
Distribution Type
Read Only:true
Maximum Length:80
Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals. -
enteredCredit: number
Title:
Entered Credit
Read Only:true
The transaction credit amount in the entered currency. -
enteredCurrency: string
Title:
Entered Currency
Read Only:true
Maximum Length:15
The currency code entered on the original transaction. -
enteredDebit: number
Title:
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. -
headerId: integer
(int64)
Title:
Header ID
Read Only:true
The unique identifier of the original transaction -
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. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture transaction. -
ledger: string
Title:
Ledger
Read Only:true
Maximum Length:30
The name of the ledger. -
lineNumber: integer
(int64)
Title:
Line Number
Read Only:true
The number of the line in the original transaction. -
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. -
methodDescription: string
Title:
Method Description
Read Only:true
Maximum Length:240
The description of the overhead method. -
netAccounted: number
Title:
Net Accounted Amount
Read Only:true
The net transaction amount in the accounting currency. -
netEntered: number
Title:
Net Entered Amount
Read Only:true
The net transaction amount in the entered currency. -
notes: string
Title:
Notes
Read Only:true
Maximum Length:240
Additional details about the joint venture source transaction. -
originalDirectBilledStakeholder: string
Title:
Original Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The name of the original direct billed stakeholder assigned to the joint venture transaction. -
originalDirectBilledStakeholderDescription: string
Title:
Original Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The description of the original direct billed stakeholder. -
originalOwnershipDefinition: string
Title:
Original Ownership Definition
Read Only:true
Maximum Length:30
The original ownership definition assigned to the joint venture transaction. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The name of the ownership definition assigned to the transaction, which can be overridden. -
project: string
Title:
Project Name
Read Only:true
Maximum Length:240
The name of the project. -
projectNumber: string
Title:
Project Number
Read Only:true
Maximum Length:25
The unique identifier of the project. -
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. -
status: string
Title:
Transaction Status
Maximum Length:80
The status 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. -
transactionChanges: array
Joint Venture Transaction Changes
Title:
Joint Venture Transaction Changes
The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions. -
transactionDate: string
(date)
Title:
Transaction Date
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:80
The source of the joint venture transaction, for example general ledger, subledger accounting, or joint venture.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Joint Venture Transaction Changes
Type:
array
Title:
Joint Venture Transaction Changes
The 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 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.
Nested Schema : jointVentureTransactions-transactionChanges-item-response
Type:
Show Source
object
-
afterAssignmentRule: string
Title:
After Assignment Rule
Read Only:true
Maximum Length:30
The new ownership definition assignment rule assigned to the transaction. -
afterDistributionOnlyFlag: boolean
Title:
After Distribution Only
Read Only:true
Maximum Length:1
The new distribution only value assigned to the transaction. -
afterOwnershipDefinition: string
Title:
After Ownership Definition
Read Only:true
Maximum Length:30
The new ownership definition assigned to the transaction. -
afterStakeholder: string
Title:
After Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The new name of the direct billed stakeholder assigned to the transaction. -
afterStakeholderDescription: string
Title:
After Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The new description of the direct billed stakeholder assigned to the transaction. -
afterStatus: string
Title:
After Status
Read Only:true
Maximum Length:80
The new status assigned to the transaction. -
afterTransactionDate: string
(date)
Title:
After Transaction Date
Read Only:true
The new transaction date assigned to the transaction. -
beforeAssignmentRule: string
Title:
Before Assignment Rule
Read Only:true
Maximum Length:30
The previous ownership definition assignment rule assigned to the transaction. -
beforeDistributionOnlyFlag: boolean
Title:
Before Distribution Only
Read Only:true
Maximum Length:1
The previous distribution only value assigned to the transaction. -
beforeOwnershipDefinition: string
Title:
Before Ownership Definition
Read Only:true
Maximum Length:30
The previous ownership definition assigned to the transaction. -
beforeStakeholder: string
Title:
Before Direct Billed Stakeholder
Read Only:true
Maximum Length:30
The previous name of the direct billed stakeholder assigned to the transaction. -
beforeStakeholderDescription: string
Title:
Before Direct Billed Stakeholder Description
Read Only:true
Maximum Length:240
The previous description of the direct billed stakeholder assigned to the transaction. -
beforeStatus: string
Title:
Before Status
Read Only:true
Maximum Length:80
The previous status assigned to the transaction. -
beforeTransactionDate: string
(date)
Title:
Before Transaction Date
Read Only:true
The previous transaction date assigned to the transaction. -
changeReason: string
Title:
Change Reason
Read Only:true
Maximum Length:80
The reason for the manual change to the joint venture transaction. -
changeReasonDetails: string
Title:
Change Reason Details
Read Only:true
Maximum Length:240
Additional text to describe the reason the joint venture transaction was manually changed. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture transaction change. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture transaction change was created. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
transactionChangeId: integer
(int64)
Title:
Transaction Change ID
Read Only:true
The unique identifier of the joint venture transaction change.
Nested Schema : Links
Type:
array
Title:
Links
The 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: