openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management API
  description: >-
    API for managing cash positions, bank accounts, transactions, and cash
    forecasting within Workday Cash Management.
  version: v38.2
  contact:
    name: Workday Support
    url: https://www.workday.com/en-us/company/latest/support.html
  termsOfService: https://www.workday.com/en-us/legal.html
externalDocs:
  description: Workday Cash Management API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html
servers:
  - url: https://{tenant}.workday.com/api/cashManagement/v38.2
    description: Workday Cash Management Production
    variables:
      tenant:
        description: Workday tenant identifier
        default: your-tenant
tags:
  - name: Bank Accounts
    description: Manage bank accounts
  - name: Bank Transactions
    description: Access and manage bank transactions
  - name: Cash Forecasts
    description: Access cash forecasting data
  - name: Cash Positions
    description: View and manage cash positions
  - name: Payments
    description: Manage payment processing
security:
  - bearerAuth: []
paths:
  /bankAccounts:
    get:
      operationId: listBankAccounts
      summary: Workday Financials List bank accounts
      description: >-
        Retrieve a collection of bank accounts.
      tags:
        - Bank Accounts
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - name: active
          in: query
          description: Filter by active status
          schema:
            type: boolean
      responses:
        '200':
          description: Bank accounts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /bankAccounts/{id}:
    get:
      operationId: getBankAccount
      summary: Workday Financials Get a bank account
      description: >-
        Retrieve details of a specific bank account.
      tags:
        - Bank Accounts
      parameters:
        - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Bank account details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BankAccount'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /bankAccounts/{id}/transactions:
    get:
      operationId: listBankTransactions
      summary: Workday Financials List bank transactions for an account
      description: >-
        Retrieve bank transactions associated with a specific bank account.
      tags:
        - Bank Transactions
      parameters:
        - $ref: '#/components/parameters/resourceId'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - name: fromDate
          in: query
          description: Filter transactions from this date
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: Filter transactions to this date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Bank transactions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BankTransaction'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /cashPositions:
    get:
      operationId: listCashPositions
      summary: Workday Financials List cash positions
      description: >-
        Retrieve current cash positions across bank accounts.
      tags:
        - Cash Positions
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - name: asOfDate
          in: query
          description: Cash position as of this date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Cash positions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CashPosition'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /cashPositions/{id}:
    get:
      operationId: getCashPosition
      summary: Workday Financials Get a cash position
      description: >-
        Retrieve details of a specific cash position.
      tags:
        - Cash Positions
      parameters:
        - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Cash position details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashPosition'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /cashForecasts:
    get:
      operationId: listCashForecasts
      summary: Workday Financials List cash forecasts
      description: >-
        Retrieve cash forecast projections.
      tags:
        - Cash Forecasts
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - name: forecastDate
          in: query
          description: Forecast for this date
          schema:
            type: string
            format: date
      responses:
        '200':
          description: Cash forecasts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CashForecast'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /payments:
    get:
      operationId: listPayments
      summary: Workday Financials List payments
      description: >-
        Retrieve a collection of payments.
      tags:
        - Payments
      parameters:
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/offset'
        - name: status
          in: query
          description: Filter by payment status
          schema:
            type: string
            enum:
              - Pending
              - Approved
              - Processed
              - Canceled
      responses:
        '200':
          description: Payments retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /payments/{id}:
    get:
      operationId: getPayment
      summary: Workday Financials Get a payment
      description: >-
        Retrieve details of a specific payment.
      tags:
        - Payments
      parameters:
        - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Payment details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday authentication
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource (WID)
      schema:
        type: string
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 20
        maximum: 100
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
    NotFound:
      description: The requested resource was not found
  schemas:
    BankAccount:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the bank account
        accountName:
          type: string
          description: Name of the bank account
        accountNumber:
          type: string
          description: Bank account number (masked)
        bankName:
          type: string
          description: Name of the financial institution
        routingNumber:
          type: string
          description: Bank routing number
        accountType:
          type: string
          enum:
            - Checking
            - Savings
            - MoneyMarket
            - Investment
          description: Type of bank account
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        currentBalance:
          type: number
          format: double
          description: Current account balance
        active:
          type: boolean
          description: Whether the account is active
        company:
          $ref: '#/components/schemas/CompanyRef'
    BankTransaction:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the transaction
        transactionDate:
          type: string
          format: date
          description: Date of the transaction
        description:
          type: string
          description: Transaction description
        amount:
          type: number
          format: double
          description: Transaction amount
        transactionType:
          type: string
          enum:
            - Debit
            - Credit
          description: Type of transaction
        status:
          type: string
          enum:
            - Pending
            - Cleared
            - Reconciled
          description: Transaction status
        referenceNumber:
          type: string
          description: External reference number
    CashPosition:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the cash position
        bankAccount:
          $ref: '#/components/schemas/BankAccountRef'
        asOfDate:
          type: string
          format: date
          description: Date of the cash position
        openingBalance:
          type: number
          format: double
          description: Opening balance for the period
        closingBalance:
          type: number
          format: double
          description: Closing balance for the period
        totalInflows:
          type: number
          format: double
          description: Total cash inflows
        totalOutflows:
          type: number
          format: double
          description: Total cash outflows
        currency:
          $ref: '#/components/schemas/CurrencyRef'
    CashForecast:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the forecast
        forecastDate:
          type: string
          format: date
          description: Forecast date
        projectedInflows:
          type: number
          format: double
          description: Projected cash inflows
        projectedOutflows:
          type: number
          format: double
          description: Projected cash outflows
        projectedBalance:
          type: number
          format: double
          description: Projected ending balance
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        company:
          $ref: '#/components/schemas/CompanyRef'
    Payment:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the payment
        paymentNumber:
          type: string
          description: Payment reference number
        payee:
          type: string
          description: Payment recipient
        paymentDate:
          type: string
          format: date
          description: Date of the payment
        amount:
          type: number
          format: double
          description: Payment amount
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        paymentMethod:
          type: string
          enum:
            - Check
            - ACH
            - Wire
            - EFT
          description: Method of payment
        status:
          type: string
          enum:
            - Pending
            - Approved
            - Processed
            - Canceled
          description: Payment status
        bankAccount:
          $ref: '#/components/schemas/BankAccountRef'
    CompanyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the company
        descriptor:
          type: string
          description: Display name of the company
    CurrencyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the currency
        descriptor:
          type: string
          description: Currency code (e.g., USD, EUR)
    BankAccountRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the bank account
        descriptor:
          type: string
          description: Display name of the bank account