Workday Financials Receipts API

Upload and manage expense receipts

OpenAPI Specification

workday-financials-receipts-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Receipts 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: Receipts
  description: Upload and manage expense receipts
paths:
  /receipts:
    post:
      operationId: uploadReceipt
      summary: Workday Financials Upload a receipt
      description: Upload a receipt image for attachment to an expense item.
      tags:
      - Receipts
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  format: binary
                  description: Receipt image file
                description:
                  type: string
                  description: Description of the receipt
      responses:
        '201':
          description: Receipt uploaded successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /receipts/{id}:
    get:
      operationId: getReceipt
      summary: Workday Financials Get a receipt
      description: Retrieve details of a specific receipt.
      tags:
      - Receipts
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Receipt details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Receipt'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    delete:
      operationId: deleteReceipt
      summary: Workday Financials Delete a receipt
      description: Delete a receipt that is not attached to a submitted expense report.
      tags:
      - Receipts
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '204':
          description: Receipt deleted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /goodsReceipts:
    get:
      operationId: listGoodsReceipts
      summary: Workday Financials List goods receipts
      description: Retrieve a collection of goods receipts.
      tags:
      - Receipts
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Goods receipts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/GoodsReceipt'
        '401':
          $ref: '#/components/responses/Unauthorized'
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
  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
  schemas:
    GoodsReceipt:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the goods receipt
        receiptNumber:
          type: string
          description: Goods receipt number
        purchaseOrder:
          $ref: '#/components/schemas/PurchaseOrderRef'
        receiptDate:
          type: string
          format: date
          description: Date goods were received
        status:
          type: string
          enum:
          - Received
          - Partially Received
          - Returned
          description: Receipt status
    Receipt:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the receipt
        fileName:
          type: string
          description: Name of the uploaded receipt file
        contentType:
          type: string
          description: MIME type of the receipt file
        uploadedOn:
          type: string
          format: date-time
          description: When the receipt was uploaded
        description:
          type: string
          description: Description of the receipt
    PurchaseOrderRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the purchase order
        descriptor:
          type: string
          description: Display name of the purchase order
  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