Update a joint venture subledger transaction

patch

/fscmRestApi/resources/11.13.18.05/jointVentureSLATransactions/{jointVentureSLATransactionsUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Joint Venture Subledger Transactions resource and used to uniquely identify an instance of Joint Venture Subledger Transactions. The client should not generate the hash key value. Instead, the client should query on the Joint Venture Subledger Transactions collection resource in order to navigate to a specific instance of Joint Venture Subledger Transactions to get the hash key.
Header Parameters
  • 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.
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Account Key Flexfields
Type: array
Title: Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
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 : transactionDFF
Type: array
Show Source
Nested Schema : jointVentureSLATransactions-transactionAccount-item-patch-request
Type: object
Show Source
Nested Schema : jointVentureSLATransactions-transactionChanges-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : jointVentureSLATransactions-item-response
Type: object
Show Source
  • Title: Account
    Read Only: true
    The combination of the values of the account segments assigned to the transaction.
  • Title: Account Description
    Read Only: true
    The description of the account assigned to the joint venture transaction.
  • Title: Accounted Credit
    Read Only: true
    The transaction credit amount in accounting currency.
  • Title: Accounted Debit
    Read Only: true
    The transaction debit amount in accounting currency.
  • Title: Accounting Class
    Read Only: true
    Maximum Length: 30
    The short name classification of the journal entry lines.
  • Title: Accounting Date
    Read Only: true
    The date used to determine the accounting period for the transaction.
  • Title: Application ID
    Read Only: true
    The unique identifier of the functional area for subledger accounting.
  • Title: Assignment Rule
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition assignment rule used to assign the ownership definition or direct billed stakeholder.
  • Title: Bill When Paid
    Read Only: true
    Maximum Length: 1
    Default Value: false
    Indicates whether to create joint venture distributions only for paid expenses or costs.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 240
    The name of the business unit associated with the joint venture.
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the carried interest agreement associated with the joint venture transaction.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the carried interest agreement associated with the joint venture transaction.
  • Title: Source Ownership Definition
    Read Only: true
    Maximum Length: 30
    The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction.
  • Title: Reason
    Maximum Length: 80
    The reason for the manual change to the joint venture transaction.
  • Title: Details
    Maximum Length: 240
    Additional text to describe the reason the joint venture transaction was manually changed.
  • Title: Chart of Accounts
    Read Only: true
    The unique identifier of the chart of accounts structure instance.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture transaction.
  • 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.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture transaction was created.
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Distribution Only
    Maximum Length: 1
    Default Value: false
    Indicates whether the transaction is for distribution only, not for invoicing.
  • Title: Entered Credit
    Read Only: true
    The transaction credit amount in the entered currency.
  • Title: Entered Currency
    Read Only: true
    Maximum Length: 15
    The currency code entered on the original transaction.
  • Title: Entered Debit
    Read Only: true
    The transaction debit amount in the entered currency.
  • Title: Expenditure Business Unit
    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.
  • Title: Expenditure Item Date
    The date of the expenditure in Project Costing that's associated with the subledger accounting entry for the joint venture transaction.
  • Title: Expenditure Organization
    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.
  • Title: Expenditure Type
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Expenditure Type Description
    Read Only: true
    Maximum Length: 80
    The description of the expenditure type.
  • Title: Header ID
    Read Only: true
    The unique identifier of the journal.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The unique name of the joint venture.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 1996
    The description of the subledger accounting journal line.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the joint venture transaction was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the joint venture transaction.
  • Title: Ledger
    Read Only: true
    Maximum Length: 30
    The name of the ledger.
  • Title: Line Number
    Read Only: true
    The number of the journal line.
  • Links
  • Title: Original Ownership Definition
    Read Only: true
    Maximum Length: 20
    The original ownership definition assigned to the joint venture transaction.
  • Title: Original Stakeholder Description
    Read Only: true
    Maximum Length: 240
    The description of the original stakeholder.
  • Title: Original Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    The original stakeholder assigned to the joint venture transaction.
  • Title: Original Transaction Payment Status
    The payment status of the original transaction associated with the joint venture transaction.
  • Title: Override Expenditure Type Name
    Read Only: true
    Maximum Length: 240
    The name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments.
  • Title: Override Task Name
    Read Only: true
    Maximum Length: 255
    The name of the overriding task associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments.
  • Title: Ownership Definition
    Maximum Length: 30
    The short name of the ownership definition assigned to the transaction as an override.
  • Title: Party Name
    Read Only: true
    The name of the party associated with the stakeholder on the joint venture distribution.
  • Title: Party Number
    Read Only: true
    The number of the additonal party participating in the business relationship.
  • Title: Party Site Name
    Read Only: true
    The site name of the party on the subledger transaction.
  • Title: Party Site Number
    Read Only: true
    The site number of the additional party participating in the business relationship.
  • Title: Third-Party Type
    Read Only: true
    Maximum Length: 1
    The type of the additional third party.
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 15
    The accounting period name in a calendar.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Number
    Maximum Length: 25
    The unique identifier of the project.
  • Title: Source
    Read Only: true
    Maximum Length: 512
    The name of the application the transaction originated from, for example Payables or Cost Management.
  • Title: Source Table
    Read Only: true
    Maximum Length: 30
    The name of the source table.
  • Title: Stakeholder Description
    The description of the override joint venture stakeholder.
  • Title: Direct Billed Stakeholder
    The name of the joint venture stakeholder assigned to the transaction as an override.
  • Title: Units
    Read Only: true
    The statistical unit of measure of the journal entry line.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    The name of the project task representing a subdivision of work.
  • Title: Task Number
    Maximum Length: 100
    The unique number of the project task.
  • Account Key Flexfields
    Title: Account Key Flexfields
    The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
  • 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.
  • Title: Transaction Changes Exist
    Read Only: true
    Maximum Length: 255
    Indicates whether manual changes have been made to a transaction.
  • Title: Transaction Date
    The date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date.
  • transactionDFF
  • Title: Transaction ID
    Read Only: true
    The unique identifier of the joint venture transaction.
  • Title: Transaction Status
    Maximum Length: 80
    The status of the joint venture transaction.
  • Title: Transaction Type
    Read Only: true
    Maximum Length: 80
    The type of transaction to be processed, such as expense, revenue, asset, overhead, and so forth.
Nested Schema : Account Key Flexfields
Type: array
Title: Account Key Flexfields
The code identifying the general ledger account against which amounts are recorded. These represent assets, liabilities, revenues, expenses, and fund balances.
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 : transactionDFF
Type: array
Show Source
Nested Schema : jointVentureSLATransactions-transactionAccount-item-response
Type: object
Show Source
Nested Schema : jointVentureSLATransactions-transactionChanges-item-response
Type: object
Show Source
  • Title: After Assignment Rule
    Read Only: true
    Maximum Length: 30
    The new ownership definition assignment rule assigned to the transaction.
  • Title: After Distribution Only
    Read Only: true
    Maximum Length: 1
    The new distribution only value assigned to the transaction.
  • Title: After Ownership Definition
    Read Only: true
    Maximum Length: 30
    The new ownership definition assigned to the transaction.
  • Title: After Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    The new name of the direct billed stakeholder assigned to the transaction.
  • Title: After Direct Billed Stakeholder Description
    Read Only: true
    Maximum Length: 240
    The new description of the direct billed stakeholder assigned to the transaction.
  • Title: After Status
    Read Only: true
    Maximum Length: 80
    The new status assigned to the transaction.
  • Title: After Transaction Date
    Read Only: true
    The new transaction date assigned to the transaction.
  • Title: Before Assignment Rule
    Read Only: true
    Maximum Length: 30
    The previous ownership definition assignment rule assigned to the transaction.
  • Title: Before Distribution Only
    Read Only: true
    Maximum Length: 1
    The previous distribution only value assigned to the transaction.
  • Title: Before Ownership Definition
    Read Only: true
    Maximum Length: 30
    The previous ownership definition assigned to the transaction.
  • Title: Before Direct Billed Stakeholder
    Read Only: true
    Maximum Length: 30
    The previous name of the direct billed stakeholder assigned to the transaction.
  • Title: Before Direct Billed Stakeholder Description
    Read Only: true
    Maximum Length: 240
    The previous description of the direct billed stakeholder assigned to the transaction.
  • Title: Before Status
    Read Only: true
    Maximum Length: 80
    The previous status assigned to the transaction.
  • Title: Before Transaction Date
    Read Only: true
    The previous transaction date assigned to the transaction.
  • Title: Reason
    Read Only: true
    Maximum Length: 80
    The reason for the manual change to the joint venture transaction.
  • Title: Details
    Read Only: true
    Maximum Length: 240
    Additional text to describe the reason the joint venture transaction was manually changed.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the joint venture transaction change.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture transaction change was created.
  • Links
  • Title: Transaction Change ID
    Read Only: true
    The unique identifier of the joint venture transaction change.
Nested Schema : jointVentureSLATransactions-transactionDFF-item-response
Type: object
Show Source
Back to Top