1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Journal Batches
  4. Journal Headers
  5. Journal Lines

Get all lines

get

/fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}/child/journalHeaders/{journalHeadersUniqID}/child/journalLines

Request

Path Parameters
  • The unique identifier of the batch.
  • This is the hash key of the attributes which make up the composite key for the Journal Headers resource and used to uniquely identify an instance of Journal Headers. The client should not generate the hash key value. Instead, the client should query on the Journal Headers collection resource in order to navigate to a specific instance of Journal Headers to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 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
  • 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:
      • JeLineNumber; integer; The number of the journal line.
  • 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.
  • 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
  • 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 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
  • 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:
    • AccountCombination; string; The account for the journal line.
    • AccountedCr; number; The accounted credit amount of the journal line.
    • AccountedDr; number; The accounted debit amount of the journal line.
    • ChartOfAccountsName; string; The chart of accounts associated with the account.
    • CreatedBy; string; The user who created the journal line.
    • CreationDate; string; The date and time when the journal line was created.
    • CurrencyCode; string; The currency of the journal line.
    • CurrencyConversionDate; string; The date when the currency of the journal line was converted.
    • CurrencyConversionRate; number; The rate for the journal line currency conversion.
    • Description; string; The description of the journal line.
    • EnteredCr; number; The entered credit amount for the journal line.
    • EnteredDr; number; The entered debit amount for the journal line.
    • JeLineNumber; integer; The number of the journal line.
    • JgzzReconDate; string; The date when the journal line was reconciled.
    • JgzzReconId; number; The unique identifier of the reconciliation reference for the journal line.
    • JgzzReconReference; string; The additional information for the journal line entered by the user.
    • LastUpdateDate; string; The date and time when the journal line was last updated.
    • LastUpdatedBy; string; The user who last updated the journal line.
    • ReconciliationReference; string; The reconciliation reference information for the journal line entered by the user.
    • Reference1; string; The value of the REFERENCE1 column in the GL_JE_LINES table.
    • Reference10; string; The value of the REFERENCE10 column in the GL_JE_LINES table.
    • Reference2; string; The value of the REFERENCE2 column in the GL_JE_LINES table.
    • Reference3; string; The value of the REFERENCE3 column in the GL_JE_LINES table.
    • Reference4; string; The value of the REFERENCE4 column in the GL_JE_LINES table.
    • Reference5; string; The value of the REFERENCE5 column in the GL_JE_LINES table.
    • Reference6; string; The value of the REFERENCE6 column in the GL_JE_LINES table.
    • Reference7; string; The value of the REFERENCE7 column in the GL_JE_LINES table.
    • Reference8; string; The value of the REFERENCE8 column in the GL_JE_LINES table.
    • Reference9; string; The value of the REFERENCE9 column in the GL_JE_LINES table.
    • StatAmount; number; The statistical amount of the journal line.
    • UserCurrencyConversionType; string; The currency conversion rate type of the journal line.
    • jgzzReconStatusMeaning; string; The reconciliation status of the journal line. A list of accepted values is defined in the lookup type ORA_GL_LINE_RECON_STATUS.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : journalBatches-journalHeaders-journalLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : journalBatches-journalHeaders-journalLines-item-response
Type: object
Show Source
Nested Schema : Captured Information Descriptive Flexfields
Type: array
Title: Captured Information Descriptive Flexfields
The captured information descriptive flexfields resource is used to view values for a journal line that are captured using the Journals Captured Information descriptive flexfield.
Show Source
Nested Schema : Descriptive Flexfields
Type: array
Title: Descriptive Flexfields
The descriptive flexfields resource is used to view values for a journal line that are captured using the Journal Lines descriptive flexfield.
Show Source
Nested Schema : Global Descriptive Flexfields
Type: array
Title: Global Descriptive Flexfields
The global descriptive flexfields resource is used to view values for a journal line that are captured using the General Ledger Journal Line Regional Information global descriptive flexfield.
Show Source
  • Discriminator: __FLEX_Context
    Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSGLJournalLines":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFFVxUSGLJournalLinesVO-item-response", "JL_BR_GLXJEENT_PCPCODE":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFJL__5FBR__5FGLXJEENT__5FPCPCODEVO-item-response", "JLxMXJournalLines":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFJLxMXJournalLinesVO-item-response" } }
Nested Schema : journalBatches-journalHeaders-journalLines-capturedInformationDFF-item-response
Type: object
Show Source
Nested Schema : journalBatches-journalHeaders-journalLines-journalLineDFF-item-response
Type: object
Show Source
Nested Schema : Discriminator: __FLEX_Context
Type: object
Discriminator: __FLEX_Context

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFFVxUSGLJournalLinesVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFJL__5FBR__5FGLXJEENT__5FPCPCODEVO-item-response
Type: object
Show Source
Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalLineGdf_view_JournalLineGDFJLxMXJournalLinesVO-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Back to Top

Examples

The following example shows how to retrieve all the lines for a journal of a batch by submitting a GET request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "items": [
        {
            "JeLineNumber": 1,
            "AccountedCr": 296186.52,
            "AccountedDr": null,
            "Description": "Ajustement Periode 01-02 - Charges indirectes 601100",
            "CurrencyConversionDate": "2002-01-31",
            "CurrencyConversionRate": 1,
            "CurrencyCode": "EUR",
            "EnteredCr": 296186.52,
            "EnteredDr": null,
            "JgzzReconReference": null,
            "Reference1": null,
            "Reference9": null,
            "Reference8": null,
            "Reference7": null,
            "Reference6": null,
            "Reference5": null,
            "Reference4": null,
            "Reference3": null,
            "Reference2": null,
            "Reference10": null,
            "StatAmount": null,
            "CreationDate": "2002-06-19T01:44:43+00:00",
            "CreatedBy": "2044",
            "LastUpdatedBy": "2044",
            "LastUpdateDate": "2002-06-19T02:02:06+00:00",
            "JgzzReconDate": null,
            "JgzzReconId": null,
            "ReconciliationReference": null,
            "jgzzReconStatusMeaning": null,
            "UserCurrencyConversionType": "User",
            "AccountCombination": "11.601100.-.-.000.-",
            "ChartOfAccountsName": "France Accounting Flex",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines/00020000000EACED0005770800000000000099100000000EACED000577080000000000000001",
                    "name": "journalLines",
                    "kind": "item",
                    "properties": {
                                     "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                                  }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines/00020000000EACED0005770800000000000099100000000EACED000577080000000000000001",
                    "name": "journalLines",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184",
                    "name": "journalHeaders",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines/00020000000EACED0005770800000000000099100000000EACED000577080000000000000001/child/capturedInformationDFF",
                    "name": "capturedInformationDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines/00020000000EACED0005770800000000000099100000000EACED000577080000000000000001/child/journalLineDFF",
                    "name": "journalLineDFF",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines/00020000000EACED0005770800000000000099100000000EACED000577080000000000000001/child/journalLineGDF",
                    "name": "journalLineGDF",
                    "kind": "collection"
                }
            ]
        },
		   ...
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines",
            "name": "journalLines",
            "kind": "collection"
        }
    ]
}
Back to Top