Update a joint venture source transaction
patch
/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}
Request
Path Parameters
-
transactionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
account: string
Title:
Partner Account
The account assigned to a partner's account in the receivables invoice. -
accountingDate: string
(date)
Title:
Accounting Date
The date used to determine the accounting period for the transaction. -
accountingPeriod: string
Title:
Accounting Period
Maximum Length:15
The name of the fiscal period that the source transaction is associated with. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
creditAmount: number
Title:
Credit
The credit amount of the joint venture source transaction. -
debitAmount: number
Title:
Debit
The debit amount of the joint venture source transaction. -
directBilledStakeholder: string
Title:
Direct Billed Stakeholder
Maximum Length:30
The name of the direct billed stakeholder assigned to the joint venture transaction. -
distributionType: string
Title:
Distribution Type
Maximum Length:80
Identifies whether a distribution is billable or payable to the stakeholder and is used when processing the distributed transaction through invoicing and internal transfer journals. -
expenditureType: string
Title:
Expenditure Type
Maximum Length:240
The name identifying the expenditure classification. -
jointVenture: string
Title:
Joint Venture
Maximum Length:30
The unique name of the joint venture. -
journalDescription: string
Title:
Transaction Description
Maximum Length:240
A description that's passed into the joint venture invoice for the joint venture source transaction. -
notes: string
Title:
Notes
Maximum Length:240
Additional details about the joint venture source transaction. -
ownershipDefinition: string
Title:
Ownership Definition
Maximum Length:30
The name of the ownership definition assigned to the transaction, which can be overridden. -
projectNumber: string
Title:
Project Number
Maximum Length:25
The unique identifier of the project. -
sourceTransactionDFF: array
sourceTransactionDFF
-
taskNumber: string
Title:
Task Number
Maximum Length:100
The unique number of the project task. -
transactionDate: string
(date)
Title:
Transaction Date
The date when the joint venture source transaction occurred. -
transactionStatus: string
Title:
Status
The status of the joint venture source transaction.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : jointVentureSourceTransactions-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : jointVentureSourceTransactions-sourceTransactionDFF-item-patch-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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 : jointVentureSourceTransactions-item-response
Type:
Show Source
object
-
account: string
Title:
Partner Account
The account assigned to a partner's account in the receivables invoice. -
accountingDate: string
(date)
Title:
Accounting Date
The date used to determine the accounting period for the transaction. -
accountingPeriod: string
Title:
Accounting Period
Maximum Length:15
The name of the fiscal period that the source transaction is associated with. -
amount: number
Title:
Amount
Read Only:true
The calculated amount of the joint venture source transaction. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
basisSource: string
Title:
Basis Source
Read Only:true
Maximum Length:80
The source of the overhead calculation amount. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture source transaction. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture source transaction was created. -
creditAmount: number
Title:
Credit
The credit amount of the joint venture source transaction. -
currencyCode: string
Title:
Currency
Read Only:true
Maximum Length:15
The currency of the transaction amount. -
debitAmount: number
Title:
Debit
The debit amount of the joint venture source transaction. -
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:
Description
Read Only:true
Maximum Length:240
The description of the direct billed stakeholder. -
distributionType: string
Title:
Distribution Type
Maximum Length:80
Identifies whether a distribution is billable or payable to the stakeholder and is used when processing the distributed transaction through invoicing and internal transfer journals. -
expenditureType: string
Title:
Expenditure Type
Maximum Length:240
The name identifying the expenditure classification. -
expenditureTypeDescription: string
Title:
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 for the joint venture source transaction header. -
jointVenture: string
Title:
Joint Venture
Maximum Length:30
The unique name of the joint venture. -
jointVentureDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
journalDescription: string
Title:
Transaction Description
Maximum Length:240
A description that's passed into the joint venture invoice for the joint venture source transaction. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture source transaction was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture source 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 accounting line for the joint venture source transaction. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
method: string
Title:
Overhead Method
Read Only:true
Maximum Length:30
The unique name of the overhead method. -
methodDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the overhead method. -
notes: string
Title:
Notes
Maximum Length:240
Additional details about the joint venture source 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
Maximum Length:25
The unique identifier of the project. -
sourceTransactionDFF: array
sourceTransactionDFF
-
structureInstanceNumber: integer
(int64)
Title:
Structure Instance Number
Read Only:true
The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture. -
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
Maximum Length:100
The unique number of the project task. -
transactionDate: string
(date)
Title:
Transaction Date
The date when the joint venture source transaction occurred. -
transactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
The unique identifier of the joint venture source transaction. -
transactionStatus: string
Title:
Status
The status of the joint venture source transaction. -
transactionType: string
Title:
Type
Read Only:true
Maximum Length:80
The type of the joint venture source transaction.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureSourceTransactions-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : jointVentureSourceTransactions-sourceTransactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionId: integer
(int64)
Title:
Transaction ID
Read Only:true
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/{transactionId}/child/attachmentsParameters:
- transactionId:
$request.path.transactionId
The attachments resource is used to view, create, and update attachments. - transactionId:
- sourceTransactionDFF
-
Parameters:
- transactionId:
$request.path.transactionId
- transactionId:
Examples
The following example shows how to update a joint venture source transaction by submitting a PATCH request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970"
Request Body Example
The following shows an example of the request body in JSON format.
{ "transactionStatus": "On hold", "transactionDate": "2021-05-21" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "transactionId": 100100266251970, "headerId": 100100266251969, "lineNumber": 1, "transactionStatus": "On hold", "transactionDate": "2021-05-21", "transactionType": "Overhead", "jointVenture": "APOLLOBASIN", "jointVentureDescription": "Oklahoma panhandle project", "method": "OH_APOLLOGLOBAL1805210359", "methodDescription": "Overhead for APOLLOGLOBAL", "journalDescription": "OH_BA1805210359", "ledger": "HEPPLedger US", "debitAmount": 1200, "creditAmount": null, "currencyCode": "USD", "account": "11-1001-11010-11-0001", "createdBy": "username", "creationDate": "2021-05-18T11:16:34+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2021-05-20T05:31:07+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970", "name": "jointVentureSourceTransactions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970", "name": "jointVentureSourceTransactions", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970/child/sourceTransactionDFF", "name": "sourceTransactionDFF", "kind": "collection" } ] }