Get all accounting rules
get
/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRules
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
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 an accounting rule with the specified primary key criteria.
Finder Variables:- AccountingRuleId; string; The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction.
- AgencyId; integer; The unique identifier of the agency associated with the accounting rule.
- EffectiveEndDate; string; The last day that the rule may be used.
- EffectiveStartDate; string; The first day that the rule may be used.
- RuleFinder: Finds an accounting rule with the specified criteria.
Finder Variables:- AccountingRuleId; string; The unique identifier of the accounting rule. Describes how accounting journal entries are to be created for a specific type of transaction.
- AgencyId; integer; The unique identifier of the agency associated with the accounting rule.
- SysEffectiveDate; object.
- simpleSearchFinder: Finds an accounting rule with the specified criteria.
Finder Variables:- value; string; The unique identifier of the accounting rule. Describes how accounting journal entries are created for a specific type of transaction.
- PrimaryKey: Finds an accounting rule with the specified primary key criteria.
-
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:- AccountingEventId; string; The unique identifier of the accounting event. Identifies a specific type of transaction for which accounting journals are required.
- AccountingRuleGroup; string; 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; 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; 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; Indicates whether the rule is complete and valid for processing. The default value is false.
- CreatedBy; string; The user who created the accounting rule.
- CreationDate; string; The date and time that the accounting rule was created.
- EffectiveEndDate; string; The last day that the rule may be used.
- EffectiveStartDate; string; The first day that the rule may be used.
- LastUpdateDate; string; The date and time that the accounting rule was last updated.
- LastUpdatedBy; string; The user who last updated the accounting rule.
- LedgerId; string; 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; Indicates the accounting rule classification.
- RuleDescription; string; The description of the rule.
-
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
-
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.