Oracle Financials Currency Rates API

Retrieve currency conversion rates used for multi-currency accounting

OpenAPI Specification

oracle-financials-currency-rates-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Oracle Financials General Ledger Budgetary Control Currency Rates 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: Currency Rates
  description: Retrieve currency conversion rates used for multi-currency accounting
paths:
  /fscmRestApi/resources/11.13.18.05/currencyRates:
    get:
      operationId: listCurrencyRates
      summary: Oracle Financials List currency rates
      description: Retrieve currency conversion rates. These rates are used for multi-currency accounting and reporting across business units and ledgers.
      tags:
      - Currency Rates
      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 currency rates
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/CurrencyRate'
                  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:
  schemas:
    CurrencyRate:
      type: object
      description: Currency conversion rate between two currencies for a specific date and rate type
      properties:
        FromCurrency:
          type: string
          description: Source currency code
          pattern: ^[A-Z]{3}$
        ToCurrency:
          type: string
          description: Target currency code
          pattern: ^[A-Z]{3}$
        ConversionDate:
          type: string
          format: date
          description: Effective date of the conversion rate
        ConversionType:
          type: string
          description: Type of conversion rate
        ConversionRate:
          type: number
          description: Conversion rate from source to target currency
  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
  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