Workday Financials Revenue Contracts API

openapi: 3.2.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Revenue Contracts 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: Revenue Contracts
  description: Manage revenue contracts and performance obligations
paths:
  /revenueContracts:
    get:
      operationId: listRevenueContracts
      summary: Workday Financials List revenue contracts
      description: Retrieve a collection of revenue contracts.
      tags:
      - Revenue Contracts
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter by contract status
        schema:
          type: string
          enum:
          - Draft
          - Active
          - Completed
          - Canceled
      responses:
        '200':
          description: Revenue contracts retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/RevenueContract'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /revenueContracts/{id}:
    get:
      operationId: getRevenueContract
      summary: Workday Financials Get a revenue contract
      description: Retrieve details of a specific revenue contract.
      tags:
      - Revenue Contracts
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Revenue contract details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevenueContract'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /revenueContracts/{id}/performanceObligations:
    get:
      operationId: listPerformanceObligations
      summary: Workday Financials List performance obligations for a contract
      description: Retrieve performance obligations associated with a revenue contract.
      tags:
      - Revenue Contracts
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Performance obligations retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PerformanceObligation'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    NotFound:
      description: The requested resource was not found
    Unauthorized:
      description: Authentication credentials are missing or invalid
  parameters:
    resourceId:
      name: id
      in: path
      required: true
      description: Unique identifier of the resource (WID)
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: Number of results to skip for pagination
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: Maximum number of results to return
      schema:
        type: integer
        default: 20
        maximum: 100
  schemas:
    PerformanceObligation:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the performance obligation
        name:
          type: string
          description: Name of the performance obligation
        transactionPrice:
          type: number
          format: double
          description: Allocated transaction price
        satisfactionMethod:
          type: string
          enum:
          - OverTime
          - PointInTime
          description: How the obligation is satisfied
        percentComplete:
          type: number
          format: double
          description: Percentage of obligation completed
          minimum: 0
          maximum: 100
        status:
          type: string
          enum:
          - Open
          - Satisfied
          - Canceled
          description: Current obligation status
    RevenueContract:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the revenue contract
        contractNumber:
          type: string
          description: Contract reference number
        customer:
          $ref: '#/components/schemas/CustomerRef'
        startDate:
          type: string
          format: date
          description: Contract start date
        endDate:
          type: string
          format: date
          description: Contract end date
        totalContractValue:
          type: number
          format: double
          description: Total contract value
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        status:
          type: string
          enum:
          - Draft
          - Active
          - Completed
          - Canceled
          description: Current contract status
        revenueRecognitionStandard:
          type: string
          enum:
          - ASC_606
          - IFRS_15
          description: Revenue recognition standard applied
        company:
          $ref: '#/components/schemas/CompanyRef'
    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)
    CustomerRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the customer
        descriptor:
          type: string
          description: Display name of the customer
  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