Create an accounting rule
post
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
AccountingEventId: string
Title:
Accounting Event
Maximum Length:30
The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required. -
AccountingRuleGroup: string
Title:
Accounting Rule Group
Maximum Length:50
The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group. -
AccountingRuleId: string
Title:
Accounting Rule
Maximum Length:50
The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login. -
CompleteFlag: boolean
Title:
Valid
Maximum Length:1
Default Value:false
Indicates whether the rule is complete and valid for processing. The default value is false. -
EffectiveEndDate: string
(date)
Title:
End Date
The last day that the rule may be used. -
EffectiveStartDate: string
(date)
Title:
Start Date
The first day that the rule may be used. -
LedgerId: string
Title:
Ledger
Maximum Length:30
The unique identifier of the ledger that the rule is associated with. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action. -
RuleClassification: string
Title:
Event Type
Maximum Length:50
Indicates the accounting rule classification. -
RuleDescription: string
Title:
Description
Maximum Length:240
The description of the rule.
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.
Root Schema : publicSectorAccountingRules-item-response
Type:
Show Source
object
-
AccountingEventId: string
Title:
Accounting Event
Maximum Length:30
The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required. -
AccountingRuleGroup: string
Title:
Accounting Rule Group
Maximum Length:50
The group, if any, that this rule belongs to. When multiple accounting rules are assigned the same group, transactions meeting the selection criteria are processed by each rule in the group. -
AccountingRuleId: string
Title:
Accounting Rule
Maximum Length:50
The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction. Value is mandatory and is defined by the user during a create action. -
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the agency associated with the accounting rule. Value is mandatory and is set programmatically based on the user's login. -
CompleteFlag: boolean
Title:
Valid
Maximum Length:1
Default Value:false
Indicates whether the rule is complete and valid for processing. The default value is false. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the accounting rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time that the accounting rule was created. -
EffectiveEndDate: string
(date)
Title:
End Date
The last day that the rule may be used. -
EffectiveStartDate: string
(date)
Title:
Start Date
The first day that the rule may be used. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time that the accounting rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the accounting rule. -
LedgerId: string
Title:
Ledger
Maximum Length:30
The unique identifier of the ledger that the rule is associated with. Identifies the accounting treatment of the journals associated with the ledger. Value is mandatory and is defined by the user during a create action. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RuleClassification: string
Title:
Event Type
Maximum Length:50
Indicates the accounting rule classification. -
RuleDescription: string
Title:
Description
Maximum Length:240
The description of the rule.
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.
Links
- validateAccountingRule
-
Parameters:
- publicSectorAccountingRulesUniqID:
$request.path.publicSectorAccountingRulesUniqID
Validate that the accounting rule has proper criteria specified and its distributions on both debit and credit sides are adding up to 100%. - publicSectorAccountingRulesUniqID: