Oracle Fusion Cloud Applications Cash Management API

openapi: 3.1.0
info:
  title: Oracle Fusion Cloud Applications Oracle Fusion Common Features REST Absences Cash Management API
  description: REST APIs for Oracle Fusion Cloud Applications Common features, providing access to shared services such as attachments, flexfields, lookup types, roles, users, security, scheduled processes, announcements, and approval workflows used across all Fusion Cloud application pillars.
  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: Cash Management
  description: Bank accounts, transfers, and cash pools
paths:
  /fscmRestApi/resources/11.13.18.05/cashBankAccounts:
    get:
      operationId: listBankAccounts
      summary: Oracle Fusion Cloud Applications List bank accounts
      description: View, create, and modify bank accounts for cash management.
      tags:
      - Cash Management
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Bank accounts retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccount'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
  /fscmRestApi/resources/11.13.18.05/cashBankAccountTransfers:
    get:
      operationId: listBankAccountTransfers
      summary: Oracle Fusion Cloud Applications List bank account transfers
      description: Retrieve bank account transfer records for cash management.
      tags:
      - Cash Management
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      responses:
        '200':
          description: Transfers retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccountTransfer'
                  count:
                    type: integer
                  hasMore:
                    type: boolean
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createBankAccountTransfer
      summary: Oracle Fusion Cloud Applications Create a bank account transfer
      description: Create a new bank account transfer.
      tags:
      - Cash Management
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BankAccountTransferCreate'
      responses:
        '201':
          description: Transfer created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccountTransfer'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          description: Error type URI
        title:
          type: string
          description: Short error description
        detail:
          type: string
          description: Detailed error message
        o:errorCode:
          type: string
          description: Oracle-specific error code
        o:errorDetails:
          type: array
          items:
            type: object
            properties:
              detail:
                type: string
              o:errorCode:
                type: string
    BankAccountTransfer:
      type: object
      properties:
        TransferId:
          type: integer
          description: Transfer identifier
        TransferAmount:
          type: number
          format: double
          description: Transfer amount
        TransferDate:
          type: string
          format: date
          description: Transfer date
        CurrencyCode:
          type: string
          description: Transfer currency
        FromBankAccountName:
          type: string
          description: Source bank account name
        ToBankAccountName:
          type: string
          description: Destination bank account name
        Status:
          type: string
          description: Transfer status
    BankAccount:
      type: object
      properties:
        BankAccountId:
          type: integer
          description: Bank account identifier
        BankAccountName:
          type: string
          description: Bank account name
        BankAccountNumber:
          type: string
          description: Bank account number
        BankName:
          type: string
          description: Bank name
        BranchName:
          type: string
          description: Branch name
        CurrencyCode:
          type: string
          description: Account currency
        AccountType:
          type: string
          description: Bank account type
        Country:
          type: string
          description: Country of the bank account
        Status:
          type: string
          description: Account status
          enum:
          - Active
          - Inactive
    BankAccountTransferCreate:
      type: object
      required:
      - TransferAmount
      - CurrencyCode
      - FromBankAccountName
      - ToBankAccountName
      properties:
        TransferAmount:
          type: number
          format: double
        TransferDate:
          type: string
          format: date
        CurrencyCode:
          type: string
        FromBankAccountName:
          type: string
        ToBankAccountName:
          type: string
  parameters:
    q:
      name: q
      in: query
      required: false
      description: 'Filter expression using Oracle REST query syntax. Example: InvoiceNumber=''INV-001'' or InvoiceAmount>1000'
      schema:
        type: string
    offset:
      name: offset
      in: query
      required: false
      description: Number of items to skip before returning results
      schema:
        type: integer
        default: 0
    fields:
      name: fields
      in: query
      required: false
      description: Comma-separated list of fields to include in the response. Use to limit returned attributes for performance.
      schema:
        type: string
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of items to return (default 25, max 500)
      schema:
        type: integer
        default: 25
        maximum: 500
    finder:
      name: finder
      in: query
      required: false
      description: Named finder to execute. Format is FinderName;param1=value1,param2=value2
      schema:
        type: string
  responses:
    BadRequest:
      description: Invalid request parameters or payload
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Authentication credentials are missing or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Oracle Fusion Cloud Applications Common Features REST API Documentation
  url: https://docs.oracle.com/en/cloud/saas/applications-common/26a/farca/index.html