openapi: 3.1.0
info:
  title: Oracle Financials General Ledger Budgetary Control Ledger Balances 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: Ledger Balances
  description: View balance amounts for account combinations or accounts defined as part of an account group
paths:
  /fscmRestApi/resources/11.13.18.05/ledgerBalances:
    get:
      operationId: listLedgerBalances
      summary: Oracle Financials List account balances
      description: Retrieve balance amounts for account combinations or accounts defined as part of an account group. Supports filtering by ledger, period, account segment values, and balance type.
      tags:
      - Ledger Balances
      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'
      responses:
        '200':
          description: Successful retrieval of ledger balances
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/LedgerBalance'
                  count:
                    type: integer
                    description: Number of items returned
                  hasMore:
                    type: boolean
                    description: Whether more items are available
        '401':
          description: Unauthorized - invalid or missing credentials
components:
  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
    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
  schemas:
    LedgerBalance:
      type: object
      description: Account balance for a specific account combination within a ledger and accounting period
      properties:
        LedgerId:
          type: integer
          description: Unique identifier of the ledger
        LedgerName:
          type: string
          description: Name of the ledger
        PeriodName:
          type: string
          description: Accounting period name
        CurrencyCode:
          type: string
          description: ISO 4217 currency code for the balance
          pattern: ^[A-Z]{3}$
        AccountCombination:
          type: string
          description: Account combination string
        BeginningBalance:
          type: number
          description: Beginning balance for the period
        PeriodActivity:
          type: number
          description: Net activity for the period
        EndingBalance:
          type: number
          description: Ending balance for the period
        AmountType:
          type: string
          description: Type of balance amount
        ActualFlag:
          type: string
          enum:
          - A
          - B
          - E
          description: Balance type indicator where A is actual, B is budget, and E is encumbrance
  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