Workday Financials Purchase Orders API

openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Purchase Orders 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 Orders
  description: Manage purchase orders
paths:
  /purchaseOrders:
    get:
      operationId: listPurchaseOrders
      summary: Workday Financials List purchase orders
      description: Retrieve a collection of purchase orders.
      tags:
      - Purchase Orders
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter by order status
        schema:
          type: string
          enum:
          - Draft
          - Issued
          - Received
          - Closed
          - Canceled
      responses:
        '200':
          description: Purchase orders retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PurchaseOrder'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /purchaseOrders/{id}:
    get:
      operationId: getPurchaseOrder
      summary: Workday Financials Get a purchase order
      description: Retrieve details of a specific purchase order.
      tags:
      - Purchase Orders
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Purchase order details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PurchaseOrder'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /purchaseOrders/{id}/lines:
    get:
      operationId: listPurchaseOrderLines
      summary: Workday Financials List purchase order lines
      description: Retrieve line items for a specific purchase order.
      tags:
      - Purchase Orders
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Purchase order lines retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PurchaseOrderLine'
        '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)
    SupplierShortRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the supplier
        descriptor:
          type: string
          description: Display name of the supplier
    CompanyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the company
        descriptor:
          type: string
          description: Display name of the company
    PurchaseOrder:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the purchase order
        orderNumber:
          type: string
          description: Purchase order number
        supplier:
          $ref: '#/components/schemas/SupplierShortRef'
        orderDate:
          type: string
          format: date
          description: Date the order was placed
        totalAmount:
          type: number
          format: double
          description: Total order amount
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        status:
          type: string
          enum:
          - Draft
          - Issued
          - Received
          - Closed
          - Canceled
          description: Current order status
        company:
          $ref: '#/components/schemas/CompanyRef'
    PurchaseOrderLine:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the line item
        lineNumber:
          type: integer
          description: Line item number
        description:
          type: string
          description: Line item description
        quantity:
          type: number
          format: double
          description: Quantity ordered
        unitCost:
          type: number
          format: double
          description: Cost per unit
        extendedAmount:
          type: number
          format: double
          description: Total line amount
        spendCategory:
          type: string
          description: Spend category for the line item
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid
    NotFound:
      description: The requested resource was not found
  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