Oracle Financials Budgetary Control API

openapi: 3.2.0
info:
  title: Oracle Financials Budgetary Control API
  version: 11.13.18.05
  description: 'Operations tagged Budgetary Control across 2 of this provider''s published API definitions: oracle-financials-general-ledger-openapi.yml, oracle-general-ledger-budgetary-control-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{instance}.oraclecloud.com
  description: Oracle Fusion Cloud Instance
  variables:
    instance:
      default: servername
      description: Your Oracle Cloud instance identifier
- url: https://{instance}.oraclecloud.com/fscmRestApi/resources/11.13.18.05
  description: Customer Oracle Cloud instance.
  variables:
    instance:
      default: example
      description: Customer-specific Oracle Cloud instance.
tags:
- name: Budgetary Control
  description: Manage budget transactions and view budgetary control validation results
paths:
  /fscmRestApi/resources/11.13.18.05/budgetaryControlResults:
    get:
      operationId: listBudgetaryControlResults
      summary: Oracle Financials List budgetary control results
      description: Retrieve budgetary control validation results, including budget impact details for transactions that have been validated against budgets.
      tags:
      - Budgetary Control
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/fields'
      - $ref: '#/components/parameters/q'
      - $ref: '#/components/parameters/finder'
      responses:
        '200':
          description: Successful retrieval of budgetary control results
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      $ref: '#/components/schemas/BudgetaryControlResult'
                  count:
                    type: integer
                    description: Number of items returned
                  hasMore:
                    type: boolean
                    description: Whether more items are available
        '401':
          description: Unauthorized - invalid or missing credentials
      security:
      - bearerAuth: []
    servers:
    - url: https://{instance}.oraclecloud.com
      description: Oracle Fusion Cloud Instance
      variables:
        instance:
          default: servername
          description: Your Oracle Cloud instance identifier
  /fscmRestApi/resources/11.13.18.05/budgetaryControlBudgetTransactions:
    post:
      operationId: createBudgetTransaction
      summary: Oracle Financials Create a budget transaction
      description: Create a new budgetary control budget transaction for budget entry and validation.
      tags:
      - Budgetary Control
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BudgetTransaction'
      responses:
        '201':
          description: Budget transaction created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BudgetTransaction'
        '400':
          description: Bad request - invalid transaction data
        '401':
          description: Unauthorized - invalid or missing credentials
      security:
      - bearerAuth: []
    servers:
    - url: https://{instance}.oraclecloud.com
      description: Oracle Fusion Cloud Instance
      variables:
        instance:
          default: servername
          description: Your Oracle Cloud instance identifier
  /fedBudgetExecutionControls:
    get:
      tags:
      - Budgetary Control
      summary: List budget execution controls
      operationId: listBudgetExecutionControls
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Budget execution controls collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResourceCollection'
      security:
      - basicAuth: []
      - bearerAuth: []
    servers:
    - url: https://{instance}.oraclecloud.com/fscmRestApi/resources/11.13.18.05
      description: Customer Oracle Cloud instance.
      variables:
        instance:
          default: example
          description: Customer-specific Oracle Cloud instance.
components:
  parameters:
    finder:
      name: finder
      in: query
      description: Named finder to execute a predefined query
      schema:
        type: string
    q:
      name: q
      in: query
      description: Filter expression using Oracle REST query syntax
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Maximum number of items to return
      schema:
        type: integer
        default: 25
    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
    Offset:
      name: offset
      in: query
      required: false
      schema:
        type: integer
        default: 0
    Limit:
      name: limit
      in: query
      required: false
      schema:
        type: integer
        default: 25
        maximum: 500
  schemas:
    BudgetTransaction:
      type: object
      description: A budget transaction for entering or adjusting budget amounts
      properties:
        BudgetName:
          type: string
          description: Name of the budget
        LedgerId:
          type: integer
          description: Unique identifier of the ledger
        AccountingPeriod:
          type: string
          description: Accounting period for the budget entry
        AccountCombination:
          type: string
          description: Account combination for the budget amount
        Amount:
          type: number
          description: Budget amount
        CurrencyCode:
          type: string
          description: ISO 4217 currency code
          pattern: ^[A-Z]{3}$
    BudgetaryControlResult:
      type: object
      description: Result of budgetary control validation for a transaction
      properties:
        TransactionId:
          type: integer
          description: Identifier of the validated transaction
        BudgetName:
          type: string
          description: Name of the budget used for validation
        Status:
          type: string
          description: Validation result status
        FundsAvailable:
          type: number
          description: Amount of funds available in the budget
        FundsConsumed:
          type: number
          description: Amount of funds consumed by the transaction
    Link:
      type: object
      properties:
        rel:
          type: string
        href:
          type: string
        name:
          type: string
        kind:
          type: string
    ResourceCollection:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            additionalProperties: true
        count:
          type: integer
        hasMore:
          type: boolean
        limit:
          type: integer
        offset:
          type: integer
        links:
          type: array
          items:
            $ref: '#/components/schemas/Link'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Oracle Identity Cloud Service
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with Oracle Cloud user credentials.
x-refined-from:
- oracle-financials-general-ledger-openapi.yml
- oracle-general-ledger-budgetary-control-api-openapi.yml