Get a batch

get

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

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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view attachment information for a batch.
Show Source
Nested Schema : Action Logs
Type: array
Title: Action Logs
The journal action logs resource is used to view action logs 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 batch that are captured using the Journal Batches descriptive flexfield.
Show Source
Nested Schema : Errors
Type: array
Title: Errors
The journal errors resource is used to view the errors for a journal.
Show Source
Nested Schema : Journal Headers
Type: array
Title: Journal Headers
The journal headers resource is used to view header information for a journal.
Show Source
Nested Schema : journalBatches-batchAttachment-item-response
Type: object
Show Source
Nested Schema : journalBatches-journalActionLogs-item-response
Type: object
Show Source
  • Title: Action
    Read Only: true
    Maximum Length: 80
    The action taken on the journal batch. A list of accepted values is defined in the lookup type ACTION_CODE.
  • Title: Event Date and Time
    The date when the action was recorded in the journal action log.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the journal action log.
  • Title: Creation Date
    Read Only: true
    The date and time when the journal action log was created.
  • Title: Last Update Date
    Read Only: true
    The date and time when the journal action log was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the journal action log.
  • Links
  • Title: User Name
    Read Only: true
    Maximum Length: 240
    The user who took the action on the journal batch.
Nested Schema : journalBatches-journalBatchDFF-item-response
Type: object
Show Source
Nested Schema : journalBatches-journalErrors-item-response
Type: object
Show Source
  • Title: Batch
    Maximum Length: 100
    The name of the batch associated with the error.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the journal error.
  • Title: Creation Date
    Read Only: true
    The date and time when the error for the journal was created.
  • Title: Error Message
    Maximum Length: 1000
    The error for the journal. A list of accepted values is available in the ERROR_MESSAGE column of the GL_JE_ERROR_CODES table.
  • Title: Error Message Name
    Maximum Length: 30
    The error message name for the journal. A list of accepted values is available in the ERROR_MESSAGE_NAME column of the GL_JE_ERROR_CODES table.
  • Title: Error Number
    The number for the error. A list of accepted values is available in the ERROR_NUM column of the GL_JE_ERROR_CODES table.
  • Title: Journal
    Maximum Length: 100
    The name of the journal associated with the error.
  • Title: Line Number
    The line number associated with the journal error.
  • Title: Last Update Date
    Read Only: true
    The date and time when the error for the journal was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the journal error.
  • Links
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 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/1715986

Example Response Body

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

{
    "JeBatchId": 1715986,
    "AccountedPeriodType": "MONTH6142622742",
    "DefaultPeriodName": "Apr-19",
    "BatchName": "RG 002",
    "Status": "M",
    "ControlTotal": null,
    "BatchDescription": null,
    "ErrorMessage": "The journal isn't balanced by balancing segment values and intercompany isn't enabled for ledger RG Ledger.  Details: You must enable intercompany or correct the journal.",
    "PostedDate": null,
    "PostingRunId": 313200,
    "RequestId": 6574,
    "RunningTotalAccountedCr": 20,
    "RunningTotalAccountedDr": 20,
    "RunningTotalCr": 20,
    "RunningTotalDr": 20,
    "CreatedBy": "FINUSER1",
    "CreationDate": "2019-04-24T22:30:18+00:00",
    "LastUpdateDate": "2019-05-01T21:57:31+00:00",
    "LastUpdatedBy": "FUSION_APPS_FIN_ODI_ESS_APPID",
    "ActualFlagMeaning": "Actual",
    "ApprovalStatusMeaning": "Not required",
    "ApproverEmployeeName": null,
    "FundsStatusMeaning": "Not applicable",
    "ParentJeBatchName": null,
    "ChartOfAccountsName": "RG Ledger",
    "StatusMeaning": "Validation error during posting of the batch",
    "CompletionStatusMeaning": "Complete",
    "UserPeriodSetName": "RG Ledger",
    "UserJeSourceName": "AutoCopy",
    "ReversalDate": null,
    "ReversalPeriod": null,
    "ReversalFlag": null,
    "ReversalMethodMeaning": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1715986",
            "name": "journalBatches",
            "kind": "item",
            "properties": {
                             "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000001A78"
                          }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/journalBatches/1715986",
            "name": "journalBatches",
            "kind": "item"
        },
        ...
    ]
}
Back to Top