Get all journals

get

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

Request

Path Parameters
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
      Finder Variables:
    • 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:
      • AccrualReversalEffectiveDate; string; The date when the journal was reversed.
      • AccrualReversalJeHeaderName; string; The name of the reversal journal for this journal.
      • AccrualReversalPeriodName; string; The reversal period of the journal.
      • AccrualReversalStatus; string; The status of the journal reversal. Accepted values are Not reversed or Reversed.
      • CloseAccountSequenceAssignName; string; The name of the journal reporting sequence.
      • CloseAccountSequenceValue; number; The value of the journal accounting sequence.
      • ControlTotal; number; The control total of the journal.
      • CreatedBy; string; The user who created the journal.
      • CreationDate; string; The date and time when the journal was created.
      • CurrencyCode; string; The currency of the journal.
      • CurrencyConversionDate; string; The date when the journal currency was converted.
      • CurrencyConversionRate; number; The rate of the journal currency conversion.
      • DefaultEffectiveDate; string; The accounting date of the journal.
      • EncumbranceType; string; The type of encumbrance associated with the journal. Review types using the Setup and Maintenance work area, Manage Encumbrance Types task.
      • ExternalReference; string; The reference information for the journal entered by the user.
      • JeFromSlaFlagMeaning; string; The indicator for whether the journal originated from the subledger accounting process instead of being directly created in General Ledger. Accepted values are Yes or No.
      • JournalDescription; string; The description of the journal.
      • JournalName; string; The name of the journal.
      • LastUpdateDate; string; The date and time when the journal was last updated.
      • LastUpdatedBy; string; The user who last updated the batch.
      • LedgerCurrencyCode; string; The currency of the ledger.
      • LedgerName; string; The name of the ledger associated with the journal.
      • LegalEntityName; string; The name of the legal entity associated with the journal.
      • OriginatingBalSegValue; string; The clearing company for the journal used for intercompany balancing.
      • PeriodName; string; The accounting period of the journal.
      • PostingAccountSequenceAssignName; string; The name of the journal accounting sequence.
      • PostingAccountSequenceValue; number; The value of the posting accounting sequence.
      • ReferenceDate; string; The reference date for the journal entered by the user.
      • ReversedJeHeaderName; string; The name of the journal that was reversed by this journal.
      • RunningTotalAccountedCr; number; The total accounted credit of the journal.
      • RunningTotalAccountedDr; number; The total accounted debit of the journal.
      • RunningTotalCr; number; The total entered credit of the journal.
      • RunningTotalDr; number; The total entered debit of the journal.
      • UserCurrencyConversionType; string; The type of currency conversion rate for the journal.
      • UserJeCategoryName; string; The category of the journal. Review and manage categories using the Setup and Maintenance work area, Manage Journal Categories task.
    • 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
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : journalBatches-journalHeaders-item-response
    Type: object
    Show Source
    Nested Schema : Attachments
    Type: array
    Title: Attachments
    The attachments resource is used to view attachment information for a journal.
    Show Source
    Nested Schema : Descriptive Flexfields
    Type: array
    Title: Descriptive Flexfields
    The descriptive flexfields resource is used to view values for a journal header that are captured using the Journals 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 that are captured using the General Ledger Journal Regional Information global descriptive flexfield.
    Show Source
    • Discriminator: __FLEX_Context
      Discriminator: { "propertyName":"__FLEX_Context", "mapping":{ "FVxUSGLJournalHeaders":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFFVxUSGLJournalHeadersVO-item-response", "JA_CN_SETTLE_METHOD":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJA__5FCN__5FSETTLE__5FMETHODVO-item-response", "JL_BR_GLXJEENT_PCPCODE":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJL__5FBR__5FGLXJEENT__5FPCPCODEVO-item-response", "JLxMXJournalHeaders":"#/components/schemas/oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJLxMXJournalHeadersVO-item-response" } }
    Nested Schema : Journal Lines
    Type: array
    Title: Journal Lines
    The journal lines resource is used to view the journal lines for a batch.
    Show Source
    Nested Schema : journalBatches-journalHeaders-journalAttachment-item-response
    Type: object
    Show Source
    Nested Schema : journalBatches-journalHeaders-journalDFF-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_journalHeaderGdf_view_JournalHeaderGDFFVxUSGLJournalHeadersVO-item-response
    Type: object
    Show Source
    Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJA__5FCN__5FSETTLE__5FMETHODVO-item-response
    Type: object
    Show Source
    Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJL__5FBR__5FGLXJEENT__5FPCPCODEVO-item-response
    Type: object
    Show Source
    Nested Schema : oracle_apps_flex_financials_generalLedger_journals_journalEntries_restModel_journalHeaderGdf_view_JournalHeaderGDFJLxMXJournalHeadersVO-item-response
    Type: object
    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
    Back to Top

    Examples

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

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

    Example Response Body

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

    {
        "items": [
            {
                "JournalName": " Ajustement Periode 01-02 - 601100.-",
                "AccrualReversalEffectiveDate": null,
                "AccrualReversalPeriodName": null,
                "AccrualReversalStatus": null,
                "CloseAccountSequenceValue": null,
                "ControlTotal": null,
                "CurrencyCode": "EUR",
                "CurrencyConversionDate": "2002-01-31",
                "CurrencyConversionRate": 1,
                "DefaultEffectiveDate": "2002-01-31",
                "JournalDescription": "Ajustement Periode 01-02 - Charges indirectes 601100",
                "ExternalReference": null,
                "OriginatingBalSegValue": null,
                "PeriodName": "01-02",
                "ReferenceDate": null,
                "RunningTotalAccountedDr": 296186.52,
                "PostingAccountSequenceValue": null,
                "RunningTotalCr": 296186.52,
                "RunningTotalDr": 296186.52,
                "RunningTotalAccountedCr": 296186.52,
                "CreatedBy": "2044",
                "CreationDate": "2002-06-19T01:44:43+00:00",
                "LastUpdateDate": "2002-06-19T02:02:06+00:00",
                "LastUpdatedBy": "2044",
                "LedgerName": "Vision France",
                "LegalEntityName": null,
                "JeFromSlaFlagMeaning": null,
                "EncumbranceType": null,
                "ReversedJeHeaderName": null,
                "AccrualReversalJeHeaderName": null,
                "CloseAccountSequenceAssignName": null,
                "PostingAccountSequenceAssignName": null,
                "LedgerCurrencyCode": "EUR",
                "InvCurrencyConversionRate": 1,
                "UserCurrencyConversionType": "User",
                "UserJeCategoryName": "Adjustment",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184",
                        "name": "journalHeaders",
                        "kind": "item",
                        "properties": {
                                         "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
                                      }
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184",
                        "name": "journalHeaders",
                        "kind": "item"
                    },
                    {
                        "rel": "parent",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539",
                        "name": "journalBatches",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalAttachment",
                        "name": "journalAttachment",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalDFF",
                        "name": "journalDFF",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalGDF",
                        "name": "journalGDF",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders/39184/child/journalLines",
                        "name": "journalLines",
                        "kind": "collection"
                    }
                ]
            }
        ],
        "count": 1,
        "hasMore": false,
        "limit": 25,
        "offset": 0,
        "links": [
            {
                "rel": "self",
                "href": "https://servername.fa.us2.oraclecloud.comfscmRestApi/resources/11.13.18.05/journalBatches/41539/child/journalHeaders",
                "name": "journalHeaders",
                "kind": "collection"
            }
        ]
    }
    Back to Top