Create a joint venture account set
post
/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
accountSet: string
Title:
Account Set
Maximum Length:30
The unique name of the account set. -
accountSetAssociationsExistFlag: boolean
Title:
Account Set Associations Exist
Indicates that this account set is associated with an overhead method. -
accountSetDescription: string
Title:
Description
Maximum Length:240
The description of the account set. -
accountSetDFF: array
accountSetDFF
-
accountSetLedger: string
Title:
Ledger
The name of the ledger associated with the account set. -
accountSetStatus: string
Title:
Status
The status of the account set. -
filterSetFilters: array
Filter Sets and Filters
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set. -
filterSets: array
Filter Sets
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. -
includePrimarySegmentValuesFlag: boolean
Title:
Include Primary Segment Values
Maximum Length:1
Indicates that primary segment values of the associated joint venture are included in the filter. -
jointVenture: string
Title:
Joint Venture
The name of the joint venture. -
useJointVentureLedgerFlag: boolean
Title:
Use Joint Venture Ledger
Maximum Length:1
Indicates that the ledger associated with the joint venture will be used for this account set. -
validatePrimarySegmentValuesFlag: boolean
Title:
Validate Primary Segment Values
Maximum Length:1
Indicates that primary segment values used in the filter must be assigned to the joint venture associated with the account set when the option to use the joint venture ledger is selected.
Nested Schema : Filter Sets and Filters
Type:
array
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set.
Show Source
Nested Schema : Filter Sets
Type:
array
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountSetId: integer
(int64)
Title:
Account Set ID
Nested Schema : jointVentureAccountSets-filterSets-item-post-request
Type:
Show Source
object
-
filters: array
Filters
Title:
Filters
The filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management. -
filterSet: string
Title:
Filter Set
Maximum Length:30
The unique name of the filter set. -
filterSetDescription: string
Title:
Description
Maximum Length:240
The description of the filter set. -
filterSetDFF: array
filterSetDFF
Nested Schema : Filters
Type:
array
Title:
Filters
The filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
filterDFF: array
filterDFF
-
highValue: string
Title:
High Value
Maximum Length:25
The high value of the filter. -
lowValue: string
Title:
Low Value
Maximum Length:25
The low value of the filter. -
operator: string
Title:
Operator
The operator of the filter. -
segment: string
Title:
Segment
The segment name of the filter.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountFilterId: integer
(int64)
Title:
Filter ID
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountFilterSetId: integer
(int64)
Title:
Filter Set ID
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.
Root Schema : jointVentureAccountSets-item-response
Type:
Show Source
object
-
accountSet: string
Title:
Account Set
Maximum Length:30
The unique name of the account set. -
accountSetAssociationsExistFlag: boolean
Title:
Account Set Associations Exist
Indicates that this account set is associated with an overhead method. -
accountSetDescription: string
Title:
Description
Maximum Length:240
The description of the account set. -
accountSetDFF: array
accountSetDFF
-
accountSetId: integer
(int64)
Title:
Account Set ID
Read Only:true
The unique identifier of the account set. -
accountSetLedger: string
Title:
Ledger
The name of the ledger associated with the account set. -
accountSetStatus: string
Title:
Status
The status of the account set. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the account set. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the account set was created. -
filterSetFilters: array
Filter Sets and Filters
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set. -
filterSets: array
Filter Sets
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. -
includePrimarySegmentValuesFlag: boolean
Title:
Include Primary Segment Values
Maximum Length:1
Indicates that primary segment values of the associated joint venture are included in the filter. -
jointVenture: string
Title:
Joint Venture
The name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
The description of the joint venture. -
jointVentureLedger: string
Title:
Default Ledger
Read Only:true
The name of the default primary ledger associated with the business unit assigned to the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the account set was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the account set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
structureInstanceNumber: integer
Title:
Structure Instance Number
Read Only:true
Chart of accounts structure instance number used to associate primary segment values to the joint venture and identify distributable code combinations for GL and subledger accounting transactions. -
useJointVentureLedgerFlag: boolean
Title:
Use Joint Venture Ledger
Maximum Length:1
Indicates that the ledger associated with the joint venture will be used for this account set. -
validatePrimarySegmentValuesFlag: boolean
Title:
Validate Primary Segment Values
Maximum Length:1
Indicates that primary segment values used in the filter must be assigned to the joint venture associated with the account set when the option to use the joint venture ledger is selected.
Nested Schema : Filter Sets and Filters
Type:
array
Title:
Filter Sets and Filters
The filter sets and filters resource is used to view filter sets and their filters for a project set.
Show Source
Nested Schema : Filter Sets
Type:
array
Title:
Filter Sets
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-accountSetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountSetId: integer
(int64)
Title:
Account Set ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : jointVentureAccountSets-filterSetFilters-item-response
Type:
Show Source
object
-
description: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the filter set. -
filterCreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
filterCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterId: integer
(int64)
Title:
Filter ID
Read Only:true
The unique identifier of the filter. -
filterLastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
filterLastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
filterSet: string
Title:
Filter Set
Read Only:true
Maximum Length:30
The unique name of the filter set. -
filterSetCreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
filterSetCreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
filterSetId: integer
(int64)
Title:
Filter Set ID
Read Only:true
The unique identifier of the filter set. -
filterSetLastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
filterSetLastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
highValue: string
Title:
High Value
Read Only:true
Maximum Length:25
The high value of the filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowValue: string
Title:
Low Value
Read Only:true
Maximum Length:25
The low value of the filter. -
operator: string
Title:
Operator
Read Only:true
Maximum Length:80
The operator of the filter. -
segment: string
Title:
Segment
Read Only:true
The segment name of the filter.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the filter set. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the filter set was created. -
filters: array
Filters
Title:
Filters
The filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management. -
filterSet: string
Title:
Filter Set
Maximum Length:30
The unique name of the filter set. -
filterSetDescription: string
Title:
Description
Maximum Length:240
The description of the filter set. -
filterSetDFF: array
filterSetDFF
-
filterSetId: integer
(int64)
Title:
Filter Set ID
Read Only:true
The unique identifier of the filter set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the filter set was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the filter set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Filters
Type:
array
Title:
Filters
The filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filters-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the filter. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the filter was created. -
filterDFF: array
filterDFF
-
filterId: integer
(int64)
Title:
Filter ID
Read Only:true
The unique identifier of the filter. -
highValue: string
Title:
High Value
Maximum Length:25
The high value of the filter. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the filter was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the filter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lowValue: string
Title:
Low Value
Maximum Length:25
The low value of the filter. -
operator: string
Title:
Operator
The operator of the filter. -
segment: string
Title:
Segment
The segment name of the filter.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filters-filterDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountFilterId: integer
(int64)
Title:
Filter ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filterSetDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
AccountFilterSetId: integer
(int64)
Title:
Filter Set ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- accountSetDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFFParameters:
- accountSetId:
$request.path.accountSetId
- accountSetId:
- filterSetFilters
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSetFiltersParameters:
- accountSetId:
$request.path.accountSetId
The filter sets and filters resource is used to view filter sets and their filters for a project set. - accountSetId:
- filterSets
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSetsParameters:
- accountSetId:
$request.path.accountSetId
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. - accountSetId:
Examples
The following example shows how to create a joint venture account set by submitting a POST request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X POST -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets"
Example Request Body
The following example shows the contents of the request body in JSON format:
{ "accountSet":"UTILITYEXPENSE", "accountSetDescription":"Account set for utility expenses", "accountSetStatus":"Editing", "jointVenture":"APOLLOBASIN", "useJointVentureLedgerFlag":true, "validatePrimarySegmentValuesFlag":true, "includePrimarySegmentValuesFlag":true, "accountSetLedger":null }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "accountSetId":300100549178645, "accountSet":"UTILITYEXPENSE", "accountSetDescription":"Account set for utility expenses", "accountSetStatus":"Editing", "jointVenture":"APOLLOBASIN", "jointVentureDescription":"Oklahoma panhandle project", "jointVentureLedger":"HEPPLedger US", "accountSetLedger":null, "structureInstanceNumber":46521, "useJointVentureLedgerFlag":true, "validatePrimarySegmentValuesFlag":true, "includePrimarySegmentValuesFlag":true, "accountSetAssociationsExistFlag":false, "createdBy":"username", "creationDate":"2021-12-02T06:54:48+00:00", "lastUpdatedBy":"username", "lastUpdateDate":"2021-12-02T06:54:48.029+00:00", "links":[ { "rel":"self", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549178645", "name":"jointVentureAccountSets", "kind":"item", "properties":{ "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel":"canonical", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549178645", "name":"jointVentureAccountSets", "kind":"item" }, { "rel":"child", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549178645/child/accountSetDFF", "name":"accountSetDFF", "kind":"collection" }, { "rel":"child", "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549178645/child/filterSets", "name":"filterSets", "kind":"collection" } ] }