Get a joint venture transaction

get

/fscmRestApi/resources/11.13.18.05/jointVentureTransactions/{jointVentureTransactionsUniqID}

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 : jointVentureTransactions-item-response
Type: object
Show Source
  • Title: Account
    Read Only: true
    Maximum Length: 255
    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 accounting classification of the joint venture transaction.
  • Title: Accounting Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Accounting Date
    Read Only: true
    The date used to determine the accounting period for the transaction.
  • Title: Accounting Period
    Read Only: true
    Maximum Length: 15
    The name of the fiscal period that the joint venture transaction is associated with.
  • Title: Account Segment 1
    Read Only: true
    Maximum Length: 25
    The segment 1 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 10
    Read Only: true
    Maximum Length: 25
    The segment 10 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 11
    Read Only: true
    Maximum Length: 25
    The segment 11 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 12
    Read Only: true
    Maximum Length: 25
    The segment 12 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 13
    Read Only: true
    Maximum Length: 25
    The segment 13 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 14
    Read Only: true
    Maximum Length: 25
    The segment 14 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 15
    Read Only: true
    Maximum Length: 25
    The segment 15 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 16
    Read Only: true
    Maximum Length: 25
    The segment 16 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 17
    Read Only: true
    Maximum Length: 25
    The segment 17 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 18
    Read Only: true
    Maximum Length: 25
    The segment 18 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 19
    Read Only: true
    Maximum Length: 25
    The segment 19 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 2
    Read Only: true
    Maximum Length: 25
    The segment 2 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 20
    Read Only: true
    Maximum Length: 25
    The segment 20 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 21
    Read Only: true
    Maximum Length: 25
    The segment 21 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 22
    Read Only: true
    Maximum Length: 25
    The segment 22 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 23
    Read Only: true
    Maximum Length: 25
    The segment 23 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 24
    Read Only: true
    Maximum Length: 25
    The segment 24 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 25
    Read Only: true
    Maximum Length: 25
    The segment 25 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 26
    Read Only: true
    Maximum Length: 25
    The segment 26 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 27
    Read Only: true
    Maximum Length: 25
    The segment 27 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 28
    Read Only: true
    Maximum Length: 25
    The segment 28 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 29
    Read Only: true
    Maximum Length: 25
    The segment 29 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 3
    Read Only: true
    Maximum Length: 25
    The segment 3 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 30
    Read Only: true
    Maximum Length: 25
    The segment 30 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 4
    Read Only: true
    Maximum Length: 25
    The segment 4 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 5
    Read Only: true
    Maximum Length: 25
    The segment 5 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 6
    Read Only: true
    Maximum Length: 25
    The segment 6 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 7
    Read Only: true
    Maximum Length: 25
    The segment 7 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 8
    Read Only: true
    Maximum Length: 25
    The segment 8 value of the account assigned to the joint venture transaction.
  • Title: Account Segment 9
    Read Only: true
    Maximum Length: 25
    The segment 9 value of the account assigned to the joint venture transaction.
  • Title: Carried Interest Agreement
    Read Only: true
    Maximum Length: 30
    The name of the carried interest agreement associated with the joint venture transaction.
  • Title: Carried Interest Agreement Description
    Read Only: true
    Maximum Length: 240
    The description of the carried interest agreement associated with the joint venture transaction.
  • 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: Assignment Rule Description
    Read Only: true
    Maximum Length: 240
    The description of the ownership definition assignment rule.
  • Title: Basis Source
    Read Only: true
    Maximum Length: 80
    The source of the overhead calculation amount.
  • Title: Change Reason
    Maximum Length: 80
    The reason for the manual change to the joint venture transaction.
  • Title: Change Reason Details
    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.
  • Title: Creation Date
    Read Only: true
    The date and time when the joint venture transaction was created.
  • Title: Direct Billed Stakeholder
    Maximum Length: 30
    The name of the direct billed stakeholder assigned to the joint venture transaction.
  • Title: Direct Billed Stakeholder Description
    Read Only: true
    Maximum Length: 240
    The description of the direct billed stakeholder.
  • Title: Distribution Only
    Maximum Length: 1
    Indicates whether the transaction is for distribution only, not for invoicing.
  • 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.
  • 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
    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.
  • 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.
  • 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.
  • Title: Expenditure Type
    Read Only: true
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Expenditure Type Description
    Read Only: true
    Maximum Length: 2000
    The description of the expenditure type.
  • Title: Header ID
    Read Only: true
    The unique identifier of the original transaction
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The unique name of the joint venture.
  • Title: Joint Venture Description
    Read Only: true
    Maximum Length: 240
    The description of the joint venture.
  • 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 line in the original transaction.
  • Links
  • Title: Method
    Read Only: true
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Method Description
    Read Only: true
    Maximum Length: 240
    The description of the overhead method.
  • Title: Net Accounted Amount
    Read Only: true
    The net transaction amount in the accounting currency.
  • Title: Net Entered Amount
    Read Only: true
    The net transaction amount in the entered currency.
  • Title: Notes
    Read Only: true
    Maximum Length: 240
    Additional details about the joint venture source transaction.
  • 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.
  • Title: Original Direct Billed Stakeholder Description
    Read Only: true
    Maximum Length: 240
    The description of the original direct billed stakeholder.
  • Title: Original Ownership Definition
    Read Only: true
    Maximum Length: 30
    The original ownership definition assigned to the joint venture transaction.
  • Title: Ownership Definition
    Maximum Length: 30
    The name of the ownership definition assigned to the transaction, which can be overridden.
  • Title: Project Name
    Read Only: true
    Maximum Length: 240
    The name of the project.
  • Title: Project Number
    Read Only: true
    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: Transaction Status
    Maximum Length: 80
    The status of the joint venture transaction.
  • Title: Task Name
    Read Only: true
    Maximum Length: 255
    The name of the project task representing a subdivision of work.
  • Title: Task Number
    Read Only: true
    Maximum Length: 100
    The unique number of the project task.
  • 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 Date
    The date when the joint venture source transaction occurred.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 240
    The description to include on the transactions created through invoice or internal transfer journal processing.
  • Title: Transaction ID
    Read Only: true
    The unique identifier of the joint venture transaction.
  • 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 : 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-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: Change Reason
    Read Only: true
    Maximum Length: 80
    The reason for the manual change to the joint venture transaction.
  • Title: Change Reason 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.
Back to Top