PeopleSoft Financials API

openapi: 3.1.0
info:
  title: PeopleSoft Financials API
  description: Financial Management APIs for general ledger, accounts payable, accounts
    receivable, expenses, asset management, and financial reporting.
  version: 1.0.0
  contact:
    name: Oracle Support
    email: [email protected]
    url: https://support.oracle.com
  license:
    name: Proprietary
    url: https://www.oracle.com/contracts/
servers:
- url: https://{hostname}:{port}/psft/api/financials/v1
  description: PeopleSoft Instance
  variables:
    hostname:
      description: PeopleSoft server hostname
      default: localhost
    port:
      description: PeopleSoft server port
      default: '8000'
externalDocs:
  description: PeopleSoft Financial Management Documentation
  url: https://docs.oracle.com/en/applications/peoplesoft/financial-management/index.html
tags:
- name: General Ledger
  description: General ledger operations
- name: Accounts Payable
  description: Accounts payable operations
- name: Accounts Receivable
  description: Accounts receivable operations
- name: Expenses
  description: Expense management operations
paths:
  /gl/journals:
    get:
      summary: PeopleSoft List Journal Entries
      description: Retrieve general ledger journal entries.
      operationId: listJournalEntries
      tags:
      - General Ledger
      security:
      - basicAuth: []
      parameters:
      - name: businessUnit
        in: query
        description: Business unit filter
        schema:
          type: string
        example: example_value
      - name: fromDate
        in: query
        description: Start date filter
        schema:
          type: string
          format: date
        example: '2026-04-17'
      - name: toDate
        in: query
        description: End date filter
        schema:
          type: string
          format: date
        example: '2026-04-17'
      responses:
        '200':
          description: Successful response with journal entries
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ap/vouchers:
    get:
      summary: PeopleSoft List Vouchers
      description: Retrieve accounts payable vouchers.
      operationId: listVouchers
      tags:
      - Accounts Payable
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with vouchers
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /ar/items:
    get:
      summary: PeopleSoft List AR Items
      description: Retrieve accounts receivable items.
      operationId: listARItems
      tags:
      - Accounts Receivable
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with AR items
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /expenses/reports:
    get:
      summary: PeopleSoft List Expense Reports
      description: Retrieve expense reports.
      operationId: listExpenseReports
      tags:
      - Expenses
      security:
      - basicAuth: []
      responses:
        '200':
          description: Successful response with expense reports
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
  schemas:
    JournalEntry:
      type: object
      description: PeopleSoft GL journal entry.
      properties:
        BUSINESS_UNIT:
          type: string
          description: Business unit.
          example: US001
        JOURNAL_ID:
          type: string
          description: Journal ID.
          example: '0000012345'
        JOURNAL_DATE:
          type: string
          format: date
          description: Journal date.
          example: '2026-04-17'
        LEDGER:
          type: string
          description: Ledger name.
          example: ACTUALS
        DESCR:
          type: string
          description: Journal description.
          example: Monthly accrual entry
        JRNL_HDR_STATUS:
          type: string
          description: Journal status.
          enum:
          - N
          - E
          - V
          - P
          - D
          - U
          - T
          example: V
        CURRENCY_CD:
          type: string
          description: Currency code.
          example: USD
        FISCAL_YEAR:
          type: integer
          description: Fiscal year.
          example: 2026
        ACCOUNTING_PERIOD:
          type: integer
          description: Accounting period.
          example: 4
        LINES:
          type: array
          description: Journal lines.
          items:
            type: object
            properties:
              JOURNAL_LINE:
                type: integer
                description: Line number.
                example: 1
              ACCOUNT:
                type: string
                description: GL account.
                example: '510000'
              DEPTID:
                type: string
                description: Department.
                example: '10200'
              MONETARY_AMOUNT:
                type: number
                description: Amount.
                example: 5000.0
              LINE_DESCR:
                type: string
                description: Line description.
                example: Office supplies
    Voucher:
      type: object
      description: PeopleSoft AP voucher.
      properties:
        BUSINESS_UNIT:
          type: string
          description: Business unit.
          example: US001
        VOUCHER_ID:
          type: string
          description: Voucher ID.
          example: 00045678
        VENDOR_ID:
          type: string
          description: Vendor ID.
          example: VND001234
        INVOICE_ID:
          type: string
          description: Invoice number.
          example: INV-2026-0042
        INVOICE_DT:
          type: string
          format: date
          description: Invoice date.
          example: '2026-04-15'
        GROSS_AMT:
          type: number
          description: Gross amount.
          example: 12500.0
        CURRENCY_CD:
          type: string
          description: Currency code.
          example: USD
        VCHR_HDR_STATUS:
          type: string
          description: Voucher status.
          enum:
          - O
          - A
          - C
          - P
          - V
          - X
          example: A
        DUE_DT:
          type: string
          format: date
          description: Due date.
          example: '2026-05-15'