Jump to

• Request
• Response
• Examples

Get all distributions for joint venture generated transactions

get

/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions

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 distribution that matches the primary key criteria specified.
    Finder Variables
    • distributionId; integer; The unique identifier of the joint venture distribution.
  • distributionFinder Finds all joint venture generated distributions 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 agreement; string; of the carried interest distribution.
    • agreementDescription; string; The description of the agreement; string; of the carried interest distribution.
    • createdBy; string; The user who created the joint venture distribution.
    • directBilledStakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
    • distributionOnlyFlag; string; Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
    • expenditureType; string; The name identifying the expenditure classification.
    • expenditureTypeDescription; string; The description of the expenditure type.
    • jointVenture; string; The name of the joint venture of the source transaction.
    • lastUpdatedBy; string; The user who last updated the joint venture distribution.
    • ledger; string; The name of the ledger; string; .
    • lineType; string; The type of the distribution line for billing adjustments.
    • method; string; The unique name of the overhead method; string; .
    • ownershipDefinition; string; The name of the ownership definition used to process the distribution.
    • project; string; The name of the project; string; .
    • projectNumber; string; The unique identifier of the project; string; .
    • searchAllText; string; A search value to identify joint venture distributions that contain the specified text in any of the attributes.
    • status; string; The status; string; of the distribution of the joint venture transaction.
    • task; string; The name of the project; string; task; string; representing a subdivision of work.
    • taskNumber; string; The unique number of the project; string; task; string; .
    • transactionId; integer; The unique identifier for the joint venture transaction that the distribution was created from.
    • trxNumber; string; A unique value that identifies the invoice generated for the joint venture distribution.
• 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.
  • agreement; string; The name of the agreement of the carried interest distribution.
  • agreementDescription; string; The description of the agreement of the carried interest distribution.
  • basisSource; string; The source of the overhead calculation amount.
  • businessUnit; string; The name of the business unit associated with the joint venture.
  • changeReason; string; The reason the joint venture distribution was canceled.
  • changeReasonDetails; string; Additional text to describe the reason the joint venture distribution line was canceled
  • contributionId; integer; The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
  • createdBy; string; The user who created the joint venture distribution.
  • creationDate; string; The date and time when the joint venture distribution was created.
  • directBilledStakeholder; string; The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
  • distributedCredit; number; The distributed credit amount for the stakeholder in accounting currency.
  • distributedDebit; number; The distributed debit amount for the stakeholder in accounting currency.
  • distributionId; integer; The unique identifier of the joint venture distribution.
  • distributionOnlyFlag; boolean; Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
  • distributionType; string; Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
  • expenditureType; string; The name identifying the expenditure classification.
  • expenditureTypeDescription; string; The description of the expenditure type.
  • jointVenture; string; The name of the joint venture of the source transaction.
  • jointVentureDescription; string; The description of the joint venture.
  • lastUpdateDate; string; The date and time when the joint venture distribution was last updated.
  • lastUpdatedBy; string; The user who last updated the joint venture distribution.
  • ledger; string; The name of the ledger.
  • lineNumber; integer; The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.
  • lineType; string; The type of the distribution line for billing adjustments.
  • method; string; The unique name of the overhead method.
  • methodDescription; string; The description of the overhead method.
  • notes; string; Additional details about the joint venture source transaction.
  • originalDistributedCredit; number; The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
  • originalDistributedDebit; number; The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
  • originalDistributedEnteredCredit; number; The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
  • originalDistributedEnteredDebit; number; The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
  • originalStakeholder; string; The name of the stakeholder that was originally associated with the joint venture distribution.
  • ownershipDefinition; string; The name of the ownership definition used to process the distribution.
  • ownershipDefinitionEndDate; string; Effective end date of the ownership definition that was used to distribute the joint venture transaction.
  • ownershipDefinitionStartDate; string; Effective start date of the ownership definition that was used to distribute the joint venture transaction.
  • percentageOfInterest; number; The percentage of ownership a stakeholder has in a joint venture transaction.
  • project; string; The name of the project.
  • projectCostingStatus; string; The status of the joint venture accounting entries exported to the Project Costing system.
  • projectNumber; string; The unique identifier of the project.
  • reassignedStakeholder; string; The name of the stakeholder that's reassigned to the joint venture distribution.
  • roundAmountFlag; boolean; An indicator that rounding was applied to the distribution amount.
  • stakeholder; string; The name of the distribution stakeholder.
  • status; string; The status of the distribution 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.
  • transactionCredit; number; The credit amount of the joint venture source transaction.
  • transactionCurrency; string; The currency of the transaction amount.
  • transactionDate; string; Indicates the default effective date for journal entries or the transaction date for subledger entries.
  • transactionDebit; number; The debit amount of the joint venture source transaction.
  • transactionDescription; string; A description that's passed into the joint venture invoice for the joint venture source transaction.
  • transactionId; integer; The unique identifier for the joint venture transaction that the distribution was created from.
  • transactionType; string; The type of the joint venture source transaction.
  • trxDate; string; The date of the invoice transaction generated for the joint venture distribution.
  • trxNumber; string; A unique value that identifies the invoice generated for the joint venture distribution.
• 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 : jointVentureBasicGeneratedDistributions

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/jointVentureBasicGeneratedDistributions-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureBasicGeneratedDistributions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureBasicGeneratedDistributions-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 : jointVentureBasicGeneratedDistributions-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.
• agreement: string
  Title: Carried Interest Agreement

  Read Only: true

  Maximum Length: 30

  The name of the agreement of the carried interest distribution.
• agreementDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the agreement of the carried interest distribution.
• basisSource: string
  Title: Basis Source

  Read Only: true

  Maximum Length: 80

  The source of the overhead calculation amount.
• businessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit associated with the joint venture.
• changeReason: string
  Title: Change Reason

  Maximum Length: 80

  The reason the joint venture distribution was canceled.
• changeReasonDetails: string
  Title: Change Reason Details

  Maximum Length: 240

  Additional text to describe the reason the joint venture distribution line was canceled
• contributionId: integer (int64)
  Title: Partner Contribution ID

  Read Only: true

  The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the joint venture distribution.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the joint venture distribution was created.
• directBilledStakeholder: string
  Title: Direct Billed Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.
• distributedCredit: number
  Title: Distributed Credit

  Read Only: true

  The distributed credit amount for the stakeholder in accounting currency.
• distributedDebit: number
  Title: Distributed Debit

  Read Only: true

  The distributed debit amount for the stakeholder in accounting currency.
• distributionDFF: array distributionDFF
• distributionId: integer (int64)
  Title: Distribution ID

  Read Only: true

  The unique identifier of the joint venture distribution.
• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
• distributionType: string
  Title: Distribution Type

  Read Only: true

  Maximum Length: 80

  Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.
• expenditureType: string
  Title: Expenditure Type

  Read Only: true

  Maximum Length: 240

  The name identifying the expenditure classification.
• expenditureTypeDescription: string
  Title: Expenditure Type Description

  Read Only: true

  Maximum Length: 2000

  The description of the expenditure type.
• invoiceTransactionType: string
  Title: Invoice Type

  Read Only: true

  Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.
• jointVenture: string
  Title: Joint Venture

  Read Only: true

  Maximum Length: 30

  The name of the joint venture of the source transaction.
• jointVentureDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the joint venture distribution was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture distribution.
• ledger: string
  Title: Ledger

  Read Only: true

  Maximum Length: 30

  The name of the ledger.
• lineNumber: integer (int32)
  Title: Distribution Line Number

  Read Only: true

  The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.
• lineType: string
  Title: Distribution Line Type

  Read Only: true

  Maximum Length: 80

  The type of the distribution line for billing adjustments.
• 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.
• notes: string
  Title: Notes

  Read Only: true

  Maximum Length: 240

  Additional details about the joint venture source transaction.
• originalDistributedCredit: number
  Title: Original Distributed Credit

  Read Only: true

  The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
• originalDistributedDebit: number
  Title: Original Distributed Debit

  Read Only: true

  The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.
• originalDistributedEnteredCredit: number
  Title: Original Distributed Entered Credit

  Read Only: true

  The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
• originalDistributedEnteredDebit: number
  Title: Original Distributed Entered Debit

  Read Only: true

  The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.
• originalStakeholder: string
  Title: Original Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the stakeholder that was originally associated with the joint venture distribution.
• ownershipDefinition: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition used to process the distribution.
• ownershipDefinitionEndDate: string (date)
  Title: End Date

  Read Only: true

  Effective end date of the ownership definition that was used to distribute the joint venture transaction.
• ownershipDefinitionStartDate: string (date)
  Title: Start Date

  Read Only: true

  Effective start date of the ownership definition that was used to distribute the joint venture transaction.
• percentageOfInterest: number
  Title: Ownership Percentage

  Read Only: true

  The percentage of ownership a stakeholder has in a joint venture transaction.
• project: string
  Title: Project Name

  Read Only: true

  Maximum Length: 240

  The name of the project.
• projectCostingStatus: string
  Title: Project Costing Status

  Read Only: true

  Maximum Length: 80

  The status of the joint venture accounting entries exported to the Project Costing system.
• projectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The unique identifier of the project.
• reassignedStakeholder: string
  Title: Reassigned Stakeholder

  Maximum Length: 30

  The name of the stakeholder that's reassigned to the joint venture distribution.
• roundAmountFlag: boolean
  Title: Rounding Applied

  Read Only: true

  Maximum Length: 1

  An indicator that rounding was applied to the distribution amount.
• stakeholder: string
  Title: Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the distribution stakeholder.
• status: string
  Title: Distribution Status

  Maximum Length: 80

  The status of the distribution of the joint venture transaction.
• task: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  The name of the project task representing a subdivision of work.
• taskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  The unique number of the project task.
• transactionCredit: number
  Title: Transaction Credit

  Read Only: true

  The credit amount of the joint venture source transaction.
• transactionCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency of the transaction amount.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  Indicates the default effective date for journal entries or the transaction date for subledger entries.
• transactionDebit: number
  Title: Transaction Debit

  Read Only: true

  The debit amount of the joint venture source transaction.
• transactionDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 240

  A description that's passed into the joint venture invoice for the joint venture source transaction.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  The unique identifier for the joint venture transaction that the distribution was created from.
• transactionType: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The type of the joint venture source transaction.
• trxDate: string (date)
  Title: Invoice Date

  Read Only: true

  The date of the invoice transaction generated for the joint venture distribution.
• trxNumber: string
  Title: Invoice Number

  Read Only: true

  Maximum Length: 20

  A unique value that identifies the invoice generated for the joint venture distribution.

{
    "type":"object",
    "properties":{
        "distributionType":{
            "title":"Distribution Type",
            "maxLength":"80",
            "type":"string",
            "description":"Indicates the type of transaction the distribution represents, such as expense, revenue, and so forth.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnit":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "notes":{
            "title":"Notes",
            "maxLength":"240",
            "type":"string",
            "description":"Additional details about the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "projectCostingStatus":{
            "title":"Project Costing Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the joint venture accounting entries exported to the Project Costing system.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "project":{
            "title":"Project Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDescription":{
            "title":"Transaction Description",
            "maxLength":"240",
            "type":"string",
            "description":"A description that's passed into the joint venture invoice for the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholder":{
            "title":"Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the distribution stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedEnteredDebit":{
            "title":"Original Distributed Entered Debit",
            "type":"number",
            "description":"The original debit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the joint venture of the source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "reassignedStakeholder":{
            "title":"Reassigned Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the stakeholder that's reassigned to the joint venture distribution.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "stakeholder"
                ]
            },
            "x-queryable":true
        },
        "lineType":{
            "title":"Distribution Line Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the distribution line for billing adjustments.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture.",
            "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"
            }
        },
        "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
        },
        "trxDate":{
            "title":"Invoice Date",
            "type":"string",
            "description":"The date of the invoice transaction generated for the joint venture distribution.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedEnteredCredit":{
            "title":"Original Distributed Entered Credit",
            "type":"number",
            "description":"The original credit amount of the joint venture distribution in the entered currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "expenditureType":{
            "title":"Expenditure Type",
            "maxLength":"240",
            "type":"string",
            "description":"The name identifying the expenditure classification.",
            "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 distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "basisSource":{
            "title":"Basis Source",
            "maxLength":"80",
            "type":"string",
            "description":"The source of the overhead calculation amount.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCurrency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the transaction amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Carried Interest Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the agreement of the carried interest distribution.",
            "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 distribution line was canceled",
            "nullable":true,
            "x-queryable":true
        },
        "method":{
            "title":"Method",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture distribution was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the agreement of the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier for the joint venture transaction that the distribution was created from.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ownershipDefinition":{
            "title":"Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition used to process the distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Effective start date of the ownership definition that was used to distribute the joint venture transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "invoiceTransactionType":{
            "title":"Invoice Type",
            "type":"string",
            "description":"Indicates the type of invoice transaction generated for the joint venture distribution, such as receivable invoice and credit memo.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "task":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the project task representing a subdivision of work.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedCredit":{
            "title":"Original Distributed Credit",
            "type":"number",
            "description":"The original credit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lineNumber":{
            "title":"Distribution Line Number",
            "type":"integer",
            "description":"The line number of a joint venture distribution and any associated lines created for billing adjustments and partner contribution draws.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "originalStakeholder":{
            "title":"Original Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the stakeholder that was originally associated with the joint venture distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedDebit":{
            "title":"Distributed Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "status":{
            "title":"Distribution Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the distribution of the joint venture transaction.",
            "nullable":true,
            "x-hints":{
                "sortable":false,
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.",
            "nullable":true,
            "x-queryable":true
        },
        "expenditureTypeDescription":{
            "title":"Expenditure Type Description",
            "maxLength":"2000",
            "type":"string",
            "description":"The description of the expenditure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Effective end date of the ownership definition that was used to distribute the joint venture transaction.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionId":{
            "title":"Distribution ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "trxNumber":{
            "title":"Invoice Number",
            "maxLength":"20",
            "type":"string",
            "description":"A unique value that identifies the invoice generated for the joint venture distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalDistributedDebit":{
            "title":"Original Distributed Debit",
            "type":"number",
            "description":"The original debit amount of the joint venture distribution in the accounting currency. This is the amount prior to being split by partner contributions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "roundAmountFlag":{
            "title":"Rounding Applied",
            "maxLength":"1",
            "type":"boolean",
            "description":"An indicator that rounding was applied to the distribution amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributedCredit":{
            "title":"Distributed Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCredit":{
            "title":"Transaction Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ledger":{
            "title":"Ledger",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution assigned to the joint venture distribution and drawn from.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":"80",
            "type":"string",
            "description":"The reason the joint venture distribution was canceled.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeChangeReason"
                ]
            },
            "x-queryable":true
        },
        "projectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureBasicGeneratedDistributions-distributionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Indicates the default effective date for journal entries or the transaction date for subledger entries.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "directBilledStakeholder":{
            "title":"Direct Billed Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the direct billed stakeholder assigned to the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":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
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture distribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "percentageOfInterest":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percentage of ownership a stakeholder has in a joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "taskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique number of the project task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDebit":{
            "title":"Transaction Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : distributionDFF

Type: array

Show Source

• Array of: object jointVentureBasicGeneratedDistributions-distributionDFF-item-response

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

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 : jointVentureBasicGeneratedDistributions-distributionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• DistributionId: integer (int64)
  Title: Distribution ID

  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DistributionId":{
            "title":"Distribution 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_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
        },
        "__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"
    }
}

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."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all distributions for 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/jointVentureBasicGeneratedDistributions"

Response Body Example

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

    "items": [
        {
            "distributionId": 100105348630648,
            "status": "Process complete",
            "distributionType": "Overhead",
            "lineType": "Original",
            "lineNumber": 1,
            "transactionDate": "2017-02-02",
            "transactionId": 100105348630257,
            "jointVenture": "APOLLOBASIN",
            "jointVentureDescription": "Oklahoma panhandle project",
            "businessUnit": "HEPP Petroleum USA BU1",
            "ownershipDefinition": "CIOPD",
            "ownershipDefinitionStartDate": "2017-01-01",
            "ownershipDefinitionEndDate": "2017-12-31",
            "stakeholder": "GOILMEX_ASH6",
            "originalStakeholder": null,
            "reassignedStakeholder": "GOILMEX_ASH6",
            "directBilledStakeholder": null,
            "percentageOfInterest": 34,
            "roundAmountFlag": false,
            "distributionOnlyFlag": false,
            "changeReason": null,
            "changeReasonDetails": null,
            "accountingPeriod": "Feb-17",
            "transactionType": "Overhead",
            "method": "OH_APOLLO0505212350",
            "methodDescription": "Overhead for APOLLO",
            "basisSource": "Joint venture billed transactions",
            "transactionDescription": "OH_BA0505212350",
            "distributedDebit": 306,
            "distributedCredit": null,
            "originalDistributedDebit": 306,
            "originalDistributedCredit": null,
            "originalDistributedEnteredDebit": null,
            "originalDistributedEnteredCredit": null,
            "transactionDebit": 900,
            "transactionCredit": null,
            "transactionCurrency": "USD",
            "ledger": "HEPPLedger US",
            "trxNumber": null,
            "trxDate": null,
            "invoiceTransactionType": null,
            "contributionId": null,
            "agreement": "CIA2",
            "agreementDescription": null,
            "projectCostingStatus": "Not applicable",
            "project": null,
            "projectNumber": null,
            "task": null,
            "taskNumber": null,
            "expenditureType": null,
            "expenditureTypeDescription": null,
            "createdBy": "username",
            "creationDate": "2024-02-19T07:16:15+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2024-02-19T15:31:18.754+00:00",
            "notes": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630648",
                    "name": "jointVentureBasicGeneratedDistributions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000678"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630648",
                    "name": "jointVentureBasicGeneratedDistributions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630648/child/distributionDFF",
                    "name": "distributionDFF",
                    "kind": "collection"
                }
            ]
        },
        {
            "distributionId": 100105348630647,
            "status": "Process complete",
            "distributionType": "Overhead",
            "lineType": "Original",
            "lineNumber": 1,
            "transactionDate": "2017-02-02",
            "transactionId": 100105348630257,
            "jointVenture": "APOLLOBASIN",
            "jointVentureDescription": "Oklahoma panhandle project",
            "businessUnit": "HEPP Petroleum USA BU1",
            "ownershipDefinition": "CIOPD",
            "ownershipDefinitionStartDate": "2017-01-01",
            "ownershipDefinitionEndDate": "2017-12-31",
            "stakeholder": "BARNCASPER",
            "originalStakeholder": null,
            "reassignedStakeholder": "BARNCASPER",
            "directBilledStakeholder": null,
            "percentageOfInterest": 28,
            "roundAmountFlag": false,
            "distributionOnlyFlag": false,
            "changeReason": null,
            "changeReasonDetails": null,
            "accountingPeriod": "Feb-17",
            "transactionType": "Overhead",
            "method": "OH_APOLLO0505111300",
            "methodDescription": "Overhead for APOLLO",
            "basisSource": "Joint venture billed transactions",
            "transactionDescription": "OH_BA0505111300",
            "distributedDebit": 252,
            "distributedCredit": null,
            "originalDistributedDebit": 252,
            "originalDistributedCredit": null,
            "originalDistributedEnteredDebit": null,
            "originalDistributedEnteredCredit": null,
            "transactionDebit": 900,
            "transactionCredit": null,
            "transactionCurrency": "USD",
            "ledger": "HEPPLedger US",
            "trxNumber": "43003",
            "trxDate": "2024-02-19",
            "invoiceTransactionType": "Receivables Invoice",
            "contributionId": null,
            "agreement": "CIA2",
            "agreementDescription": null,
            "projectCostingStatus": "Not applicable",
            "project": null,
            "projectNumber": null,
            "task": null,
            "taskNumber": null,
            "expenditureType": null,
            "expenditureTypeDescription": null,
            "createdBy": "username",
            "creationDate": "2024-02-19T07:16:15+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2024-02-19T15:30:50.105+00:00",
            "notes": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630647",
                    "name": "jointVentureBasicGeneratedDistributions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630647",
                    "name": "jointVentureBasicGeneratedDistributions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureBasicGeneratedDistributions/100105348630647/child/distributionDFF",
                    "name": "distributionDFF",
                    "kind": "collection"
                }
            ]
        }

Back to Top