Workday Financials Journal Entries API

Create and manage journal entries

OpenAPI Specification

workday-financials-journal-entries-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Workday Financials Workday Cash Management Account Reconciliations Journal Entries 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: Journal Entries
  description: Create and manage journal entries
paths:
  /journalEntries:
    get:
      operationId: listJournalEntries
      summary: Workday Financials List journal entries
      description: Retrieve a collection of journal entries.
      tags:
      - Journal Entries
      parameters:
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - name: status
        in: query
        description: Filter by journal entry status
        schema:
          type: string
          enum:
          - Draft
          - Submitted
          - Approved
          - Posted
          - Reversed
      - name: fromDate
        in: query
        description: Filter entries from this date
        schema:
          type: string
          format: date
      - name: toDate
        in: query
        description: Filter entries to this date
        schema:
          type: string
          format: date
      responses:
        '200':
          description: Journal entries retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  total:
                    type: integer
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/JournalEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
    post:
      operationId: createJournalEntry
      summary: Workday Financials Create a journal entry
      description: Create a new journal entry for financial accounting.
      tags:
      - Journal Entries
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JournalEntryCreate'
      responses:
        '201':
          description: Journal entry created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
  /journalEntries/{id}:
    get:
      operationId: getJournalEntry
      summary: Workday Financials Get a journal entry
      description: Retrieve details of a specific journal entry.
      tags:
      - Journal Entries
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Journal entry details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
  /journalEntries/{id}/post:
    post:
      operationId: postJournalEntry
      summary: Workday Financials Post a journal entry
      description: Post an approved journal entry to the general ledger.
      tags:
      - Journal Entries
      parameters:
      - $ref: '#/components/parameters/resourceId'
      responses:
        '200':
          description: Journal entry posted successfully
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          description: Journal entry is not in a valid state for posting
  /journalEntries/{id}/reverse:
    post:
      operationId: reverseJournalEntry
      summary: Workday Financials Reverse a journal entry
      description: Create a reversal of a posted journal entry.
      tags:
      - Journal Entries
      parameters:
      - $ref: '#/components/parameters/resourceId'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reversalDate:
                  type: string
                  format: date
                  description: Date for the reversal entry
      responses:
        '201':
          description: Journal entry reversed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JournalEntry'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  schemas:
    JournalLine:
      type: object
      properties:
        ledgerAccount:
          $ref: '#/components/schemas/LedgerAccountRef'
        debitAmount:
          type: number
          format: double
          description: Debit amount for this line
        creditAmount:
          type: number
          format: double
          description: Credit amount for this line
        memo:
          type: string
          description: Line-level memo
        costCenter:
          $ref: '#/components/schemas/CostCenterRef'
    CurrencyRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the currency
        descriptor:
          type: string
          description: Currency code (e.g., USD, EUR)
    CostCenterRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the cost center
        descriptor:
          type: string
          description: Display name of the cost center
    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
    LedgerAccountRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the ledger account
        descriptor:
          type: string
          description: Display name of the ledger account
    JournalEntry:
      type: object
      properties:
        id:
          type: string
          description: Workday ID (WID) for the journal entry
        journalNumber:
          type: string
          description: System-generated journal entry number
        journalDate:
          type: string
          format: date
          description: Date of the journal entry
        description:
          type: string
          description: Description of the journal entry
        status:
          type: string
          enum:
          - Draft
          - Submitted
          - Approved
          - Posted
          - Reversed
          description: Current status of the journal entry
        journalSource:
          type: string
          description: Source of the journal entry
        company:
          $ref: '#/components/schemas/CompanyRef'
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        totalDebit:
          type: number
          format: double
          description: Total debit amount
        totalCredit:
          type: number
          format: double
          description: Total credit amount
        lines:
          type: array
          items:
            $ref: '#/components/schemas/JournalLine'
        accountingPeriod:
          $ref: '#/components/schemas/PeriodRef'
        createdBy:
          $ref: '#/components/schemas/WorkerRef'
        createdOn:
          type: string
          format: date-time
          description: When the journal entry was created
    JournalEntryCreate:
      type: object
      required:
      - journalDate
      - company
      - lines
      properties:
        journalDate:
          type: string
          format: date
          description: Date of the journal entry
        description:
          type: string
          description: Description of the journal entry
        company:
          $ref: '#/components/schemas/CompanyRef'
        currency:
          $ref: '#/components/schemas/CurrencyRef'
        lines:
          type: array
          items:
            $ref: '#/components/schemas/JournalLine'
          minItems: 2
          description: Journal entry lines (minimum two for debit/credit)
    PeriodRef:
      type: object
      properties:
        id:
          type: string
          description: Workday ID of the accounting period
        descriptor:
          type: string
          description: Display name of the period
  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
  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