Jump to

• Request
• Response
• Examples

Get all joint venture source transactions

get

/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions

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 source transaction that matches the primary key criteria specified.
    Finder Variables
    • transactionId; integer; The unique identifier of the joint venture source transaction.
  • transactionFinder Finds all joint venture source transactions that match the specified search criteria.
    Finder Variables
    • jointVenture; string; The unique name of the joint venture.
    • jointVentureDescription; string; The description of the joint venture.
    • journalDescription; string; A description that's passed into the joint venture invoice for the joint venture source transaction.
    • ledger; string; The name of the ledger; string; .
    • method; string; The unique name of the overhead method; string; .
    • methodDescription; string; The description of the overhead method; string; .
    • searchAllText; string; A search value to identify joint venture source transactions that contain the specified text in any of the string attributes.
    • transactionStatus; string; The status of the joint venture source transaction.
    • transactionType; string; The type of the joint venture source transaction.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • account; string; The account assigned to a partner's account in the receivables invoice.
  • createdBy; string; The user who created the joint venture source transaction.
  • creationDate; string; The date and time when the joint venture source transaction was created.
  • creditAmount; number; The credit amount of the joint venture source transaction.
  • currencyCode; string; The currency of the transaction amount.
  • debitAmount; number; The debit amount of the joint venture source transaction.
  • headerId; integer; The unique identifier for the joint venture source transaction header.
  • jointVenture; string; The unique name of the joint venture.
  • jointVentureDescription; string; The description of the joint venture.
  • journalDescription; string; A description that's passed into the joint venture invoice for the joint venture source transaction.
  • lastUpdateDate; string; The date and time when the joint venture source transaction was last updated.
  • lastUpdatedBy; string; The user who last updated the joint venture source transaction.
  • ledger; string; The name of the ledger.
  • lineNumber; integer; The accounting line for the joint venture source transaction.
  • method; string; The unique name of the overhead method.
  • methodDescription; string; The description of the overhead method.
  • transactionDate; string; The date when the joint venture source transaction occurred.
  • transactionId; integer; The unique identifier of the joint venture source transaction.
  • transactionStatus; string; The status of the joint venture source transaction.
  • transactionType; string; The type of the joint venture source transaction.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : jointVentureSourceTransactions

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureSourceTransactions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureSourceTransactions-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 : jointVentureSourceTransactions-item-response

Type: object

Show Source

• account: string
  Title: Partner Account

  Read Only: true

  The account assigned to a partner's account in the receivables invoice.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the joint venture source transaction was created.
• creditAmount: number
  Title: Credit

  Read Only: true

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

  Read Only: true

  Maximum Length: 15

  The currency of the transaction amount.
• debitAmount: number
  Title: Debit

  Read Only: true

  The debit amount of the joint venture source transaction.
• headerId: integer (int64)
  Title: Header ID

  Read Only: true

  The unique identifier for the joint venture source transaction header.
• jointVenture: string
  Title: Joint Venture

  Read Only: true

  Maximum Length: 30

  The unique name of the joint venture.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• journalDescription: string
  Title: Transaction Description

  Read Only: true

  Maximum Length: 240

  A description that's passed into the joint venture invoice for the joint venture source transaction.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the joint venture source transaction.
• ledger: string
  Title: Ledger Name

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The accounting line for the joint venture source transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• method: string
  Title: Overhead Method

  Read Only: true

  Maximum Length: 30

  The unique name of the overhead method.
• methodDescription: string
  Title: Method Description

  Read Only: true

  Maximum Length: 240

  The description of the overhead method.
• sourceTransactionDFF: array sourceTransactionDFF
• transactionDate: string (date)
  Title: Transaction Date

  The date when the joint venture source transaction occurred.
• transactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

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

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

  Read Only: true

  Maximum Length: 80

  The type of the joint venture source transaction.

{
    "type":"object",
    "properties":{
        "ledger":{
            "title":"Ledger Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ledger.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "sourceTransactionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureSourceTransactions-sourceTransactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the joint venture source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "methodDescription":{
            "title":"Method Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "method":{
            "title":"Overhead Method",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the overhead method.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the joint venture source transaction.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the joint venture source transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "debitAmount":{
            "title":"Debit",
            "type":"number",
            "description":"The debit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the joint venture source transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "transactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the joint venture source transaction occurred.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "transactionId":{
            "title":"Transaction ID",
            "type":"integer",
            "description":"The unique identifier of the joint venture source transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "headerId":{
            "title":"Header ID",
            "type":"integer",
            "description":"The unique identifier for the joint venture source transaction header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "transactionType":{
            "title":"Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of the joint venture source transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "journalDescription":{
            "title":"Transaction Description",
            "maxLength":240,
            "type":"string",
            "description":"A description that's passed into the joint venture invoice for the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the joint venture source transaction.",
            "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"
            }
        },
        "lineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The accounting line for the joint venture source transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "creditAmount":{
            "title":"Credit",
            "type":"number",
            "description":"The credit amount of the joint venture source transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency of the transaction amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "account":{
            "title":"Partner Account",
            "type":"string",
            "description":"The account assigned to a partner's account in the receivables invoice.",
            "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 : sourceTransactionDFF

Type: array

Show Source

• Array of: object jointVentureSourceTransactions-sourceTransactionDFF-item-response

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

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

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

Nested Schema : properties

Type: object

Show Source

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

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

Nested Schema : jointVentureSourceTransactions-sourceTransactionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TransactionId: integer (int64)
  Title: Transaction ID

  Read Only: true

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Back to Top

Examples

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

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

Response Body Example

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

{
    "items": [
        {
            "transactionId": 100100266251970,
            "headerId": 100100266251969,
            "lineNumber": 1,
            "transactionStatus": "Available to process",
            "transactionDate": "2017-01-01",
            "transactionType": "Overhead",
            "jointVenture": "APOLLOGLOBAL",
            "jointVentureDescription": "Oklahoma panhandle project",
            "method": "OH_APOLLOGLOBAL1805210359",
            "methodDescription": "Overhead for APOLLOGLOBAL",
            "journalDescription": "OH_BA1805210359",
            "ledger": "HEPPLedger US",
            "debitAmount": 1200,
            "creditAmount": null,
            "currencyCode": "USD",
            "account": "11-1001-11010-11-0001",
            "createdBy": "username",
            "creationDate": "2021-05-18T11:16:34+00:00",
            "lastUpdatedBy": "username",
            "lastUpdateDate": "2021-05-20T05:17:26.669+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970",
                    "name": "jointVentureSourceTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970",
                    "name": "jointVentureSourceTransactions",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions/100100266251970/child/sourceTransactionDFF",
                    "name": "sourceTransactionDFF",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureSourceTransactions",
            "name": "jointVentureSourceTransactions",
            "kind": "collection"
        }
    ]
}

Back to Top