Get all journal lines
get
/fscmRestApi/resources/11.13.18.05/publicSectorJournalLineDetails
Request
Query Parameters
-
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 the journal line that matches the primary key criteria specified.
Finder Variables:- JeLineId; integer; The unique identifier of the journal line.
- simpleSearchFinder: Find the journal line with the specified accounting event ID, accounting rule ID, accounting rule group ID, or batch request ID.
Finder Variables:- value; string; The accounting event ID, accounting rule ID, accounting rule group ID, or batch request ID.
- PrimaryKey: Finds the journal line that matches the primary key criteria specified.
-
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:- AccountId; string; The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
- AccountedCr; number; Entered credit amount stated in the base currency of the ledger. Currently equal to entered credit amount.
- AccountedDr; number; Entered debit amount stated in the base currency of the ledger. Currently equal to entered debit amount.
- AccountingDate; string; The date the associated accounting transaction took place. Normally inherited from the transaction, but can be modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.
- AccountingEventId; string; The unique identifier of the accounting event associated with the journal. Identifies a specific type of transaction for which accounting journals are required. Mandatory system-maintained value.
- AccountingRuleId; string; The unique identifier of the accounting rule associated with the journal. Describes how accounting journal entries are to be created for a specific type of transaction. Mandatory system-maintained value.
- AgencyId; integer; The unique identifier of the agency associated with the journal. Value is mandatory and is set programmatically based on the user's login.
- BaseCurrency; string; The currency that the accounted debit or accounted credit amount is stated in. Value is mandatory and is inherited from the ledger associated with the journal.
- BatchRequestId; string; Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process.
- CurrencyCode; string; The currency that the entered debit or entered credit amount is stated in. Value is mandatory and is inherited from the accounting transaction.
- DepartmentId; string; The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule.
- DivisionId; string; The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule.
- EnteredCr; number; Entered credit amount that is calculated for the line by the system based on the associated accounting rule.
- EnteredDr; number; Entered debit amount that is calculated for the line by the system based on the associated accounting rule.
- FunctionId; string; The public service for which an agency is responsible that is associated with an accounting transaction line. Value is optional and comes from the associated accounting rule.
- FundId; string; The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule.
- JeLineId; integer; The unique identifier of the journal line. Mandatory system-generated number.
- JeLineStatus; string; Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid).
- JournalSumLineId; integer; Currently not used. Set to 1.
- LedgerId; string; The unique identifier of the ledger associated with the journal. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value.
- LineNumber; integer; System-generated line number, starting from 1, within a journal.
- ProgramId; string; A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting 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
-
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 : publicSectorJournalLineDetails
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 : publicSectorJournalLineDetails-item-response
Type:
Show Source
object
-
AccountedCr: number
Entered credit amount stated in the base currency of the ledger. Currently equal to entered credit amount.
-
AccountedDr: number
Entered debit amount stated in the base currency of the ledger. Currently equal to entered debit amount.
-
AccountId: string
Title:
Account
Maximum Length:30
The type of economic activity for an accounting transaction line. Value is mandatory and comes from the associated accounting rule. -
AccountingDate: string
(date-time)
The date the associated accounting transaction took place. Normally inherited from the transaction, but can be modified if the transaction date falls in a closed accounting period. Mandatory system-maintained value.
-
AccountingEventId: string
Maximum Length:
30
The unique identifier of the accounting event associated with the journal. Identifies a specific type of transaction for which accounting journals are required. Mandatory system-maintained value. -
AccountingRuleId: string
Maximum Length:
50
The unique identifier of the accounting rule associated with the journal. Describes how accounting journal entries are to be created for a specific type of transaction. Mandatory system-maintained value. -
AgencyId: integer
(int32)
The unique identifier of the agency associated with the journal. Value is mandatory and is set programmatically based on the user's login.
-
BaseCurrency: string
Maximum Length:
3
The currency that the accounted debit or accounted credit amount is stated in. Value is mandatory and is inherited from the ledger associated with the journal. -
BatchRequestId: string
Maximum Length:
30
Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The currency that the entered debit or entered credit amount is stated in. Value is mandatory and is inherited from the accounting transaction. -
DepartmentId: string
Title:
Department
Maximum Length:30
The financial entity or management unit that is responsible for an accounting transaction line. Value is optional and comes from the associated accounting rule. -
DivisionId: string
Title:
Division
Maximum Length:30
The sub-grouping within a department for an accounting transaction line. Value is optional and comes from the associated accounting rule. -
EnteredCr: number
Title:
Credit Amount
Entered credit amount that is calculated for the line by the system based on the associated accounting rule. -
EnteredDr: number
Title:
Debit Amount
Entered debit amount that is calculated for the line by the system based on the associated accounting rule. -
FunctionId: string
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 comes from the associated accounting rule. -
FundId: string
Title:
Fund
Maximum Length:30
The source or target of funding for an accounting transaction line. Value is mandatory and comes from the associated accounting rule. -
JeLineId: integer
(int64)
Title:
Journal Line ID
The unique identifier of the journal line. Mandatory system-generated number. -
JeLineStatus: string
Title:
Line Status
Maximum Length:1
Current status of the journal line. Mandatory system-maintained value. Accepted values are C (Created), E (Error), and V (Valid). -
JournalSumLineId: integer
(int64)
Currently not used. Set to 1.
-
LedgerId: string
Maximum Length:
30
The unique identifier of the ledger associated with the journal. Identifies the accounting treatment of journals associated with the ledger. Mandatory system-maintained value. -
LineNumber: integer
(int32)
Title:
Line Number
System-generated line number, starting from 1, within a journal. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Tracks the number of updates to the journal line. Mandatory system-maintained value.
-
ProgramId: string
Title:
Program
Maximum Length:30
A set of activities performed by an agency to accomplish a specific goal associated with an accounting transaction line. Value is optional and comes from the associated accounting 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.