Jump to

• Request
• Response
• Examples

Get all joint venture accounting headers

get

/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders

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 accounting header that matches the primary key criteria specified.
    Finder Variables
    • accountingHeaderId; integer; The unique identifier of the accounting header.
  • accountingHeaderFinder Finds all joint venture accounting headers that match the specified criteria.
    Finder Variables
    • accountingStatus; string; The status of the accounting transaction.
    • accountingType; string; The transaction type of the joint venture accounting transaction.
    • agreement; string; The name of the carried interest agreement; string; .
    • documentNumber; string; The unique document reference for the joint venture accounting transaction.
    • eventId; integer; The unique identifier of the accounting event.
    • jointVenture; string; The unique name of the joint venture.
    • searchAllText; string; A search value to identify joint venture accounting headers that contain the specified text in any of the string attributes.
    • stakeholder; string; The unique name of the joint venture stakeholder; string; .
• 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 joint venture accounting transaction.
  • accountingHeaderId; integer; The unique identifier of the accounting header.
  • accountingStatus; string; The status of the accounting transaction.
  • accountingType; string; The transaction type of the joint venture accounting transaction.
  • agreement; string; The name of the carried interest agreement.
  • businessUnit; string; The name of the business unit associated with the joint venture.
  • contributionId; integer; The unique identifier of the joint venture partner contribution.
  • costCenter; string; The cost center segment value associated with the distributed stakeholder.
  • createdBy; string; The user who created the joint venture accounting header.
  • creationDate; string; The date and time when the joint venture accounting header was created.
  • documentNumber; string; The unique document reference for the joint venture accounting transaction.
  • eventId; integer; The unique identifier of the accounting event.
  • jointVenture; string; The unique name of the joint venture.
  • jointVentureDescription; string; The description of the joint venture.
  • lastUpdateDate; string; The date and time when the joint venture accounting header was last updated.
  • lastUpdatedBy; string; The user who last updated the joint venture accounting header.
  • ledger; string; The name of the ledger.
  • stakeholder; string; The unique name of the joint venture stakeholder.
  • subledgerHeaderId; integer; The unique identifier of the subledger journal.
• 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 : jointVentureAccountingHeaders

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureAccountingHeaders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-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 : jointVentureAccountingHeaders-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 joint venture accounting transaction.
• accountingHeaderDFF: array accountingHeaderDFF
• accountingHeaderId: integer (int64)
  Title: Accounting Header ID

  Read Only: true

  The unique identifier of the accounting header.
• accountingStatus: string
  Title: Accounting Status

  Read Only: true

  Maximum Length: 80

  The status of the accounting transaction.
• accountingType: string
  Title: Accounting Type

  Read Only: true

  Maximum Length: 80

  The transaction type of the joint venture accounting transaction.
• agreement: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  The name of the carried interest agreement.
• businessUnit: string
  Title: Business Unit

  Read Only: true

  Maximum Length: 240

  The name of the business unit associated with the joint venture.
• carriedInterestDistributions: array Carried Interest Distributions
  Title: Carried Interest Distributions

  The carried interest distributions resource is used to view carried interest distributions for a joint venture journal.
• contributionId: integer (int64)
  Title: Partner Contribution ID

  Read Only: true

  The unique identifier of the joint venture partner contribution.
• contributionReferences: array Partner Contribution References
  Title: Partner Contribution References

  The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.
• costCenter: string
  Title: Cost Center

  Read Only: true

  Maximum Length: 25

  The cost center segment value associated with the distributed stakeholder.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the joint venture accounting header was created.
• distributions: array Joint Venture Distributions
  Title: Joint Venture Distributions

  The distributions resource is used to view joint venture distributions for a joint venture journal.
• documentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  The unique document reference for the joint venture accounting transaction.
• eventId: integer (int64)
  Title: Event ID

  Read Only: true

  The unique identifier of the accounting event.
• 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.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 30

  The name of the ledger.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• operationalMeasures: array Joint Venture Operational Measures
  Title: Joint Venture Operational Measures

  The operational measures resource is used to view or reverse the operational measures for a joint venture journal.
• stakeholder: string
  Title: Stakeholder

  Read Only: true

  Maximum Length: 30

  The unique name of the joint venture stakeholder.
• subledgerHeaderId: integer (int64)
  Title: Subledger Header ID

  Read Only: true

  The unique identifier of the subledger journal.

{
    "type":"object",
    "properties":{
        "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
        },
        "documentNumber":{
            "title":"Document Number",
            "maxLength":"240",
            "type":"string",
            "description":"The unique document reference for the joint venture accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture accounting header was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingHeaderDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-accountingHeaderDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "contributionReferences":{
            "title":"Partner Contribution References",
            "type":"array",
            "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-contributionReferences-item-response"
            }
        },
        "accountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "description":"The unique identifier of the accounting header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "stakeholder":{
            "title":"Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the joint venture stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedInterestDistributions":{
            "title":"Carried Interest Distributions",
            "type":"array",
            "description":"The carried interest distributions resource is used to view carried interest distributions for a joint venture journal.",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-carriedInterestDistributions-item-response"
            }
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ledger":{
            "title":"Ledger",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "eventId":{
            "title":"Event ID",
            "type":"integer",
            "description":"The unique identifier of the accounting event.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the joint venture accounting header.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture partner contribution.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "accountingDate":{
            "title":"Accounting Date",
            "type":"string",
            "description":"The date used to determine the accounting period for the joint venture accounting transaction.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreement":{
            "title":"Agreement",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the carried interest agreement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "costCenter":{
            "title":"Cost Center",
            "maxLength":"25",
            "type":"string",
            "description":"The cost center segment value associated with the distributed stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingType":{
            "title":"Accounting Type",
            "maxLength":"80",
            "type":"string",
            "description":"The transaction type of the joint venture accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "subledgerHeaderId":{
            "title":"Subledger Header ID",
            "type":"integer",
            "description":"The unique identifier of the subledger journal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "operationalMeasures":{
            "title":"Joint Venture Operational Measures",
            "type":"array",
            "description":"The operational measures resource is used to view or reverse the operational measures for a joint venture journal.",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-operationalMeasures-item-response"
            }
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture accounting header was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributions":{
            "title":"Joint Venture Distributions",
            "type":"array",
            "description":"The distributions resource is used to view joint venture distributions for a joint venture journal.",
            "items":{
                "$ref":"#/components/schemas/jointVentureAccountingHeaders-distributions-item-response"
            }
        },
        "accountingStatus":{
            "title":"Accounting Status",
            "maxLength":"80",
            "type":"string",
            "description":"The status of the accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture accounting header.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : accountingHeaderDFF

Type: array

Show Source

• Array of: object jointVentureAccountingHeaders-accountingHeaderDFF-item-response

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

Nested Schema : Carried Interest Distributions

Type: array

Title: Carried Interest Distributions

The carried interest distributions resource is used to view carried interest distributions for a joint venture journal.

Show Source

• Array of: object jointVentureAccountingHeaders-carriedInterestDistributions-item-response

{
    "title":"Carried Interest Distributions",
    "type":"array",
    "description":"The carried interest distributions resource is used to view carried interest distributions for a joint venture journal.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-carriedInterestDistributions-item-response"
    }
}

Nested Schema : Partner Contribution References

Type: array

Title: Partner Contribution References

The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.

Show Source

• Array of: object jointVentureAccountingHeaders-contributionReferences-item-response

{
    "title":"Partner Contribution References",
    "type":"array",
    "description":"The contribution references resource is used to view, update, or delete the transaction references required to fund or close partner contributions.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-contributionReferences-item-response"
    }
}

Nested Schema : Joint Venture Distributions

Type: array

Title: Joint Venture Distributions

The distributions resource is used to view joint venture distributions for a joint venture journal.

Show Source

• Array of: object jointVentureAccountingHeaders-distributions-item-response

{
    "title":"Joint Venture Distributions",
    "type":"array",
    "description":"The distributions resource is used to view joint venture distributions for a joint venture journal.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-distributions-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 : Joint Venture Operational Measures

Type: array

Title: Joint Venture Operational Measures

The operational measures resource is used to view or reverse the operational measures for a joint venture journal.

Show Source

• Array of: object jointVentureAccountingHeaders-operationalMeasures-item-response

{
    "title":"Joint Venture Operational Measures",
    "type":"array",
    "description":"The operational measures resource is used to view or reverse the operational measures for a joint venture journal.",
    "items":{
        "$ref":"#/components/schemas/jointVentureAccountingHeaders-operationalMeasures-item-response"
    }
}

Nested Schema : jointVentureAccountingHeaders-accountingHeaderDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• AccountingHeaderId: integer (int64)
  Title: Accounting Header ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AccountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "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
        },
        "__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."
        }
    }
}

Nested Schema : jointVentureAccountingHeaders-carriedInterestDistributions-item-response

Type: object

Show Source

• carriedAmount: number
  Title: Carried Amount

  Read Only: true

  The distributed amount of the nonconsenting stakeholder's share assumed by the consenting stakeholder.
• consentingStakeholder: string
  Title: Consenting Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the consenting stakeholder on the carried interest distribution.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• currency: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The accounting currency of the source joint venture transaction.
• distributionId: integer (int64)
  Title: Distribution ID

  Read Only: true

  The unique identifier of the carried interest distribution.
• distributionLineType: string
  Title: Distribution Line Type

  Read Only: true

  Maximum Length: 80

  The type of carried interest distribution line, such as original, canceled, reversed, and so forth.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• nonConsentingStakeholder: string
  Title: Nonconsenting Stakeholder

  Read Only: true

  Maximum Length: 30

  The name of the nonconsenting stakeholder on the carried interest distribution.
• source: string
  Title: Transaction Source

  Read Only: true

  Maximum Length: 255

  The source of the joint venture transaction that the distribution was created from.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The transaction date of the carried interest distribution.

{
    "type":"object",
    "properties":{
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionLineType":{
            "title":"Distribution Line Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of carried interest distribution line, such as original, canceled, reversed, and so forth.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "source":{
            "title":"Transaction Source",
            "maxLength":"255",
            "type":"string",
            "description":"The source of the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "applicationId",
                    "transactionSourceCodeJST"
                ]
            },
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The transaction date of the carried interest distribution.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionId":{
            "title":"Distribution ID",
            "type":"integer",
            "description":"The unique identifier of the carried interest distribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "nonConsentingStakeholder":{
            "title":"Nonconsenting Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the nonconsenting stakeholder on the carried interest distribution.",
            "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"
            }
        },
        "currency":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The accounting currency of the source joint venture transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "consentingStakeholder":{
            "title":"Consenting Stakeholder",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the consenting stakeholder on the carried interest distribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "carriedAmount":{
            "title":"Carried Amount",
            "type":"number",
            "description":"The distributed amount of the nonconsenting stakeholder's share assumed by the consenting stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "distributedAccountedCredit",
                    "distributedAccountedDebit"
                ]
            },
            "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 : jointVentureAccountingHeaders-contributionReferences-item-response

Type: object

Show Source

• agreementDefaultCharge: number
  Title: Agreement Default Charge

  Read Only: true

  The amount charged to the partner when the partner contribution is closed.
• agreementDefaultChargeAccount: string
  Title: Agreement Default Charge Account

  Read Only: true

  Maximum Length: 255

  The account used to record the agreement default charge when closing a partner contribution.
• contributionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the partner contribution.
• contributionId: integer (int64)
  Title: Partner Contribution ID

  Read Only: true

  The unique identifier of the joint venture partner contribution.
• contributionReferenceId: integer (int64)
  Title: Contribution Reference ID

  Read Only: true

  The unique identifier of the partner contribution transaction reference.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the joint venture partner contribution was created.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the transaction reference for the partner contribution was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the transaction reference for partner contribution.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• partnerAccount: string
  Title: Joint Venture Partner Contribution Account

  Read Only: true

  Maximum Length: 255

  The combination of segment values for a joint venture partner contribution account.
• refundAmount: number
  Title: Refund Amount

  Read Only: true

  The amount to return to the partner when the partner contribution is closed.
• relatedContributionId: integer (int64)
  Title: Related Contribution ID

  Read Only: true

  The unique identifier of the partner contribution that the transaction was transferred from or transferred to.
• structureInstanceNumber: integer (int64)
  Title: Structure Instance Number

  Read Only: true

  The chart of accounts instance number associated with the joint venture's business unit.
• transactionAmount: number
  Title: Transaction Amount

  Read Only: true

  The amount to return to the partner when closing the partner contribution or the open amount to transfer to another partner contribution.
• transactionCurrencyCode: string
  Title: Transaction Currency

  Read Only: true

  Maximum Length: 15

  The currency code of the partner contribution transaction.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

  Default Value: 0

  The unique identifier of the transaction created to fund or close the partner contribution.
• transactionType: string
  Title: Transaction Type

  Read Only: true

  Maximum Length: 80

  The type of transaction used to open the partner contribution.

{
    "type":"object",
    "properties":{
        "contributionId":{
            "title":"Partner Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture partner contribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the transaction reference for partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The chart of accounts instance number associated with the joint venture's business unit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_StructureID":"partnerContributionAccount",
                "precision":"18",
                "dependencies":[
                    "coaInstanceNumberJV"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the transaction reference for the partner contribution was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDefaultCharge":{
            "title":"Agreement Default Charge",
            "type":"number",
            "description":"The amount charged to the partner when the partner contribution is closed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the partner contribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionReferenceId":{
            "title":"Contribution Reference ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution transaction reference.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "FND_ACFF_Conf.DFF_JV_JV_5FCONTRIBUTION_5FREFERENCES_5FDFF_JV_5FCONTRIBUTION_5FREFERENCES_5FDFF_JV_5FCONTRIBUTION_5FREFERENCES.ID":"DFF_JV_JV_5FCONTRIBUTION_5FREFERENCES_5FDFF_JV_5FCONTRIBUTION_5FREFERENCES_5FDFF_JV_5FCONTRIBUTION_5FREFERENCES"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture partner contribution was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the transaction created to fund or close the partner contribution.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "partnerAccount":{
            "title":"Joint Venture Partner Contribution Account",
            "maxLength":"255",
            "type":"string",
            "description":"The combination of segment values for a joint venture partner contribution account.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.AccountHeaderPCReferenceVO#partnerContributionAccount",
                "FND_ACFF_ResourceName":"contributionReferences",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "structureInstanceNumber"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "transactionType":{
            "title":"Transaction Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of transaction used to open the partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "agreementDefaultChargeAccount":{
            "title":"Agreement Default Charge Account",
            "maxLength":"255",
            "type":"string",
            "description":"The account used to record the agreement default charge when closing a partner contribution.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.AccountHeaderPCReferenceVO#agreementDefaultAccount",
                "FND_ACFF_ResourceName":"contributionReferences",
                "ojStructureInstanceNumber":"structureInstanceNumber",
                "dependencies":[
                    "agreementDefaultSin"
                ]
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the joint venture partner contribution.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionAmount":{
            "title":"Transaction Amount",
            "type":"number",
            "description":"The amount to return to the partner when closing the partner contribution or the open amount to transfer to another partner contribution.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionCurrencyCode":{
            "title":"Transaction Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code of the partner contribution 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"
            }
        },
        "relatedContributionId":{
            "title":"Related Contribution ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution that the transaction was transferred from or transferred to.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "refundAmount":{
            "title":"Refund Amount",
            "type":"number",
            "description":"The amount to return to the partner when the partner contribution is closed.",
            "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 : jointVentureAccountingHeaders-distributions-item-response

Type: object

Show Source

• 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.
• currencyCode: string
  Title: Currency

  Read Only: true

  Maximum Length: 15

  The currency of the distribution amount.
• distributedCreditAmount: number
  Title: Distributed Accounted Credit

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  The unique identifier of the joint venture distribution.
• distributionLineType: string
  Title: Distribution Line Type

  Read Only: true

  Maximum Length: 80

  The type of the distribution line for billing adjustments.
• expenditureType: string
  Title: Expenditure Type

  Read Only: true

  Maximum Length: 240

  The name identifying the expenditure classification.
• 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.
• lineDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 255

  The line description of the original transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• originalTransactionAccount: string
  Title: Original Transaction Account

  Read Only: true

  Maximum Length: 255

  The account combination assigned to the original transaction transferred to the internal stakeholder.
• ownershipDefinition: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition.
• percentageOfInterest: number
  Title: Ownership Percentage

  Read Only: true

  The percent 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.
• projectNumber: string
  Title: Project Number

  Read Only: true

  Maximum Length: 25

  The unique number of the project.
• task: string
  Title: Task Name

  Read Only: true

  Maximum Length: 255

  The name of the task.
• taskNumber: string
  Title: Task Number

  Read Only: true

  Maximum Length: 100

  The unique number of the task.
• transactionDate: string (date)
  Title: Transaction Date

  Read Only: true

  The date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date.
• transactionSource: string
  Title: Transaction Source

  Read Only: true

  Maximum Length: 255

  The source of the joint venture transaction that the distribution was created from.

{
    "type":"object",
    "properties":{
        "transactionSource":{
            "title":"Transaction Source",
            "maxLength":"255",
            "type":"string",
            "description":"The source of the joint venture transaction that the distribution was created from.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "applicationId",
                    "transactionSourceCodeJST"
                ]
            },
            "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
        },
        "lineDescription":{
            "title":"Transaction Description",
            "maxLength":"255",
            "type":"string",
            "description":"The line description of the original transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionLineType":{
            "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
        },
        "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
        },
        "projectNumber":{
            "title":"Project Number",
            "maxLength":"25",
            "type":"string",
            "description":"The unique number of the project.",
            "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
        },
        "distributedCreditAmount":{
            "title":"Distributed Accounted Credit",
            "type":"number",
            "description":"The distributed credit amount for the stakeholder in accounting currency.",
            "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 journal entry effective date or subledger accounting date.",
            "format":"date",
            "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
        },
        "distributedDebitAmount":{
            "title":"Distributed Accounted Debit",
            "type":"number",
            "description":"The distributed debit amount for the stakeholder in accounting currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinition":{
            "title":"Ownership Definition",
            "maxLength":"30",
            "type":"string",
            "description":"The name of the ownership definition.",
            "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
        },
        "task":{
            "title":"Task Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the task.",
            "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 percent of ownership a stakeholder has in a joint venture 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"
            }
        },
        "taskNumber":{
            "title":"Task Number",
            "maxLength":"100",
            "type":"string",
            "description":"The unique number of the task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency of the distribution amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "originalTransactionAccount":{
            "title":"Original Transaction Account",
            "maxLength":"255",
            "type":"string",
            "description":"The account combination assigned to the original transaction transferred to the internal stakeholder.",
            "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 : jointVentureAccountingHeaders-operationalMeasures-item-response

Type: object

Show Source

• accountingHeaderId: integer (int64)
  Title: Accounting Header ID

  Read Only: true

  The unique identifier of the accounting header.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the operational measure.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the operational measure was created.
• documentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  The unique document reference for the joint venture accounting transaction.
• jointVenture: string
  Title: Joint Venture

  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.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the operational measure was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the operational measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• measureDate: string (date)
  Title: Measure Date

  The date of the operational measure.
• measureLineNumber: integer (int32)
  Title: Line Number

  Read Only: true

  The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.
• measureLineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 80

  The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.
• measureStatus: string
  Title: Status

  The status of the operational measure for generating statistical journal entries.
• measureType: string
  Title: Measure Type

  The unique name of the measure type.
• measureTypeDescription: string
  Title: Measure Type Description

  Read Only: true

  Maximum Length: 240

  The description of the measure type.
• measureValue: number
  Title: Measure Value

  The value of the operational measure.
• measureValueType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 80

  The value type used to identify the operational measure value as a number or a percent.
• operationalMeasureId: integer (int64)
  Title: Operational Measure ID

  Read Only: true

  The unique identifier of the operational measure.
• primarySegment: string
  Title: Primary Segment

  Read Only: true

  Maximum Length: 255

  The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.
• reference: string
  Title: Reference

  Maximum Length: 64

  The reference associated with the operational measure.
• segmentValue: string
  Title: Primary Segment Value

  Maximum Length: 25

  A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
• segmentValueDescription: string
  Title: Primary Segment Value Description

  Read Only: true

  The description of the primary segment value.
• unitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 80

  The unit of measure for the operational measure value.

{
    "type":"object",
    "properties":{
        "operationalMeasureId":{
            "title":"Operational Measure ID",
            "type":"integer",
            "description":"The unique identifier of the operational measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the operational measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measureLineType":{
            "title":"Line Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "unitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"80",
            "type":"string",
            "description":"The unit of measure for the operational measure value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeUnitOfMeasure"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the operational measure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentNumber":{
            "title":"Document Number",
            "maxLength":"240",
            "type":"string",
            "description":"The unique document reference for the joint venture accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "primarySegment":{
            "title":"Primary Segment",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "segmentValue":{
            "title":"Primary Segment Value",
            "maxLength":"25",
            "type":"string",
            "description":"A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "measureStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the operational measure for generating statistical journal entries.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "measureLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the operational measure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "description":"The unique identifier of the accounting header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "measureDate":{
            "title":"Measure Date",
            "type":"string",
            "description":"The date of the operational measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "measureValueType":{
            "title":"Value Type",
            "maxLength":"80",
            "type":"string",
            "description":"The value type used to identify the operational measure value as a number or a percent.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeMeasureValueType"
                ]
            },
            "x-queryable":true
        },
        "reference":{
            "title":"Reference",
            "maxLength":"64",
            "type":"string",
            "description":"The reference associated with the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "measureValue":{
            "title":"Measure Value",
            "type":"number",
            "description":"The value of the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "segmentValueDescription":{
            "title":"Primary Segment Value Description",
            "type":"string",
            "description":"The description of the primary segment value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the operational measure.",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "measureTypeDescription":{
            "title":"Measure Type Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the measure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "measureType":{
            "title":"Measure Type",
            "type":"string",
            "description":"The unique name of the measure type.",
            "nullable":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"
    }
}

Back to Top

Examples

The following example shows how to retrieve all joint venture accounting headers 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/jointVentureAccountingHeaders"

Example Response Body

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

{
  "items": [
    {
      "accountingHeaderId": 100101431295249,
      "documentNumber": "COST_TRANSFER:ALBERTA:ALBERTA_1002:06-02-2023:06:11:33",
      "eventId": 2544960,
      "accountingDate": "2017-01-06",
      "accountingStatus": "Unprocessed",
      "accountingType": "Internal transfer",
      "jointVenture": "ALBERTA",
      "jointVentureDescription": "Alberta exploration project",
      "stakeholder": "ALBERTA_1002",
      "costCenter": "1002",
      "businessUnit": "HEPP Petroleum USA BU2",
      "ledger": "HEPPLedger US",
      "createdBy": "username",
      "creationDate": "2023-02-06T18:11:34.284+00:00",
      "lastUpdatedBy": "username",
      "lastUpdateDate": "2023-02-06T18:11:34.284+00:00",
      "agreement": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249",
          "name": "jointVentureAccountingHeaders",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249",
          "name": "jointVentureAccountingHeaders",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/accountingHeaderDFF",
          "name": "accountingHeaderDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/carriedInterestDistributions",
          "name": "carriedInterestDistributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/distributions",
          "name": "distributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/operationalMeasures",
          "name": "operationalMeasures",
          "kind": "collection"
        }
      ]
    },
    {
      "accountingHeaderId": 100101431295250,
      "documentNumber": "COST_TRANSFER:ALBERTA:ALBERTA_1003:06-02-2023:06:11:34",
      "eventId": 2544961,
      "accountingDate": "2017-01-06",
      "accountingStatus": "Unprocessed",
      "accountingType": "Internal transfer",
      "jointVenture": "ALBERTA",
      "jointVentureDescription": "Alberta exploration project",
      "stakeholder": "ALBERTA_1003",
      "costCenter": "1003",
      "businessUnit": "HEPP Petroleum USA BU2",
      "ledger": "HEPPLedger US",
      "createdBy": "username",
      "creationDate": "2023-02-06T18:11:34.543+00:00",
      "lastUpdatedBy": "username",
      "lastUpdateDate": "2023-02-06T18:11:34.543+00:00",
      "agreement": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250",
          "name": "jointVentureAccountingHeaders",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250",
          "name": "jointVentureAccountingHeaders",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250/child/accountingHeaderDFF",
          "name": "accountingHeaderDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250/child/carriedInterestDistributions",
          "name": "carriedInterestDistributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250/child/distributions",
          "name": "distributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295250/child/operationalMeasures",
          "name": "operationalMeasures",
          "kind": "collection"
        }
      ]
    },
    {
      "accountingHeaderId": 100101493920996,
      "documentNumber": "REVENUE_TRANSFER:VENUSWORKS:CORNHUSKER:14-02-2023:09:04:46",
      "eventId": 2667478,
      "accountingDate": "2017-01-31",
      "accountingStatus": "Final Accounted",
      "accountingType": "Internal transfer",
      "jointVenture": "VENUSWORKS",
      "jointVentureDescription": "JOINT VENTURE VENUSWORKS",
      "stakeholder": "SEVENCORPORATION",
      "costCenter": "3006",
      "businessUnit": "HEPP Petroleum USA BU1",
      "ledger": "HEPPLedger US",
      "createdBy": "username",
      "creationDate": "2023-02-14T21:04:46.904+00:00",
      "lastUpdatedBy": "username",
      "lastUpdateDate": "2023-02-14T21:53:04.970+00:00",
      "agreement": null,
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996",
          "name": "jointVentureAccountingHeaders",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996",
          "name": "jointVentureAccountingHeaders",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996/child/accountingHeaderDFF",
          "name": "accountingHeaderDFF",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996/child/carriedInterestDistributions",
          "name": "carriedInterestDistributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996/child/distributions",
          "name": "distributions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101493920996/child/operationalMeasures",
          "name": "operationalMeasures",
          "kind": "collection"
        }
      ]
    },
  ],
  "count": 3,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders",
      "name": "jointVentureAccountingHeaders",
      "kind": "collection"
    }
  ]
}

Back to Top