Create a subledger accounting account rule
post
/fscmRestApi/resources/11.13.18.05/accountingSetupAccountRules
Request
Header Parameters
-
Metadata-Context: string
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: string
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: string
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-
AccountingCOAId: integer
(int64)
Title:
Chart of AccountsIdentifier of the chart of accounts used for accounting. -
ApplicationId(required): integer
(int64)
Title:
Subledger ApplicationUnique identifier of the application. -
Description: string
Title:
DescriptionMaximum Length:240Description of the subledger accounting account rule. -
EnabledFlag: boolean
Title:
StatusMaximum Length:1Default Value:trueIndicates whether the subledger accounting account rule is enabled. If true, the rule is active. If false, the rule is inactive. -
FlexfieldAssignModeCode: string
Title:
Rule TypeMaximum Length:1Default Value:ACode that identifies how the flexfield value is assigned. -
FlexfieldSegmentCode: string
Maximum Length:
30Code that identifies the flexfield segment. -
FlexValueSetId: integer
(int64)
Identifier of the flexfield value set used by the rule.
-
Name(required): string
Title:
NameMaximum Length:80Name of the subledger accounting account rule. -
SegmentRuleCode(required): string
Title:
Short NameMaximum Length:30Code that uniquely identifies the subledger accounting account rule. -
SegmentRuleId: integer
(int64)
Unique identifier of the subledger accounting account rule.
-
SegmentRuleTypeCode: string
Title:
Created ByMaximum Length:1Type that categorizes the subledger accounting account rule. -
TransactionCOAId: integer
(int64)
Identifier of the transaction chart of accounts.
-
XlaAcctgAccountRuleDetail: array
Subledger Accounting Account Rule Details
Title:
Subledger Accounting Account Rule DetailsSubledger accounting account rule details identify the sequence and sources used to derive each segment value within an account rule. Each detail defines a step in forming the final account combination.
Nested Schema : Subledger Accounting Account Rule Details
Type:
arrayTitle:
Subledger Accounting Account Rule DetailsSubledger accounting account rule details identify the sequence and sources used to derive each segment value within an account rule. Each detail defines a step in forming the final account combination.
Show Source
Nested Schema : accountingSetupAccountRules-XlaAcctgAccountRuleDetail-item-post-request
Type:
Show Source
object-
InputSourceApplicationId: integer
(int64)
Identifier of the application for the input source.
-
InputSourceCode: string
Maximum Length:
30Code that identifies the input source. -
InputSourceTypeCode: string
Maximum Length:
1Type that categorizes the input source. -
SegmentRuleDetailId: integer
(int64)
Unique identifier of the subledger accounting account rule detail.
-
SegmentRuleSequence: integer
(int64)
Default Value:
1Sequence number that determines the evaluation order for the account rule detail. -
ValueCodeCombinationId: integer
(int64)
Identifier of the code combination used to derive the segment value.
-
ValueConstant: string
Maximum Length:
240Constant value assigned to the segment. -
ValueFlexfieldSegmentCode: string
Maximum Length:
30Flexfield segment code used to derive the segment value. -
ValueMappingSetCode: string
Maximum Length:
30Mapping set code used to derive the segment value. -
ValueSegmentRuleApplId: integer
(int64)
Application identifier of the referenced segment rule.
-
ValueSegmentRuleCode: string
Maximum Length:
30Code that identifies the referenced segment rule. -
ValueSegmentRuleTypeCode: string
Maximum Length:
30Type that categorizes the referenced segment rule. -
ValueSourceApplicationId: integer
(int64)
Identifier of the application for the value source.
-
ValueSourceCode: string
Maximum Length:
30Code that identifies the value source. -
ValueSourceOriginCode: string
Maximum Length:
1Code that identifies the origin of the value source. -
ValueSourceTypeCode: string
Maximum Length:
1Type that categorizes the value source. -
ValueTypeCode: string
Title:
Value TypeMaximum Length:1Type that identifies how the segment value is derived.
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 : accountingSetupAccountRules-item-response
Type:
Show Source
object-
AccountingCOAId: integer
(int64)
Title:
Chart of AccountsIdentifier of the chart of accounts used for accounting. -
ApplicationId: integer
(int64)
Title:
Subledger ApplicationUnique identifier of the application. -
Description: string
Title:
DescriptionMaximum Length:240Description of the subledger accounting account rule. -
EnabledFlag: boolean
Title:
StatusMaximum Length:1Default Value:trueIndicates whether the subledger accounting account rule is enabled. If true, the rule is active. If false, the rule is inactive. -
FlexfieldAssignModeCode: string
Title:
Rule TypeMaximum Length:1Default Value:ACode that identifies how the flexfield value is assigned. -
FlexfieldSegmentCode: string
Maximum Length:
30Code that identifies the flexfield segment. -
FlexValueSetId: integer
(int64)
Identifier of the flexfield value set used by the rule.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:80Name of the subledger accounting account rule. -
SegmentRuleCode: string
Title:
Short NameMaximum Length:30Code that uniquely identifies the subledger accounting account rule. -
SegmentRuleId: integer
(int64)
Unique identifier of the subledger accounting account rule.
-
SegmentRuleTypeCode: string
Title:
Created ByMaximum Length:1Type that categorizes the subledger accounting account rule. -
TransactionCOAId: integer
(int64)
Identifier of the transaction chart of accounts.
-
XlaAcctgAccountRuleDetail: array
Subledger Accounting Account Rule Details
Title:
Subledger Accounting Account Rule DetailsSubledger accounting account rule details identify the sequence and sources used to derive each segment value within an account rule. Each detail defines a step in forming the final account combination.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Subledger Accounting Account Rule Details
Type:
arrayTitle:
Subledger Accounting Account Rule DetailsSubledger accounting account rule details identify the sequence and sources used to derive each segment value within an account rule. Each detail defines a step in forming the final account combination.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : accountingSetupAccountRules-XlaAcctgAccountRuleDetail-item-response
Type:
Show Source
object-
InputSourceApplicationId: integer
(int64)
Identifier of the application for the input source.
-
InputSourceCode: string
Maximum Length:
30Code that identifies the input source. -
InputSourceTypeCode: string
Maximum Length:
1Type that categorizes the input source. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SegmentRuleDetailId: integer
(int64)
Unique identifier of the subledger accounting account rule detail.
-
SegmentRuleSequence: integer
(int64)
Default Value:
1Sequence number that determines the evaluation order for the account rule detail. -
ValueCodeCombinationId: integer
(int64)
Identifier of the code combination used to derive the segment value.
-
ValueConstant: string
Maximum Length:
240Constant value assigned to the segment. -
ValueFlexfieldSegmentCode: string
Maximum Length:
30Flexfield segment code used to derive the segment value. -
ValueMappingSetCode: string
Maximum Length:
30Mapping set code used to derive the segment value. -
ValueSegmentRuleApplId: integer
(int64)
Application identifier of the referenced segment rule.
-
ValueSegmentRuleCode: string
Maximum Length:
30Code that identifies the referenced segment rule. -
ValueSegmentRuleTypeCode: string
Maximum Length:
30Type that categorizes the referenced segment rule. -
ValueSourceApplicationId: integer
(int64)
Identifier of the application for the value source.
-
ValueSourceCode: string
Maximum Length:
30Code that identifies the value source. -
ValueSourceOriginCode: string
Maximum Length:
1Code that identifies the origin of the value source. -
ValueSourceTypeCode: string
Maximum Length:
1Type that categorizes the value source. -
ValueTypeCode: string
Title:
Value TypeMaximum Length:1Type that identifies how the segment value is derived.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- XlaAcctgAccountRuleDetail
-
Parameters:
- SegmentRuleId:
$request.path.SegmentRuleId
Subledger accounting account rule details identify the sequence and sources used to derive each segment value within an account rule. Each detail defines a step in forming the final account combination. - SegmentRuleId: