Workday Financials Purchase Requisitions API

Create and manage purchase requisitions

OpenAPI Specification

workday-financials-purchase-requisitions-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Purchase Requisitions 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
servers:
- url: https://{tenant}.workday.com/api/cashManagement/v38.2
  description: Workday Cash Management Production
  variables:
    tenant:
      description: Workday tenant identifier
      default: your-tenant
security:
- bearerAuth: []
tags:
- name: Purchase Requisitions
  description: Create and manage purchase requisitions
paths:
  /purchaseRequisitions:
    get:
      operationId: listPurchaseRequisitions
      summary: Workday Financials List purchase requisitions
      description: Retrieve a collection of purchase requisitions.
      tags:
      - Purchase Requisitions
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter by requisition status
        schema:
          type: string
          enum:
          - Draft
          - Submitted
          - Approved
          - Denied
          - Canceled
      responses:
        '200':
          description: Purchase requisitions retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PurchaseRequisition'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createPurchaseRequisition
      summary: Workday Financials Create a purchase requisition
      description: Submit a new purchase requisition for approval.
      tags:
      - Purchase Requisitions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseRequisitionCreate'
      responses:
        '201':
          description: Purchase requisition created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseRequisition'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /purchaseRequisitions/{id}:
    get:
      operationId: getPurchaseRequisition
      summary: Workday Financials Get a purchase requisition
      description: Retrieve details of a specific purchase requisition.
      tags:
      - Purchase Requisitions
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Purchase requisition details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseRequisition'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    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
  schemas:
    CurrencyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the currency
        descriptor:
          type: string
          description: Currency code (e.g., USD, EUR)
    PurchaseRequisition:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the purchase requisition
        requisitionNumber:
          type: string
          description: System-generated requisition number
        requester:
          $ref: '#/components/schemas/WorkerRef'
        description:
          type: string
          description: Requisition description
        totalAmount:
          type: number
          format: double
          description: Total requisition amount
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        status:
          type: string
          enum:
          - Draft
          - Submitted
          - Approved
          - Denied
          - Canceled
          description: Current requisition status
        company:
          $ref: '#/components/schemas/CompanyRef'
        createdOn:
          type: string
          format: date-time
          description: When the requisition was created
    WorkerRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the worker
        descriptor:
          type: string
          description: Display name of the worker
    CompanyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the company
        descriptor:
          type: string
          description: Display name of the company
    PurchaseRequisitionCreate:
      type: object
      required:
      - description
      - company
      properties:
        description:
          type: string
          description: Requisition description
        company:
          $ref: '#/components/schemas/CompanyRef'
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        lines:
          type: array
          items:
            $ref: '#/components/schemas/RequisitionLineCreate'
          description: Requisition line items
    SupplierShortRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the supplier
        descriptor:
          type: string
          description: Display name of the supplier
    RequisitionLineCreate:
      type: object
      required:
      - description
      - quantity
      - unitCost
      properties:
        description:
          type: string
          description: Line item description
        quantity:
          type: number
          format: double
          description: Quantity requested
        unitCost:
          type: number
          format: double
          description: Cost per unit
        supplier:
          $ref: '#/components/schemas/SupplierShortRef'
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
    NotFound:
      description: The requested resource was not found
    BadRequest:
      description: The request was malformed or contained invalid data
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token obtained from Workday authentication
externalDocs:
  description: Workday Cash Management API Documentation
  url: https://community.workday.com/sites/default/files/file-hosting/productionapi/index.html