Jump to

• Request
• Response
• Examples

Get all joint venture distributions for the joint venture journal

get

/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/{accountingHeaderId}/child/distributions

Request

Path Parameters

• accountingHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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.
• 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:
  

  • createdBy; string; The user who created the joint venture distribution.
  • creationDate; string; The date and time when the joint venture distribution was created.
  • currencyCode; string; The currency of the distribution amount.
  • distributedCreditAmount; number; The distributed credit amount for the stakeholder in accounting currency.
  • distributedDebitAmount; number; The distributed debit amount for the stakeholder in accounting currency.
  • distributionId; integer; The unique identifier of the joint venture distribution.
  • distributionLineType; string; The type of the distribution line for billing adjustments.
  • expenditureType; string; The name identifying the expenditure classification.
  • 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.
  • lineDescription; string; The line description of the original transaction.
  • originalTransactionAccount; string; The account combination assigned to the original transaction transferred to the internal stakeholder.
  • ownershipDefinition; string; The name of the ownership definition.
  • percentageOfInterest; number; The percent of ownership a stakeholder has in a joint venture transaction.
  • project; string; The name of the project.
  • projectNumber; string; The unique number of the project.
  • task; string; The name of the task.
  • taskNumber; string; The unique number of the task.
  • transactionDate; string; The date when the transaction occurred, which may be different from the journal entry effective date or subledger accounting date.
  • transactionSource; string; The source of the joint venture transaction that the distribution was created from.
• 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-distributions

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-distributions-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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 : 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 : 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 joint venture distributions for the joint venture journal 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/100101431295249/child/distributions" 

Example Response Body

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

{
  "items": [
    {
      "distributionId": 100101431295230,
      "currencyCode": "USD",
      "distributedCreditAmount": null,
      "distributedDebitAmount": 6995,
      "distributionLineType": "Original",
      "lineDescription": null,
      "transactionSource": "Subledger",
      "ownershipDefinition": "ALBERTA",
      "percentageOfInterest": 13.99,
      "transactionDate": "2017-01-06",
      "project": "HEPP US Project2",
      "projectNumber": "HEPP US Project2",
      "task": "Production Well Testing",
      "taskNumber": "2",
      "expenditureType": "Car Rental",
      "originalTransactionAccount": "11-1005-11010-11-0001",
      "createdBy": "username",
      "creationDate": "2023-02-06T18:04:18+00:00",
      "lastUpdatedBy": "username",
      "lastUpdateDate": "2023-02-06T18:11:34.343+00:00",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/distributions/100101431295230",
          "name": "distributions",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/distributions/100101431295230",
          "name": "distributions",
          "kind": "item"
        },
        {
          "rel": "parent",
          "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249",
          "name": "jointVentureAccountingHeaders",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountingHeaders/100101431295249/child/distributions",
      "name": "distributions",
      "kind": "collection"
    }
  ]
}

Back to Top