Get a journal line

get

/fscmRestApi/resources/11.13.18.05/publicSectorJournalLines/{publicSectorJournalLinesUniqID}

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key--- JeLineId and JeHeaderId ---for the Journal Lines resource and used to uniquely identify an instance of Journal Lines. The client should not generate the hash key value. Instead, the client should query on the Journal Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Journal Lines.

    For example: publicSectorJournalLines?q=JeLineId=<value1>;JeHeaderId=<value2>
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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : publicSectorJournalLines-item
Type: object
Show Source
  • Entered credit amount stated in the base currency of the ledger. Currently equal to entered credit amount.
  • Entered debit amount stated in the base currency of the ledger. Currently equal to entered debit amount.
  • 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.
  • 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.
  • 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.
  • Maximum Length: 50
    The accounting rule group, if any, associated with this journal. Inherited from the accounting rule.
  • 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.
  • The unique identifier of the agency associated with the journal. Value is mandatory and is set programmatically based on the user's login.
  • 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.
  • Maximum Length: 30
    Unique identifier assigned by the system when the journal was created or updated to facilitate the Generate Accounting process.
  • 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.
  • 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.
  • 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.
  • Title: Credit Amount
    Entered credit amount that is calculated for the line by the system based on the associated accounting rule.
  • Title: Debit Amount
    Entered debit amount that is calculated for the line by the system based on the associated accounting rule.
  • The unique identifier for the accounting transaction. Value is inherited from the accounting transaction.
  • Title: Fee Item
    Maximum Length: 30
    The fee item associated with the accounting transaction. Value is inherited from the accounting transaction.
  • 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.
  • 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.
  • The unique identifier of the journal. Value is mandatory and is system-generated when the journal is created.
  • Title: Journal Line ID
    The unique identifier of the journal line. Mandatory system-generated number.
  • 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).
  • Currently not used. Set to 1.
  • 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.
  • Title: Line Number
    System-generated line number, starting from 1, within a journal.
  • Items
  • Tracks the number of updates to the journal line. Mandatory system-maintained value.
  • 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.
  • Title: Transaction Type
    Maximum Length: 50
    The type of transaction or business activity (record type) that the accounting transaction represents. Value is inherited from the accounting transaction.
Back to Top