1. REST API for Oracle Public Sector Compliance and Regulation Cloud
  2. Tasks
  3. Accounting Rule Lines

Get all accounting rule lines

get

/fscmRestApi/resources/11.13.18.05/publicSectorAccountingRuleLines

Request

Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
  • 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:

    • simpleSearchFinder: Finds an accounting rule line with the specified line number or account identifier. Finder Variables:
      • value; string; The unique identifier of an accounting rule line. Identifies a debit or credit distribution line associated with the rule.
    • PrimaryKey: Finds an accounting rule line 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 line.
      • EffectiveEndDate; string; The last day that the rule line may be used.
      • EffectiveStartDate; string; The first day that the rule line may be used.
      • LineNumber; integer; The unique identifier of an accounting rule line. Identifies a debit or credit distribution line associated with a rule.
  • 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.
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified attributes. 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
  • 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
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorAccountingRuleLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : publicSectorAccountingRuleLines-item
Type: object
Show Source
  • Title: Account
    Maximum Length: 30
    The type of economic activity for an accounting transaction line. Value is mandatory and is defined by the user during a create action.
  • Title: Accounting Rule
    Maximum Length: 50
    The unique identifier of the accounting rule. Describes how accounting journal entries are created for a specific type of transaction. Value is mandatory and is defined by the user during a create action.
  • Title: Agency ID
    The unique identifier of the agency associated with the accounting rule line. Value is mandatory and is set programmatically based on the user's login.
  • Title: Created By
    Maximum Length: 64
    The user who created the accounting rule line.
  • Title: Creation Date
    The date and time that the accounting rule line was created.
  • Title: Debit or Credit
    Maximum Length: 1
    Identifies a line as a debit or a credit distribution. The value is defined by lookup type ORA_PSC_CC_DR_CR.
  • Title: Department
    Maximum Length: 30
    The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and is defined by the user during a create action.
  • Title: Division
    Maximum Length: 30
    The sub-grouping within a department for an accounting transaction line. Value is optional and is defined by the user during a create action.
  • Title: End Date
    The last day that the rule may be used.
  • Title: Start Date
    The first day that the rule may be used.
  • Title: Function
    Maximum Length: 30
    The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.
  • Title: Fund
    Maximum Length: 30
    The source or target of funding for an accounting transaction line. Value is mandatory and is defined by the user during a create action.
  • Title: Last Updated Date
    The date and time that the accounting rule line was last updated.
  • Title: Last Updated By
    Maximum Length: 64
    The user who last updated the accounting rule line.
  • Title: Line Number
    The unique identifier of an accounting rule line. Identifies a debit or credit distribution line associated with a rule.
  • Items
  • Maximum Length: 80
    The meaning for a debit or credit value.
  • Title: Percent
    The proportion of the transaction amount allocated to the distribution line.
  • Title: Program
    Maximum Length: 30
    A set of activities performed by an agency to accomplish a specific goal that is associated with an accounting transaction line. Value is optional and is defined by the user during a create action.
  • Title: Rounding Adjustment
    Maximum Length: 1
    Indicates whether the distribution line is used for any rounding adjustment required. Valid values are Y (line can contain a rounding adjustment) and N (line will not contain a rounding adjustment). Default value is N.
Back to Top