Oracle Financials Journal Batches API

openapi: 3.1.0
info:
  title: Oracle Financials General Ledger Budgetary Control Journal Batches API
  description: REST API for Oracle Fusion Cloud Financials General Ledger, providing programmatic access to journal batches, journal entries, ledger balances, currency rates, chart of accounts filters, and budgetary control. The API supports creating, retrieving, updating, and deleting journal batches, viewing account balances for any account combination or account group, and managing currency conversion rates used across the financial system.
  version: 11.13.18.05
  contact:
    name: Oracle Support
    url: https://support.oracle.com
    email: support@oracle.com
  license:
    name: Oracle Cloud Services Agreement
    url: https://www.oracle.com/corporate/contracts/cloud-services/
  termsOfService: https://www.oracle.com/corporate/contracts/cloud-services/
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
security:
- bearerAuth: []
tags:
- name: Journal Batches
  description: Manage journal batches including headers, lines, action logs, and attachments
paths:
  /fscmRestApi/resources/11.13.18.05/journalBatches:
    get:
      operationId: listJournalBatches
      summary: Oracle Financials List journal batches
      description: Retrieve a collection of journal batches. Supports filtering, sorting, and pagination using standard Oracle REST query parameters.
      tags:
      - Journal Batches
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/finder'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: Successful retrieval of journal batches
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/JournalBatch'
                  count:
                    type: integer
                    description: Number of items returned
                  hasMore:
                    type: boolean
                    description: Whether more items are available
                  limit:
                    type: integer
                    description: Maximum number of items returned
                  offset:
                    type: integer
                    description: Offset of the first item returned
        '401':
          description: Unauthorized - invalid or missing credentials
        '403':
          description: Forbidden - insufficient privileges
  /fscmRestApi/resources/11.13.18.05/journalBatches/{JeBatchId}:
    get:
      operationId: getJournalBatch
      summary: Oracle Financials Get a journal batch
      description: Retrieve a specific journal batch by its unique identifier, including associated journal headers, lines, and action logs.
      tags:
      - Journal Batches
      parameters:
      - $ref: '#/components/parameters/JeBatchId'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/expand'
      responses:
        '200':
          description: Successful retrieval of the journal batch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalBatch'
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Journal batch not found
    patch:
      operationId: updateJournalBatch
      summary: Oracle Financials Update a journal batch
      description: Update a journal batch. Only batch completion status and reversal attributes can be updated through this endpoint.
      tags:
      - Journal Batches
      parameters:
      - $ref: '#/components/parameters/JeBatchId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JournalBatchUpdate'
      responses:
        '200':
          description: Journal batch updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalBatch'
        '400':
          description: Bad request - invalid update payload
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Journal batch not found
    delete:
      operationId: deleteJournalBatch
      summary: Oracle Financials Delete a journal batch
      description: Delete a specific journal batch by its unique identifier.
      tags:
      - Journal Batches
      parameters:
      - $ref: '#/components/parameters/JeBatchId'
      responses:
        '204':
          description: Journal batch deleted successfully
        '401':
          description: Unauthorized - invalid or missing credentials
        '404':
          description: Journal batch not found
components:
  schemas:
    JournalBatch:
      type: object
      description: A journal batch containing one or more journal entries for posting to the general ledger
      properties:
        JeBatchId:
          type: integer
          description: Unique system-generated identifier for the journal batch
        Name:
          type: string
          description: Name of the journal batch
        Description:
          type: string
          description: Description of the journal batch
        Status:
          type: string
          description: Current status of the journal batch
        PostingStatus:
          type: string
          description: Posting status of the batch
        ApprovalStatus:
          type: string
          description: Approval status of the batch
        LedgerName:
          type: string
          description: Name of the ledger associated with this batch
        LedgerId:
          type: integer
          description: Unique identifier of the ledger
        AccountingPeriodName:
          type: string
          description: Name of the accounting period
        DefaultEffectiveDate:
          type: string
          format: date
          description: Default effective date for journals in this batch
        CreatedBy:
          type: string
          description: Username of the person who created the batch
        CreationDate:
          type: string
          format: date-time
          description: Timestamp when the batch was created
        LastUpdateDate:
          type: string
          format: date-time
          description: Timestamp when the batch was last modified
    JournalBatchUpdate:
      type: object
      description: Updatable fields for a journal batch, limited to completion status and reversal attributes
      properties:
        Status:
          type: string
          description: Updated status of the journal batch
        ReversalDate:
          type: string
          format: date
          description: Date for reversing the journal batch
        ReversalPeriodName:
          type: string
          description: Accounting period name for the reversal
  parameters:
    q:
      name: q
      in: query
      description: Filter expression using Oracle REST query syntax
      schema:
        type: string
    orderBy:
      name: orderBy
      in: query
      description: Comma-separated list of fields to sort by, with optional asc or desc
      schema:
        type: string
    JeBatchId:
      name: JeBatchId
      in: path
      required: true
      description: Unique identifier for the journal batch
      schema:
        type: integer
    offset:
      name: offset
      in: query
      description: Number of items to skip before returning results
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      description: Comma-separated list of fields to include in the response
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        default: 25
    finder:
      name: finder
      in: query
      description: Named finder to execute a predefined query
      schema:
        type: string
    expand:
      name: expand
      in: query
      description: Comma-separated list of child resources to expand in the response
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Oracle Identity Cloud Service
externalDocs:
  description: Oracle Fusion Cloud Financials REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/financials/26a/farfa/index.html