Get all joint venture generated transactions

get

/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions

Request

Query Parameters
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the joint venture transaction that matches the primary key criteria specified.
      Finder Variables
      • transactionId; integer; The unique identifier of the joint venture transaction.
    • transactionFinder Finds all joint venture generated transactions that match the specified search criteria.
      Finder Variables
      • accountingPeriod; string; The name of the fiscal period that the source transaction is associated with.
      • agreement; string; The name of the carried interest agreement; string; associated with the joint venture transaction.
      • agreementDescription; string; The description of the carried interest agreement; string; associated with the joint venture transaction.
      • basisSource; string; The source of the overhead calculation amount.
      • createdBy; string; The user who created the joint venture transaction.
      • directBilledStakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction.
      • directBilledStakeholderDescription; string; The description of the direct billed stakeholder.
      • distributionType; string; Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals.
      • jointVenture; string; The unique name of the joint venture.
      • jointVentureDescription; string; The description of the joint venture.
      • lastUpdatedBy; string; The user who last updated the joint venture transaction.
      • ledger; string; The name of the ledger; string; .
      • method; string; The unique name of the overhead method; string; .
      • methodDescription; string; The description of the overhead method; string; .
      • originalDirectBilledStakeholder; string; The name of the original direct billed stakeholder assigned to the joint venture transaction.
      • originalDirectBilledStakeholderDescription; string; The description of the original direct billed stakeholder.
      • originalOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction.
      • ownershipDefinition; string; The name of the ownership definition assigned to the transaction, which can be overridden.
      • searchAllText; string; A search value to identify joint venture transactions that contain the specified text in any of the string attributes.
      • status; string; The status; string; of the joint venture transaction.
      • transactionDescription; string; The description to include on the transactions created through invoice or internal transfer journal processing.
      • transactionType; string; The type of the joint venture source transaction.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • accountingDate; string; The date used to determine the accounting period for the transaction.
    • accountingPeriod; string; The name of the fiscal period that the source transaction is associated with.
    • agreement; string; The name of the carried interest agreement associated with the joint venture transaction.
    • agreementDescription; string; The description of the carried interest agreement associated with the joint venture transaction.
    • basisSource; string; The source of the overhead calculation amount.
    • createdBy; string; The user who created the joint venture transaction.
    • creationDate; string; The date and time when the joint venture transaction was created.
    • credit; number; The credit amount of the joint venture source transaction.
    • currency; string; The currency of the transaction amount.
    • debit; number; The debit amount of the joint venture source transaction.
    • directBilledStakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction.
    • directBilledStakeholderDescription; string; The description of the direct billed stakeholder.
    • distributionOnlyFlag; boolean; Indicates whether the transaction is for distribution only, not for invoicing.
    • distributionType; string; Determines whether the distributed transaction is billable or payable to the stakeholder when processed through invoicing and internal transfer journals.
    • expenditureType; string; The name identifying the expenditure classification.
    • expenditureTypeDescription; string; The description of the expenditure type.
    • headerId; integer; The unique identifier for the joint venture source transaction header.
    • jointVenture; string; The unique name of the joint venture.
    • jointVentureDescription; string; The description of the joint venture.
    • lastUpdateDate; string; The date and time when the joint venture transaction was last updated.
    • lastUpdatedBy; string; The user who last updated the joint venture transaction.
    • ledger; string; The name of the ledger.
    • lineNumber; integer; The accounting line for the joint venture source transaction.
    • method; string; The unique name of the overhead method.
    • methodDescription; string; The description of the overhead method.
    • methodType; string; The method type used to determine how the overhead amount is calculated.
    • notes; string; Additional details about the joint venture source transaction.
    • originalDirectBilledStakeholder; string; The name of the original direct billed stakeholder assigned to the joint venture transaction.
    • originalDirectBilledStakeholderDescription; string; The description of the original direct billed stakeholder.
    • originalOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction.
    • ownershipDefinition; string; The name of the ownership definition assigned to the transaction, which can be overridden.
    • partnerOffsetAccount; string; The combination of account segment values assigned to a partner's line in the receivables invoice.
    • periodBasis; string; The value that determines how the period basis is derived for the overhead calculation. Valid values are: Period, Year to period, and Inception to period.
    • project; string; The name of the project.
    • projectNumber; string; The unique identifier of the project.
    • status; string; The status of the joint venture transaction.
    • task; string; The name of the project task representing a subdivision of work.
    • taskNumber; string; The unique number of the project task.
    • transactionDate; string; The date when the transaction occurred, which may be different from the joint venture source transaction date.
    • transactionDescription; string; The description to include on the transactions created through invoice or internal transfer journal processing.
    • transactionId; integer; The unique identifier of the joint venture transaction.
    • transactionType; string; The type of the joint venture source transaction.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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 : jointVentureGeneratedTransactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : jointVentureGeneratedTransactions-item-response
Type: object
Show Source
  • 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 source transaction is associated with.
  • Title: 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: 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: Credit
    Read Only: true
    The credit amount of the joint venture source transaction.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The currency of the transaction amount.
  • Title: Debit
    Read Only: true
    The debit amount of the joint venture source transaction.
  • Title: Direct Billed Stakeholder
    The name of the direct billed stakeholder assigned to the joint venture transaction.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the direct billed stakeholder.
  • Title: Distribution Only
    Maximum Length: 1
    Default Value: false
    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: Expenditure Type
    Read Only: true
    Maximum Length: 240
    The name identifying the expenditure classification.
  • Title: Description
    Read Only: true
    Maximum Length: 2000
    The description of the expenditure type.
  • Title: Header ID
    Read Only: true
    The unique identifier for the joint venture source transaction header.
  • Title: Joint Venture
    Read Only: true
    Maximum Length: 30
    The unique name of the joint venture.
  • Title: 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 accounting line for the joint venture source transaction.
  • Links
  • Title: Method
    Read Only: true
    Maximum Length: 30
    The unique name of the overhead method.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    The description of the overhead method.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The method type used to determine how the overhead amount is calculated.
  • 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: Description
    Read Only: true
    Maximum Length: 240
    The description of the original direct billed stakeholder.
  • Title: Original Ownership Definition
    Read Only: true
    Maximum Length: 20
    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: Partner Account
    Read Only: true
    Maximum Length: 255
    The combination of account segment values assigned to a partner's line in the receivables invoice.
  • Title: Period Basis
    Read Only: true
    Maximum Length: 80
    The value that determines how the period basis is derived for the overhead calculation. Valid values are: Period, Year to period, and Inception to period.
  • 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: 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 transaction occurred, which may be different from the joint venture source transaction date.
  • Title: Transaction Description
    Read Only: true
    Maximum Length: 240
    The description to include on the transactions created through invoice or internal transfer journal processing.
  • transactionDFF
  • Title: Transaction ID
    Read Only: true
    The unique identifier of the joint venture transaction.
  • Title: Type
    Read Only: true
    Maximum Length: 80
    The type of the joint venture source transaction.
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 : jointVentureGeneratedTransactions-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.
Nested Schema : jointVentureGeneratedTransactions-transactionDFF-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to retrieve all joint venture generated transactions by submitting a GET request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions" 

Response Body Example

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "transactionId": 100105352341697,
            "headerId": 100105339829271,
            "lineNumber": 1,
            "status": "Available to process",
            "transactionDate": "2017-01-01",
            "accountingPeriod": "Jan-17",
            "transactionType": "Overhead",
            "distributionType": "Overhead",
            "distributionOnlyFlag": false,
            "jointVenture": "APOLLOBASIN",
            "jointVentureDescription": "Oklahoma panhandle project",
            "transactionDescription": null,
            "ledger": "HEPPLedger US",
            "ownershipDefinition": "APOLLOBASINOPD1",
            "originalOwnershipDefinition": "APOLLOBASINOPD1",
            "directBilledStakeholder": null,
            "directBilledStakeholderDescription": null,
            "originalDirectBilledStakeholder": null,
            "originalDirectBilledStakeholderDescription": null,
            "debit": 1300,
            "credit": null,
            "currency": "USD",
            "partnerOffsetAccount": "11-1001-11010-11-0001",
            "method": "OH_APOLLOGLOBAL1805210359",
            "methodDescription": null,
            "methodType": "Percentage of cost",
            "basisSource": "Joint venture billed transactions",
            "periodBasis": null,
            "agreement": null,
            "agreementDescription": null,
            "project": null,
            "projectNumber": null,
            "task": null,
            "taskNumber": null,
            "expenditureType": null,
            "expenditureTypeDescription": null,
            "changeReason": null,
            "changeReasonDetails": null,
            "createdBy": "username",
            "creationDate": "2024-02-21T06:49:06.436+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2024-02-21T06:49:06.436+00:00",
            "notes": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697",
                    "name": "jointVentureGeneratedTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697",
                    "name": "jointVentureGeneratedTransactions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697/child/transactionChanges",
                    "name": "transactionChanges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105352341697/child/transactionDFF",
                    "name": "transactionDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "transactionId": 100105348631499,
            "headerId": 100105348630177,
            "lineNumber": 1,
            "status": "Process complete",
            "transactionDate": "2017-01-10",
            "accountingPeriod": "Jan-17",
            "transactionType": "Manual",
            "distributionType": "Cost",
            "distributionOnlyFlag": false,
            "jointVenture": "APOLLOBASIN",
            "jointVentureDescription": "Oklahoma panhandle project",
            "transactionDescription": null,
            "ledger": "HEPPLedger US",
            "ownershipDefinition": "APOLLOBASINCIOPD",
            "originalOwnershipDefinition": "APOLLOBASINCIOPD",
            "directBilledStakeholder": null,
            "directBilledStakeholderDescription": null,
            "originalDirectBilledStakeholder": null,
            "originalDirectBilledStakeholderDescription": null,
            "debit": 1000,
            "credit": null,
            "currency": "USD",
            "partnerOffsetAccount": "11-1001-56120-11-0001",
            "method": null,
            "methodDescription": null,
            "methodType": null,
            "basisSource": null,
            "periodBasis": null,
            "agreement": "CIA2",
            "agreementDescription": null,
            "project": null,
            "projectNumber": null,
            "task": null,
            "taskNumber": null,
            "expenditureType": null,
            "expenditureTypeDescription": null,
            "changeReason": null,
            "changeReasonDetails": null,
            "createdBy": "username",
            "creationDate": "2024-02-19T07:10:20.941+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2024-02-19T07:16:00+00:00",
            "notes": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105348631499",
                    "name": "jointVentureGeneratedTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105348631499",
                    "name": "jointVentureGeneratedTransactions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105348631499/child/transactionChanges",
                    "name": "transactionChanges",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureGeneratedTransactions/100105348631499/child/transactionDFF",
                    "name": "transactionDFF",
                    "kind": "collection"
                }
            ]
        },
Back to Top