Workday connector specifications

Integrate with Workday to make it easy to submit requests, receive notifications about request status, and take actions.

Version details

Citrix microapps supports the latest Workday APIs.

Endpoints

Note:

Custom endpoints are not supported.

Absence Management Endpoint

Enter_Time_Off 
Get_Time_Off_Plan_Balances

Human Resources

Get_Organizations
Get_Workers

Inbox Tasks for Worker

GET List of Inbox Tasks
GET Inbox Task Details
PUT Approve Inbox Task by ID
PUT Deny Inbox Task by ID

Resource Management Endpoint

Get_Expense_Items
Get_Expense_Reports
Get_Purchase_Orders
Get_Resource_Categories
Get_Suppliers

Test API calls

This article lists all Workday API calls and provides a detailed description of how to test whether your Workday instance has all endpoints ready for these calls. For more information, see Test Workday API calls.

Service Actions

  • Change Job Inbox Approval - Approve Change Job request
  • Change Job Inbox Denial - Deny Change Job request
  • Expense Report Inbox Approval - Approve Expense Report
  • Expense Report Inbox Denial - Deny Expense Report
  • Time Off request Inbox Approval - Approve Time Off request
  • Time Off request Inbox Denial - Deny Time Off request
  • Request Time Off - Enter Time Off request

Key Entities

The following are the main business entities that this connector addresses:

  • Approvals/Denials
  • Employee Reviews – NO

Entities with Attributes

The following is a full list of entities and their attributes (Workday v.0.1.2):

Change Job Approval (Change Job Approvals)

  • id: STRING(100), PK
  • assigned_to_id: STRING(100), FK(User.id)
  • change_job_detail_id: STRING(100), FK(Change Job Detail.id)
  • description: STRING(255)
  • created_moment: DATETIME
  • step_type: STRING(100)
  • approve_deny_change_job_u: STRING(100)

Change Job Detail (Change Job Details)

  • id: STRING(100), PK
  • status: STRING(255)
  • job_profile_current: STRING(255)
  • job_profile_proposed: STRING(255)
  • job_title_current: STRING(255)
  • job_title_proposed: STRING(255)
  • region_current: STRING(255)
  • region_proposed: STRING(255)
  • cost_center_current: STRING(255)
  • cost_center_proposed: STRING(255)
  • company_current: STRING(255)
  • company_proposed: STRING(255)
  • position_current: STRING(255)
  • position_proposed: STRING(255)
  • reason_category: STRING(255)
  • work_shift_current: STRING(255)
  • work_shift_proposed: STRING(255)
  • weekly_sheduled_hours_current: LONG
  • work_space_current: STRING(255)
  • work_space_proposed: STRING(255)
  • location_current: STRING(255)
  • location_proposed: STRING(255)
  • transaction_effective_moment: DATETIME

Expense Item (List of Expense Items)

  • id: STRING(100), PK
  • name: STRING(-1)
  • description: STRING(-1)

Expense Report (List of Expense Reports)

  • id: STRING(100), PK
  • report_number: STRING(100)
  • submitted_by_id: STRING(100), FK(User.id)
  • submitted_on: DATETIME
  • approved_on: DATETIME
  • total_amount: FLOAT(prec=16, scale=4)
  • reimbursement_amount: FLOAT(prec=16, scale=4)
  • advance_amount: FLOAT(prec=16, scale=4)
  • status: STRING(255)

Expense Report Approval (Expense Report Approvals)

  • id: STRING(100), PK
  • assigned_to_id: STRING(100), FK(User.id)
  • expense_report_id: STRING(100), FK(Expense Report.id)
  • description: STRING(255)
  • created_moment: DATETIME

Expense Report Line (List of Expense Report Lines)

  • id: STRING(100), PK
  • report_id: STRING(100), FK(Expense Report.id)
  • billable: BOOLEAN
  • quantity: FLOAT(prec=16, scale=4)
  • amount: FLOAT(prec=16, scale=4)
  • tax_amount: FLOAT(prec=16, scale=4)
  • currency: STRING(255)
  • currency_rate: FLOAT(prec=16, scale=4)
  • converted_amount: FLOAT(prec=16, scale=4)
  • total_amount: FLOAT(prec=16, scale=4)
  • note: STRING(255)
  • expense_item_id: STRING(100), FK(Expense Item.id)
  • converted_currency: STRING(255)

Milestones

  • id: STRING(100)
  • created_moment: DATETIME
  • due_date: DATETIME
  • goal: STRING(-1)
  • milestone_name: STRING(-1)
  • status: STRING(-1)
  • worker_for_goal: STRING(-1)

Organization (List of Organizations)

  • id: STRING(100), PK
  • name: STRING(255)
  • type: STRING(255)

Purchase Order (List of Purchase Orders)

  • id: STRING(100), PK
  • document_number: STRING(100), PK
  • document_date: DATETIME
  • due_date: DATETIME
  • buyer_id: STRING(100), FK(User.id)
  • supplier_id: STRING(100), FK(Supplier.id)
  • other_charges: FLOAT(prec=16, scale=4)
  • tax_amount: FLOAT(prec=16, scale=4)
  • freight_amount: FLOAT(prec=16, scale=4)
  • total_amount: FLOAT(prec=16, scale=4)
  • description: STRING(-1)
  • status: STRING(255)

Purchase Order Item (List of Purchase Order Items)

  • id: STRING(100), PK
  • purchase_order_id: STRING(100), FK(Purchase Order.id)
  • category_id: STRING(100), FK(Spend Category.id)
  • quantity: FLOAT(prec=16, scale=4)
  • unit_cost: FLOAT(prec=16, scale=4)
  • extended_amount: FLOAT(prec=16, scale=4)
  • description: STRING(-1)
  • supplier_item_identifier: STRING(-1)

Spend Category (List of Spend Categories)

  • id: STRING(100), PK
  • name: STRING(255)

Supplier (List of Suppliers)

  • id: STRING(100), PK
  • name: STRING(255)

Time Off Plan Balance (List of Time Off Plan Balances)

  • id: STRING(100), PK
  • worker_id: STRING(100), FK(User.id)
  • amount: FLOAT(prec=16, scale=4)
  • unit: STRING(100)
  • time_off_plan_id: STRING(100), FK(Time Off Plan.id)
  • time_off_plan_descriptor: STRING(100)

Time Off Request (List of Time Off Requests)

  • id: STRING(100)
  • submitted_by_id: STRING(100)
  • created_moment: DATETIME
  • due_date: DATETIME
  • status: STRING(100)
  • total_hours: FLOAT(prec=10, scale=2)
  • total_days: FLOAT(prec=10, scale=2)

Time Off Request Approval (List of Time Off Requests for Approval)

  • id: STRING(100)
  • assigned_to_id: STRING(100)
  • assigned_to_email: STRING(100)
  • time_off_request_id: STRING(100)
  • description: STRING(255)
  • created_moment: DATETIME

Time Off Request Item (List of Time Off Request Items)

  • id: STRING(100)
  • time_off_request_id: STRING(100)
  • time_off_type_id: STRING(100)
  • time_off_type_descriptor: STRING(100)
  • date: DATETIME
  • day_of_the_week: STRING(100)
  • quantity_requested: FLOAT(prec=10, scale=2)
  • unit_of_time: STRING(100)
  • comment: STRING(100)

Time Off Worker Plan Type (List of all Time Off Types)

  • id: STRING(100)
  • descriptor: STRING(255)
  • plan_id: STRING(100)
  • plan_descriptor: STRING(255)
  • time_off_type_id: STRING(100)
  • time_off_type_descriptor: STRING(255)
  • default_value: FLOAT(prec=10, scale=2)
  • worker_id: STRING(100)
  • time_off_plan_balance_id: STRING(100)
  • date_for_date_picker: DATE

User (List of Workday users)

  • id: STRING(100), PK
  • worker_id: STRING(100)
  • user_id: STRING(100)
  • name: STRING(255)
  • email: STRING(255)
  • phone: STRING(255)
  • manager_id: STRING(100), FK(User.id)
  • business_title: STRING(255)
  • hire_date: DATE
  • worker_type: STRING(255)
  • full_time_equivalent_percentage: FLOAT(prec=16, scale=4)
  • work_location: STRING(255)
  • work_address: STRING(255)
  • organization_id: STRING(100), FK(Organization.id)

User Organization Membership (User-Organization Membership)

  • user_id: STRING(256), FK(User.id)
  • organization_id: STRING(256), FK(Organization.id)
Workday connector specifications