Jump to

• Request
• Response
• Examples

Get all overhead transactions

get

/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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 overhead transactions that match the specified search criteria.
    Finder Variables
    • basisSource; string; The source of the overhead calculation amount.
    • carriedInterestAgreement; string; The name of the carried interest agreement associated with the joint venture transaction.
    • carriedInterestAgreementDescription; string; The description of the carried interest agreement associated with the joint venture transaction.
    • carriedInterestSourceOwnerDefinition; string; The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction.
    • createdBy; string; The user who created the joint venture transaction.
    • jointVenture; string; The unique name of the joint venture.
    • jointVentureDescription; string; The joint venture description.
    • journalDescription; string; The description to include on the joint venture invoices for the calculated overhead transactions.
    • 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; .
    • originalOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction.
    • originalStakeholder; string; The name of the original direct billed stakeholder; string; assigned to the joint venture transaction.
    • originalStakeholderDescription; string; The description of the original direct billed stakeholder; string; .
    • 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.
    • stakeholder; string; The name of the direct billed stakeholder; string; assigned to the joint venture transaction.
    • stakeholderDescription; string; The description of the direct billed stakeholder; string; .
    • transactionStatus; string; The joint venture transaction status.
    • transactionType; string; The type of the joint venture source transaction.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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.
  • basisSource; string; The source of the overhead calculation amount.
  • carriedInterestAgreement; string; The name of the carried interest agreement associated with the joint venture transaction.
  • carriedInterestAgreementDescription; string; The description of the carried interest agreement associated with the joint venture transaction.
  • carriedInterestSourceOwnerDefinition; string; The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction.
  • createdBy; string; The user who created the joint venture transaction.
  • creationDate; string; The date and time when the joint venture transaction was created.
  • creditAmount; number; The credit amount of the joint venture source transaction.
  • currencyCode; string; The currency of the transaction amount.
  • debitAmount; number; The debit amount of the joint venture source transaction.
  • distributionOnlyFlag; boolean; Indicates whether the transaction is for distribution only, not for invoicing.
  • 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.
  • journalDescription; string; The description to include on the joint venture invoices for the calculated overhead transactions.
  • 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.
  • originalOwnershipDefinition; string; The original ownership definition assigned to the joint venture transaction.
  • originalStakeholder; string; The name of the original direct billed stakeholder assigned to the joint venture transaction.
  • originalStakeholderDescription; string; The description of the original direct billed stakeholder.
  • 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.
  • stakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction.
  • stakeholderDescription; string; The description of the direct billed stakeholder.
  • transactionDate; string; The date when the transaction occurred, which may be different from the joint venture source transaction date.
  • transactionId; integer; The unique identifier of the joint venture transaction.
  • transactionStatus; string; The status of the joint venture transaction.
  • transactionType; string; The type of the joint venture source transaction.
• totalResults: boolean
  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

• 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.

There's no request body for this operation.

Back to Top

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.

Body ()

Root Schema : jointVentureOverheadTransactions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jointVentureOverheadTransactions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureOverheadTransactions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureOverheadTransactions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureOverheadTransactions-item-response

Type: object

Show Source

• 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 source transaction is associated with.
• basisSource: string
  Title: Basis Source

  Read Only: true

  The source of the overhead calculation amount.
• carriedInterestAgreement: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  The name of the carried interest agreement associated with the joint venture transaction.
• carriedInterestAgreementDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the carried interest agreement associated with the joint venture transaction.
• carriedInterestSourceOwnerDefinition: string
  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.
• 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.
• creditAmount: number
  Title: Credit

  Read Only: true

  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

  Read Only: true

  The debit amount of the joint venture source transaction.
• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Default Value: false

  Indicates whether the transaction is for distribution only, not for invoicing.
• headerId: integer (int64)
  Title: Header ID

  Read Only: true

  The unique identifier for the joint venture source transaction header.
• 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.
• journalDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 240

  The description to include on the joint venture invoices for the calculated overhead transactions.
• 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 Name

  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: 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.
• methodType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The method type used to determine how the overhead amount is calculated.
• originalOwnershipDefinition: string
  Title: Original Ownership Definition

  Read Only: true

  Maximum Length: 20

  The original ownership definition assigned to the joint venture transaction.
• originalStakeholder: 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.
• originalStakeholderDescription: string
  Title: Original Direct Billed Stakeholder Description

  Read Only: true

  Maximum Length: 255

  The description of the original direct billed stakeholder.
• ownershipDefinition: string
  Title: Ownership Definition

  Maximum Length: 30

  The name of the ownership definition assigned to the transaction, which can be overridden.
• partnerOffsetAccount: string
  Title: Partner Account

  Read Only: true

  The combination of account segment values assigned to a partner's line in the receivables invoice.
• periodBasis: string
  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.
• stakeholder: string
  Title: Direct Billed Stakeholder

  The name of the direct billed stakeholder assigned to the joint venture transaction.
• stakeholderDescription: string
  Title: Direct Billed Stakeholder Description

  Read Only: true

  The description of the direct billed stakeholder.
• 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.
• transactionChangesExistFlag: boolean
  Title: Transaction Changes Exist

  Read Only: true

  Maximum Length: 255

  Indicates whether manual changes have been made to a transaction.
• transactionDate: string (date)
  Title: Transaction Date

  The date when the transaction occurred, which may be different from the joint venture source transaction date.
• transactionDFF: array transactionDFF
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  The unique identifier of the joint venture transaction.
• transactionStatus: string
  Title: Transaction Status

  Maximum Length: 80

  The status of the joint venture transaction.
• transactionType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The type of the joint venture source transaction.

{
    "type":"object",
    "properties":{
        "partnerOffsetAccount":{
            "title":"Partner Account",
            "type":"string",
            "description":"The combination of account segment values assigned to a partner's line in the receivables invoice.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestAgreement":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the carried interest agreement associated with the joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholder":{
            "title":"Direct Billed Stakeholder",
            "type":"string",
            "description":"The name of the direct billed stakeholder assigned to the joint venture transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "headerId":{
            "title":"Header ID",
            "type":"integer",
            "description":"The unique identifier for the joint venture source transaction header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "methodType":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The method type used to determine how the overhead amount is calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "periodBasis":{
            "title":"Period Basis",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "carriedInterestSourceOwnerDefinition":{
            "title":"Source Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition used as the basis for creating the carried interest ownership definition assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingPeriod":{
            "title":"Accounting Period",
            "maxLength":"15",
            "type":"string",
            "description":"The name of the fiscal period that the source transaction is associated with.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOverheadTransactions-transactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ledger":{
            "title":"Ledger Name",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the joint venture transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "basisSource":{
            "title":"Basis Source",
            "type":"string",
            "description":"The source of the overhead calculation amount.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeBasisSrc"
                ]
            },
            "x-queryable":true
        },
        "methodDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingDate":{
            "title":"Accounting Date",
            "type":"string",
            "description":"The date used to determine the accounting period for the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":"240",
            "type":"string",
            "description":"Additional text to describe the reason the joint venture transaction was manually changed.",
            "nullable":true,
            "x-queryable":false
        },
        "method":{
            "title":"Method",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason for the manual change to the joint venture transaction.",
            "nullable":true,
            "x-queryable":false
        },
        "transactionStatus":{
            "title":"Transaction Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the joint venture transaction.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeTransactionStatus"
                ]
            },
            "x-queryable":true
        },
        "debitAmount":{
            "title":"Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionChangesExistFlag":{
            "title":"Transaction Changes Exist",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether manual changes have been made to a transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "stakeholderDescription":{
            "title":"Direct Billed Stakeholder Description",
            "type":"string",
            "description":"The description of the direct billed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the transaction occurred, which may be different from the joint venture source transaction date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "transactionType":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the joint venture source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalStakeholderDescription":{
            "title":"Original Direct Billed Stakeholder Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the original direct billed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinition":{
            "title":"Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition assigned to the transaction, which can be overridden.",
            "nullable":true,
            "x-queryable":true
        },
        "transactionChanges":{
            "title":"Joint Venture Transaction Changes",
            "type":"array",
            "description":"The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.",
            "items":{
                "$ref":"#/components/schemas/jointVentureOverheadTransactions-transactionChanges-item-response"
            }
        },
        "journalDescription":{
            "title":"Transaction Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description to include on the joint venture invoices for the calculated overhead transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The accounting line for the joint venture source transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "creditAmount":{
            "title":"Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestAgreementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the carried interest agreement associated with the joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalOwnershipDefinition":{
            "title":"Original Ownership Definition",
            "maxLength":"20",
            "type":"string",
            "description":"The original ownership definition assigned to the joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the transaction amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalStakeholder":{
            "title":"Original Direct Billed Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the original direct billed stakeholder assigned to the joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the transaction is for distribution only, not for invoicing.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object jointVentureOverheadTransactions-transactionChanges-item-response

{
    "title":"Joint Venture Transaction Changes",
    "type":"array",
    "description":"The joint venture transaction changes resource is used to view the history of manual changes to joint venture transactions.",
    "items":{
        "$ref":"#/components/schemas/jointVentureOverheadTransactions-transactionChanges-item-response"
    }
}

Nested Schema : transactionDFF

Type: array

Show Source

• Array of: object jointVentureOverheadTransactions-transactionDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOverheadTransactions-transactionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : jointVentureOverheadTransactions-transactionChanges-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "beforeAssignmentRule":{
            "title":"Before Assignment Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The previous ownership definition assignment rule assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReasonDetails":{
            "title":"Change Reason Details",
            "maxLength":"240",
            "type":"string",
            "description":"Additional text to describe the reason the joint venture transaction was manually changed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason for the manual change to the joint venture transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterOwnershipDefinition":{
            "title":"After Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The new ownership definition assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeStatus":{
            "title":"Before Status",
            "maxLength":"80",
            "type":"string",
            "description":"The previous status assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeStakeholder":{
            "title":"Before Direct Billed Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The previous name of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionChangeId":{
            "title":"Transaction Change ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture transaction change.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "afterTransactionDate":{
            "title":"After Transaction Date",
            "type":"string",
            "description":"The new transaction date assigned to the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture transaction change was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStatus":{
            "title":"After Status",
            "maxLength":"80",
            "type":"string",
            "description":"The new status assigned to the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeDistributionOnlyFlag":{
            "title":"Before Distribution Only",
            "maxLength":"1",
            "type":"boolean",
            "description":"The previous distribution only value assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeOwnershipDefinition":{
            "title":"Before Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The previous ownership definition assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture transaction change.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "afterDistributionOnlyFlag":{
            "title":"After Distribution Only",
            "maxLength":"1",
            "type":"boolean",
            "description":"The new distribution only value assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStakeholder":{
            "title":"After Direct Billed Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The new name of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "beforeStakeholderDescription":{
            "title":"Before Direct Billed Stakeholder Description",
            "maxLength":"240",
            "type":"string",
            "description":"The previous description of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterStakeholderDescription":{
            "title":"After Direct Billed Stakeholder Description",
            "maxLength":"240",
            "type":"string",
            "description":"The new description of the direct billed stakeholder assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "beforeTransactionDate":{
            "title":"Before Transaction Date",
            "type":"string",
            "description":"The previous transaction date assigned to the transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "afterAssignmentRule":{
            "title":"After Assignment Rule",
            "maxLength":"30",
            "type":"string",
            "description":"The new ownership definition assignment rule assigned to the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureOverheadTransactions-transactionDFF-item-response

Type: object

Show Source

• __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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "TransactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top

Examples

The following example shows how to retrieve all overhead 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/jointVentureOverheadTransactions"

Response Body Example

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

{
    "items": [
        {
            "transactionId": 100100266235466,
            "headerId": 100100266251969,
            "lineNumber": 1,
            "transactionStatus": "Available to process",
            "transactionDate": "2017-01-01",
            "transactionType": "Overhead",
            "basisSource": "Joint venture billed transactions",
            "jointVenture": "APOLLOBASIN",
            "jointVentureDescription": "Oklahoma pandhandle project",
            "method": "OH_APOLLOGLOBAL1805210359",
            "methodDescription": "Overhead for APOLLOGLOBAL",
            "journalDescription": "OH_BA1805210359",
            "ledger": "HEPPLedger US",
            "ownershipDefinition": "APOLLOGLOBAL_OH1805210359",
            "originalOwnershipDefinition": "APOLLOGLOBAL_OH1805210359",
            "debitAmount": 1200,
            "creditAmount": null,
            "currencyCode": "USD",
            "partnerOffsetAccount": "11-1001-11010-11-0001",
            "createdBy": "username",
            "creationDate": "2021-05-20T04:26:32.201+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2021-05-20T04:26:32.201+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/100100266235466",
                    "name": "jointVentureOverheadTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions/100100266235466",
                    "name": "jointVentureOverheadTransactions",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOverheadTransactions",
            "name": "jointVentureOverheadTransactions",
            "kind": "collection"
        }
    ]
}

Back to Top