Workday Connector Guide > Objects Specifications
  

Objects Specifications

The following tables provide information on different objects present in Workday connector.
Object Name
WorkerExport
Primary Key
WorkerWID
Services Invoked
Get_Workers,Get_Employee_Personal_Info
Parent Object
Not Available
Foreign Key
Not Available
Description
The WorkerExport object fetches information of workers. The information such as, Reference Data, Personal Data, Employment Data, Compensation Data, Organization Data, Role Data and corresponding worker manager details. The object can fetch up to 10 levels of worker manager hierarchy.
Filter Fields
Field Name
Data Type
Value
WorkerWID, ContingentWorkerID, EmployeeID, TransactionTypeWID, BusinessProcessType, SubscriberWID, IntegrationServiceName, IntegrationServiceID, OrgObjWID, OrgObjCompanyRefID, OrgObjCostCenterRefID, OrgObjCustomOrgRefID, OrgObjOrgRefID, OrgObjRegionRefID, PositionWID, PositionID, EventWID, BusinessPlanAmendmentID, CustomerRequestID, CustomerRequestReferenceID, IRS1099MISCAdjustmentID, PositionBudgetGroupID, ReceiptNumber, RequestLeaveofAbsenceID, SpendAuthorizationID, SupplierContractAmendmentID, SupplierContractHistoryID, SupplierContractID, SupplierInvoiceContractID, WorkdayProjectID, WorkerTimeCardID, BenefitPlanWID, AdditionalBenefitsPlanID, DefinedContributionPlanID, HealthCareCoveragePlanID, HealthSavingsAccountPlanID, InsuranceCoveragePlanID, SpendingAccountPlanID, FieldandParameterWID, FieldandParameterIntegrationSystemID, NationalIdentifierID, NationalIDTypeWID, NationalIDTypeCode, CountryWID, CountryCode
String
Any String
AsOfEffectiveDate
Date
Any Date
RecordCount
Integer
0<n<1000
UpdatedFromDateTime, UpdatedThroughDateTime, EffectiveFromDateTime, EffectiveThroughDateTime, AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances, IncludeSubordinateOrganizations, ExcludeInactiveWorkers, ExcludeEmployees, ExcludeContingentWorkers
Boolean
0/1
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for Worker Export. Refer To get incremental updatessection
Object Name
Compensation
Primary Key
WorkerWID
Services invoked
Get_Workers
Parent Object
WorkerExport
Foreign Key
WorkerWID
Description
The Compensation object retrieves the Employee Compensation Summary, Annualized Summary, Data Element Summary Consisting of Information of a Worker Converted to their Pay Group Frequency.
Additionally retrieves Annualized Summary of Reporting Currency Data, Data Element Compensation summary for worker in an hourly frequency, when the worker is paid in terms of hours.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Education
Primary Key
WorkerWID
Parent Object
WorkerExport
Services Invoked
If Education object is source then Get_Workers is invoked else either Update_Employee_Personal_Info or Update_Contingent_Worker_Personal_Info will be invoked
Foreign Key
WorkerWID
Description
The object Education encapsulates data such as, Education Institution, Educational Institution Type, Degree, Completion of Degree, Field of Study, Location, and Academic Dates.
Filter Fields
Same as WorkerExport object.
Remarks
WorkerWID field is mandatory to update Education
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Experience
Primary Key
WorkerWID
Services invoked
If Experience object is source then Get_Workers is invoked else either Update_Employee_Personal_Info or Update_Contingent_Worker_Personal_Info will be invoked
Parent Object
WorkerExport
Foreign Key
WorkerWID
Description
The object Experience encapsulates data such as, Professional Experience, Professional Experience Rating Reference and Professional Experience Comment.
Filter Fields
Same as WorkerExport object.
Remarks
WorkerWID field is mandatory to update Experience.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
LeaveStatus
Primary Key
WorkerWID
Services Invoked
Get_Workers
Parent Object
WorkerExport
Foreign Key
WorkerWID
Description
The object LeaveStatus encapsulates data such as, Leave Start Date, Estimated Leave End Date, Leave End Date, On Leave, Leave Type Name, Benefits Effect, Payroll Effect, Paid Time of Accrual Effect, Continuous Service Accrual Effect, and Stock Vesting Effect.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100.
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Organization
Primary Key
OrganizationId, OrganizationSystemId
Parent Object
Not Available
Services Invoked
If Organization object is source then Get_Organization,Find_Organization will be invoked else Add_Update_Organization
Foreign Key
Not Available
Description
The Organization object retrieves data related to an Organization (e.g. Staffing Configuration, Structure, Superior Organization details, Organization Type, Organization Sub type, Organization Visibility. It is used to add or update an organization
Filter Fields
Field Name
Data Type
Value
OrganizationSystemId, OrganizationId, OrganizationName, LocationIntegrationSystemId, LocationIntegrationId , EmployeeIntegrationSystemId, EmployeeIntegrationId, ContingentWorkerSystemId, ContingentWorkerId
String
Any String
AsOfDate
Date
Any Date
AsOfMoment
DateTime
Any DateTime
Remarks:
To add an organization OrganizationSystemId, OrganizationId and OrganizationReferenceID fields must be empty
OrganizationTypeName, OrganizationSubtypeName, OrganizationVisibilityName, AvailabilityDate , OrganizationName fields should be provided for adding an organization
Either OrganizationReferenceID or both OrganizationSystemId and OrganizationId fields must be provided for updating organization
Always enter OrganizationName field or OrganizationCode and IncludeOrganizationCodeInName as “true” to add an Organization
Note: Use “RecordCount” field to specify the batch size. Default size is 100.
Object Name
Person
Services Invoked
Either Update_Employee_Personal_Info or Update_Contingent_Worker_Personal_Info
Description
Person object updates Contact information, Demographic details, and Identification data of a person.
Filter Fields
Not Available
Object Name
WorkerOrganization
Primary Key
WorkerWID
Parent Object
WorkerExport
Services Invoked
Get_Workers
Foreign Key
WorkerWID
Description
WorkerOrganization object encapsulates the worker organization details.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100.
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Locations
Primary Key
LocationReferenceWID
Services Invoked
Get_Locations
Description
Locations object retrieves data corresponding to a location such as, Location ID, Location Name, Location Usage Reference, Location Type Reference, Superior Location Reference, Latitude and Longitude details, Locale Reference, Time Zone Reference and Contact Data.
Filter Fields
Field Name
Data Type
Value
LocationReferenceID, LocationReferenceWID, LocationName, LocationUsageID, LocationUsageWID, LocationTypeId , LocationTypeWID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstance, ExcludeInactiveLocations, ExcludeActiveLocations
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
LocationsHiearchy
Primary Key
LocationReferenceWID
Parent Object
Locations
Foreign Key
LocationReferenceWID
Services Invoked
Get_Locations
Description
The object LocationsHierarchy retrieves data corresponding to a location hierarchy such as, Location Reference details and Location hierarchy reference details.
Filter Fields
Field Name
Data Type
Value
LocationReferenceID, LocationReferenceWID, LocationName, LocationUsageID, LocationUsageWID, LocationTypeId , LocationTypeWID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstance, ExcludeInactiveLocations, ExcludeActiveLocations
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100.
Object Name
JobCategories
Primary Key
JobCategoryReferenceWID
Services Invoked
Get_Job_Categories
Description
The object JobCategories will fetch data based on specified criteria. The criteria can be of a single entry based on a Reference ID else the job categories will retrieve all data, if there are no criteria. Job Category data includes the Reference ID, the name and the description and inactive flag.
Filter Fields
Field Name
Data Type
Value
JobCategoryReferenceWID, JobCategoryReferenceID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
JobClassificationGroups
Primary Key
JobClassificationGroupWID
Services invoked
Get_Job_Classification_Groups
Description
The object JobClassificationGroups provide data such as, Classification group reference, Location Reference.
Filter Fields
Field Name
Data Type
Value
JobClassificationGroupWID, JobClassificationGroupID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
JobFamilies
Primary Key
JobFamilyWID
Services invoked
Get_Job_Families
Description
The object JobFamilies provide data such as, Classification group reference, Location Reference.
Filter Fields
Field Name
Data Type
Value
JobClassificationGroupWID, JobClassificationGroupID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstance,
IncludeJobProfileInfoData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PotentialAssessment
Primary Key
WorkerWID
Parent Object
WorkerExport
Foreign Key
WorkerWID
Services Invoked
Get_Workers
Description
The object PotentialAssessment provides talent assessment data such as, Potential reference, Achievable Level of the Employee,
Retention status of the Employee, Loss Impact Status of the Employee and Notes of the Talent Assessment.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
Employee Review
Primary Key
WorkerWID
Parent Object
WorkerExport
Foreign Key
WorkerWID
Description
The object Employee Review retrieves performance data such as, performance improvement plan for the employee, development plan for the employee and disciplinary action for the employee.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
JobProfiles
Primary Key
JobProfileWID
Parent Object
Not Available
Foreign Key
Not Available
Services Invoked
Get_Job_Profiles
Description
The object JobProfiles contains information such as, Job Classification data for a Job Profile, Job Profile Pay Rate Data and qualification data for a Position Restriction or Job Profile.
Filter Fields
Field Name
Data Type
Value
JobProfileWID, JobProfileID, TransactionTypeWID, BusinessProcessType, SubscriberWID, IntegrationServiceName, IntegrationserviceID,
EventIID, EventWID, JobFamilyWID, JobFamilyID, ManagementLevelWID, ManagementLevelID, JobLevelWID, JobLevelID, JobCategoryReferenceWID, JobCategoryReferenceID, CompanyInsiderTypeWID, CompanyInsiderTypeID, JobClassificationReferenceWID, JobClassificationReferenceID, JobClassificationGroupWID, JobClassificationGroupID, WorkerCompensationCodeWID, WorkersCompensationID, WorkHoursProfileWID,WorkHoursProfileID, FieldandParameterWID,IntegrationSystemID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedThroughDateTime, EffectiveFromDateTime, EffectiveThroughDateTime, AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances,IncludeJobProfileBasicData, IncludeJobClassificationData, IncludeJobProfilePayRateData, IncludeJobProfileExemptData, IncludeWorkersCompensationData, IncludeResponsibilityQualifications, IncludeWorkExperienceQualifications, IncludeEducationQualifications, IncludeLanguageQualifications, IncludeCompetencyQualifications, IncludeCertificationQualifications, IncludeTrainingQualifications, IncludeJobProfileCompensationData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
EventHistory
Services Invoked
Get_Workers,Get_Worker_Event_History
Description
The object EventHistory retrieves all references pertaining to all events (created through workflow) associated with a Worker based on Event Type and Date parameters.
Filter Fields
Field Name
Data Type
Value
EmployeeSystemID, ContingentWorkerSystemID
String
Any String
UpdatedFromDateTime, UpdatedToDateTime, EffectiveFromDateTime, EffectiveThroughDateTime
DateTime
Any DateTime
Remarks:
If “EffectiveFromDateTime” or “EffectiveThroughDateTime” filter fields contain a value, then both the fields are required.
Note: Incremental updates are supported for this object. Refer To get incremental updatessection.
Object Name
WorkerRole
Primary Key
WorkerWID
Parent Object
WorkerExport
Foreign Key
WorkerWID
Services Invoked
Get_Workers
Description
The object WorkerRole retrieves data such as, Organization Role Reference, Role Assigner Reference, Effective Date and the role assigned to the worker.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Ethnicity
Primary Key
WorkerWID
Parent Object
WorkerExport
Foreign Key
WorkerWID
Services Invoked
Get_Workers
Description
The object Ethnicity provides data related to ethnicity of the worker.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
TransactionLog
Primary Key
WorkerWID
Parent Object
WorkerExport
Foreign Key
WorkerWID
Services Invoked
Get_Workers
Description
The object TransactionLog encapsulates data such as, TransactionLog Reference, Description of the TransactionLog, Effective Moment of the Transaction, Entry Moment of the Transaction, TransactionLog types of the Transaction and Transaction Targets.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Training
Primary Key
WorkerWID
Parent Object
WorkerExport
Services invoked
Get_Workers
Description
This object retrieves training program information of a worker. It captures training reference, training type, training duration and training completed date.
Filter Fields
Same as WorkerExport object.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
JobHistory
Primary Key
WorkerWID
Services Invoked
Get_Previous_System_Job_History
Description
This object captures previous system job history reference, previous position and current position details
Filter Fields
Field Name
Data Type
Value
WorkerWID
ContingentWorkerID
EmployeeID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
Employee
Primary Key
Auto generated
Services invoked
Hire_Employee
Description
Hires an Employee to Workday system.
Filter Fields
Not Available
Remarks
EmployeeTypeID, PositionTimeTypeID and PositionTitle are mandatory fields to hire an Employee.
Object Name
Position
Primary Key
PositionID
Services Invoked
Get_Positions
Description
Provides position details which include position reference, supervisory organization, and job requisition data for position, position status, position time type, worker reference, required education level, default compensation data and job family reference.
Filter Fields
Field Name
Data Type
Value
Position, PositionID, PositionWID, TransactionLogType
TransactionLogTypeWID, BusinessProcessType
Subscriber, SubscriberWID, ubscriberIntegrationService
SubscriberIntegrationSystemID, SupervisoryOrganization
SupervisoryOrganizationWID, OrganizationReferenceID
JobRequisition, JobRequisitionWID, JobRequisitionIDEvent, EventWID, ackgroundCheckID, BudgetAmendmentID, CustomerRequestID, CustomerRequestReferenceID, IRS1099MISCAdjustmentID, PositionBudgetGroupID
ProcurementMassCloseID, ProcurementRollForwardID
ReceiptNumber, ReorganizationID, RequestLeaveofAbsenceID, SpendAuthorizationID
SupplierContractAmendmentID, SupplierContractHistoryID, SupplierContractID
SupplierInvoiceContractID, WorkdayProjectID
WorkerTimeCardID, ProviderRef, ProviderWID
IntegrationSystemID, Location, LocationWID
LocationID, AddtnLocation1, AddtnLocationWID1
AddtnLocationID1, AddtnLocation2, AddtnLocationWID2, AddtnLocationID2, AddtnLocation3, AddtnLocationWID3, AddtnLocationID3, AddtnLocation4
AddtnLocationWID4, AddtnLocationID4
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedThroughDateTime
EffectiveFromDateTime, EffectiveThroughDateTime
DateTime
Any DateTime
IncludeReference, IncludePositionDefinitionData
IncludePositionRestrictionsData, IncludeDefaultCompensationData,
IncludeDefaultPositionOrganization, AssignmentData
IncludeWorkerForFilledPositionsData
IncludeQualifications, IncludeJobRequisitionData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection.
Object Name
Applicant
Primary Key
ApplicantID
Services Invoked
Get_Applicants
Description
This object encapsulates applicant personal information data and recruiting information data
Filter Fields
Field Name
Data Type
Value
ApplicantID, ApplicantWID, EmployeeRef, EmployeeRefWID, EmployeeRefID, ApplicantEmailAddress, ProviderReference, ProviderReferenceWID, IntegrationSystemID, ApplicantID
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
AsOfEffectiveDate
Date
Any Date
IncludePersonalInfo
IncludeRecruitInfo
IncludeQualProfile
IncludeExternalIntegrationIDData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
TerminateEmployee
Services Invoked
Terminate_Employee
Description
This object helps terminate an employee from workday system
Object Name
CostCenters
Primary Key
CostCenterReferenceWID
Services Invoked
Get_Cost_Centers
Description
The CostCenters object will provide data such as, Effective Date, Organization Data, Organization Subtype and Work tags, Organization Data include Id, Organization Name, Organization Code, Include Organization Code in Name, Organization Active, Availability Date, Organization Visibility, External URL and Integration ID Data.
Filter Fields
Field Name
Data Type
Value
CostCenterReferenceWID, CostCenterReferenceID, OrganizationReferenceID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
IncludeCostCenterData, IncludeSimpleCostCenterData
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If “WTType” or “WTReferenceID” filter fields contain a value, then both the fields are required.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
CostCentersCustomOrg
Primary Key
CostCenterReferenceWID
Parent Object
CostCenters
Foreign Key
CostCenterReferenceWID
Services Invoked
Get_Cost_Centers
Description
The object CostCentersCustomOrg encapsulates data such as, Cost Center Reference details and Cost Center Organization Container reference details.
Filter Fields
Field Name
Data Type
Value
CostCenterReferenceWID, CostCenterReferenceID, OrganizationReferenceID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
IncludeCostCenterData, IncludeSimpleCostCenterData
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If “WTType” or “WTReferenceID” filter fields contain a value, then both the fields are required.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Regions
Primary Key
RegionsWID
Services Invoked
Get_Regions
Description
The object Regions provides data such as, Effective Data, Organization Data and Organization Subtype. Organization Data include Id, Organization Name, Organization Code, Organization Code in Name, Organization Active, Availability Date, Organization Visibility, External URL and Integration ID Data.
Filter Fields
Field Name
Data Type
Value
RegionWID ,RegionRefID ,OrganizationReferenceID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
IncludeRegionData, IncludeSimpleRegionData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
RegionsCustomOrg
Primary Key
RegionsWID
Parent Object
Regions
Foreign Key
RegionsWID
Services Invoked
Get_Regions
Description
The object RegionsCustomOrg provides data such as, Region reference data and Organization Container reference details.
Filter Fields
Field Name
Data Type
Value
RegionWID ,RegionRefID ,OrganizationReferenceID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
IncludeRegionData, IncludeSimpleRegionData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
WorkdayCompanies
Primary Key
CompanyReferenceWID
Description
The object WorkdayCompanies includes data such as, Company Tax ID, Organization data, Contact Information data, Accounting data, and company specific Sequence Generators.
Filter Fields
Field Name
Data Type
Value
CompanyReferenceWId , CompanyReferenceId , OrganizationReferenceID , CompanyName , OrganizationCode
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
WorkdayCompaniesCustomOrg
Primary Key
CompanyReferenceWID
Parent Object
WorkdayCompanies
Foreign Key
CompanyReferenceWID
Services Invoked
Get_Workday_Companies
Description
The object WorkdayCompaniesCustomOrg provides data such as, Workday Company reference data and Organization Container reference details.
Filter Fields
Field Name
Data Type
Value
CompanyReferenceWId , CompanyReferenceId , OrganizationReferenceID , CompanyName , OrganizationCode
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
LedgerAccountSummary
Primary Key
LedgerAccountSummaryWID
Services Invoked
Get_Ledger_Account_Summaries
Description
The object LedgerAccountSummary retrieves account summary data.
Filter Fields
Field Name
Data Type
Value
LedgerAccountSummaryID , LedgerAccountSummaryWID , LedgerAccountSummaryParentType , LedgerAccountSummaryParentID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
AllLedgerAccount
Primary Key
LedgerAccountSummaryWID
Parent Object
LedgerAccountSummary
Foreign Key
LedgerAccountSummaryWID
Services Invoked
Get_Ledger_Account_Summaries
Description
The object AllLedgerAccount retrieves Ledger account summary data including information about the account.
Filter Fields
Field Name
Data Type
Value
LedgerAccountSummaryID , LedgerAccountSummaryWID , LedgerAccountSummaryParentType , LedgerAccountSummaryParentID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
AccountSet
Primary Key
AccountSetWID
Services Invoked
Get_Account_Sets
Description
The object AccountSet retrieves data such as, Account Set Reference, the Ledger Accounts included in the Account Set, any included Account Sets, and the Chart of Accounts designation.
Filter Fields
Field Name
Data Type
Value
AccountSetWID, AccountSetRefID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
ConditionRuleData
Primary Key
CustomValidationContextRefWId
Services Invoked
Get_Custom_Validation_Rules
Description
The object ConditionRuleData retrieves data such as, Custom Validation Context Reference details, Condition Entry Option Reference, Source Condition Rule Reference, Target External field Reference and Target Instance Reference details.
Filter Fields
Field Name
Data Type
Value
CustomValidationContextRefWId, CustomValidationContextID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100.
Object Name
CustomValidationMessageData
Primary Key
CustomValidationContextRefWId
Parent Object
ConditionRuleData
Foreign Key
CustValidRuleID
Services Invoked
Get_Custom_Validation_Rules
Description
The object CustomValidationMessageData retrieves data such as, Custom Validation Context Reference details, Associated Condition Rule details and external field details.
Filter Fields
Field Name
Data Type
Value
CustomValidationContextRefWId, CustomValidationContextID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
JournalEntry
Primary Key
JournalEntryWID
Services Invoked
Get_Journals
Description
The object JournalEntry retrieves data such as, Journal Entry Reference, Journal Entry Status, Company, Currency, Ledger Period, Accounting Date, Journal Source, Transaction Date, Operational Transaction, Memo, Book Code.
Filter Fields
Field Name
Data Type
Value
JournalEntryWID, AccountingJournalID, OrgObjWID, OrgObjCompanyRefID, OrgObjCostCenterRefID, OrgObjCustomOrgRefID, OrgObjOrgRefID, OrgObjRegionRefID, JournalSourceWID, JournalSourceID, JournalNumber, JournalEntryStatusWID, JournalEntryStatusID, OriginatedByIID, OriginatedByWID, ApprovedByIID, ApprovedByWID, LedgerAccountWID, LedgerAccountID, LedAccParentWID, LedAccParentAccountSetID, WTWID, WTOrganizationReferenceID, WTType, WTReferenceID, BookWID, BookID
String
Any String
AccountingFromDate, AccountingToDate, AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
AdjustmentJournal, ReversedJournal, RecurringJournal, InterCompanyJournal, ThresholdMet
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
Preview data will be blank if there are no journals updated a day ago.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
JournalEntryLine
Primary Key
JournalEntry_AutoNumber
Parent Object
JournalEntry
Foreign Key
JournalEntryWID
Services Invoked
Get_Journals
Description
The object JournalEntry retrieves data such as, Journal Entry Reference, Journal Entry Status, Company, Currency, Ledger Period, Accounting Date, Journal Source, Transaction Date, Operational Transaction, Memo, Book Code.
Filter Fields
Field Name
Data Type
Value
JournalEntryWID, AccountingJournalID, OrgObjWID, OrgObjCompanyRefID, OrgObjCostCenterRefID, OrgObjCustomOrgRefID, OrgObjOrgRefID, OrgObjRegionRefID, JournalSourceWID, JournalSourceID, JournalNumber, JournalEntryStatusWID, JournalEntryStatusID, OriginatedByIID, OriginatedByWID, ApprovedByIID, ApprovedByWID, LedgerAccountWID, LedgerAccountID, LedAccParentWID, LedAccParentAccountSetID, WTWID, WTOrganizationReferenceID, WTType, WTReferenceID, BookWID, BookID
String
Any String
AccountingFromDate, AccountingToDate, AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime, UpdatedToDateTime, AsOfEntryDateTime
DateTime
Any DateTime
AdjustmentJournal, ReversedJournal, RecurringJournal, InterCompanyJournal, ThresholdMet
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
Preview data will be blank if there are no jounals updated a day ago.
JournalEntry_AutoNumber is an Informatica system generated number. It is a combination of JournalEntryWID_<Entry line order number>. The order id changes when the order is changed in the response received from workday.
If one of “WTType” or “WTReferenceID” filter fields contains a value, both the fields are required
Any value other than WorkTagWID and WorkTag Organization Reference is considered as WTType and corresponding value is stored in WTReferenceID field.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
Organizations
Primary Key
OrganizationWID
Services Invoked
If Organization object is source then Get_Organization,Find_Organization will be invoked else Add_Update_Organization
Foreign Key
Not Available
Services Invoked
Get_Organizations
Description
The object Organizations retrieves data such as, Organization Name , Description ,Organization Code ,Manager Reference,Organization Type,Organization Subtype,Availibility Date ,Organization Owner,Organization Visibility,External URL Reference and Supervisory Data.
Filter Fields
Field Name
Data Type
Value
OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrganizationReferenceID , OrganizationReferenceID , RegionReferenceID , OrganizationTypeWID , OrganizationTypeID , TransactionLogTypeWID , BusinessProcessType , SubscriberWID , SubIntegrationServiceName , SubIntegrationSystemID , ProviderRefWID , ProvIntegrationSystemI
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime , UpdatedThroughDateTime , EffectiveFromDateTime , EffectiveThroughDateTime , AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances ,IncludeInactive , IncludeRolesData , IncludeHierarchyData , IncludeSupervisoryData , IncludeStaffingRestrictionsData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
SubOrdinateOrganizations
Primary Key
SubOrdinateOrganizationWID
Parent Object
Organizations
Foreign Key
OrganizationWID
Services Invoked
Get_Organizations
Description
The object SubordinateOrganizations retrieves data such as, Subordinate Organization reference details including Organization reference details.
Filter Fields
Field Name
Data Type
Value
OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrganizationReferenceID , OrganizationReferenceID , RegionReferenceID , OrganizationTypeWID , OrganizationTypeID , TransactionLogTypeWID , BusinessProcessType , SubscriberWID , SubIntegrationServiceName , SubIntegrationSystemID , ProviderRefWID , ProvIntegrationSystemI
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime , UpdatedThroughDateTime , EffectiveFromDateTime , EffectiveThroughDateTime , AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances ,IncludeInactive , IncludeRolesData , IncludeHierarchyData , IncludeSupervisoryData , IncludeStaffingRestrictionsData
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If “IncludeHierarchyData” filter field is set to false, the data will not be retrieved.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection.
Object Name
IncludedOrganizations
Primary Key
IncludedOrganizationWID
Parent Object
Organizations
Foreign Key
OrganizationWID
Services Invoked
Get_Organizations
Description
The object IncludedOrganizations retrieves data such as, Included Organization reference details including Organization reference details.
Filter Fields
Field Name
Data Type
Value
OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrganizationReferenceID , OrganizationReferenceID , RegionReferenceID , OrganizationTypeWID , OrganizationTypeID , TransactionLogTypeWID , BusinessProcessType , SubscriberWID , SubIntegrationServiceName , SubIntegrationSystemID , ProviderRefWID , ProvIntegrationSystemI
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime , UpdatedThroughDateTime , EffectiveFromDateTime , EffectiveThroughDateTime , AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances ,IncludeInactive , IncludeRolesData , IncludeHierarchyData , IncludeSupervisoryData , IncludeStaffingRestrictionsData
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If “IncludeHierarchyData” filter field is set to false, the data will not be retrieved.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection.
Object Name
IncludedInOrganizations
Primary Key
IncludedInOrganizationWID
Parent Object
Organizations
Foreign Key
OrganizationWID
Services Invoked
Get_Organizations
Description
The object IncludedInOrganizations retrieves data such as Organization reference details including Organization reference details.
Filter Fields
Field Name
Data Type
Value
OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrganizationReferenceID , OrganizationReferenceID , RegionReferenceID , OrganizationTypeWID , OrganizationTypeID , TransactionLogTypeWID , BusinessProcessType , SubscriberWID , SubIntegrationServiceName , SubIntegrationSystemID , ProviderRefWID , ProvIntegrationSystemI
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime , UpdatedThroughDateTime , EffectiveFromDateTime , EffectiveThroughDateTime , AsOfEntryDateTime
DateTime
Any DateTime
SkipNonExistingInstances ,IncludeInactive , IncludeRolesData , IncludeHierarchyData , IncludeSupervisoryData , IncludeStaffingRestrictionsData
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If “IncludeHierarchyData” filter field is set to false, the data will not be retrieved.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection.
Object Name
ResourceCategories
Primary Key
ResourceCategoryReferenceWID
Services invoked
Get_Resource_Categories
Description
The object ResourceCategories retrieves data such as, Spend Category data for the service includes Spend Category ID, Spend Category Name, Procurement Usage flag, Expense Usage flag, Track Items flag, Accounting Treatment, Depreciation Profile, and UNSPSC Code Range.
Filter Fields
Field Name
Data Type
Value
ResourceCategoryReferenceWID , ResourceCategoryRefID
String
Any String
AsOfEffectiveDate
Date
Any Date
UpdatedFromDateTime , UpdatedToDateTime , AsOfEntryDateTime
DateTime
Any DateTime
IncludeReference
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Note: Incremental updates are supported for this object. Refer To get incremental updatessection
Object Name
CurrencyConversionRates
Primary Key
CurrencyConversionRateRequestReferencesIID
Services Invoked
Get_Currency_Conversion_Rates
Description
Currency Conversion Rate data includes the Effective Timestamp, the From and Target Currencies, the Rate Type, and the Currency Rate
Filter Fields
Field Name
Data Type
Value
CurrencyConversionRateRequestReferencesIID,
CurrencyConversionRateRequestReferencesWID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
BusinessPlanDetails
Primary Key
BusinessPlanReferenceWID
Services Invoked
Get_Business_Plan_Details
Description
Business Plan Year data includes the Business Plan Fiscal Year, the Year Status and the Business Plan Period. The Business Plan Period includes the Period status, and the Fiscal Period.
Filter Fields
Field Name
Data Type
Value
BusinessPlanReferenceIID, BusinessPlanReferenceWID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
WorkdayProjects
Primary Key
ProjectReferenceWID
Services Invoked
Get_Workday_Projects
Description
The object WorkdayProjects provides project data such as, Project ID, Description, Name, Reference, Start Date, End Date, Customer and Matrix Organization.
Filter Fields
Field Name
Data Type
Value
ProjectReferenceWID , ProjectID , WorkdayProjectID , ProjReferenceID , ProjectName , ProjectHierarchyWID , ProjectHierarchyID , ProjectStatusWID , DocumentStatusID , ProjectOwnerWID , ProjectOwnerContingentWorkerID , ProjectOwnerEmployeeID , , CustomerWID , CustomerID , CustomerReferenceID , ProjectGroupWID , ProjectGroupID , OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrgRefID , OrganizationReferenceID , RegionReferenceID , ProjectResourcePlanWID , ProjectResourcePlanID , InitiativeWID , InitiativeReferenceID, WTWID ,WTOrganizationReferenceID ,WTType,WTReferenceID, SuccessRatingWID , SuccessRatingID , AssignedWorkerWID , AssignedWorkerContingentWorkerID , AssignedWorkerEmployeeID
String
Any String
AsOfEffectiveDate
Date
Any Date
StartDateOnorAfter , StartDateOnorBefore , EndDateOnorAfter , EndDateOnorBefore ,AsofEntryDateTime
DateTime
Any DateTime
Billable , NonBillable , Both BillableandNonBillable
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If one of “WTType” or “WTReferenceID” filter fields contains a value, both fields are required.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
ProjectPlanData
Primary Key
PhaseID
Parent Object
WorkdayProjects
Foreign Key
ProjectReferenceWID
Services Invoked
Get_Workday_Projects
Description
The object Project Plan provides data such as, the activity Description, Due Date and Worker.
Filter Fields
Field Name
Data Type
Value
ProjectReferenceWID , ProjectID , WorkdayProjectID , ProjReferenceID , ProjectName , ProjectHierarchyWID , ProjectHierarchyID , ProjectStatusWID , DocumentStatusID , ProjectOwnerWID , ProjectOwnerContingentWorkerID , ProjectOwnerEmployeeID , , CustomerWID , CustomerID , CustomerReferenceID , ProjectGroupWID , ProjectGroupID , OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrgRefID , OrganizationReferenceID , RegionReferenceID , ProjectResourcePlanWID , ProjectResourcePlanID , InitiativeWID , InitiativeReferenceID, WTWID ,WTOrganizationReferenceID ,WTType,WTReferenceID, SuccessRatingWID , SuccessRatingID , AssignedWorkerWID , AssignedWorkerContingentWorkerID , AssignedWorkerEmployeeID
String
Any String
AsOfEffectiveDate
Date
Any Date
StartDateOnorAfter , StartDateOnorBefore , EndDateOnorAfter , EndDateOnorBefore ,AsofEntryDateTime
DateTime
Any DateTime
Billable , NonBillable , Both BillableandNonBillable
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If one of “WTType” or “WTReferenceID” filter fields contains a value, both fields are required.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
ResourcePlanData
Primary Key
DetailID
Parent Object
WorkdayProjects
Foreign Key
ProjectReferenceWID
Services Invoked
Get_Workday_Projects
Description
The object ResourcePlanData provides data such as, Activity Description, Due Date, Worker and Excluded Worker details.
Filter Fields
Field Name
Data Type
Value
ProjectReferenceWID , ProjectID , WorkdayProjectID , ProjReferenceID , ProjectName , ProjectHierarchyWID , ProjectHierarchyID , ProjectStatusWID , DocumentStatusID , ProjectOwnerWID , ProjectOwnerContingentWorkerID , ProjectOwnerEmployeeID , , CustomerWID , CustomerID , CustomerReferenceID , ProjectGroupWID , ProjectGroupID , OrganizationWID , CompanyReferenceID , CostCenterReferenceID , CustomOrgRefID , OrganizationReferenceID , RegionReferenceID , ProjectResourcePlanWID , ProjectResourcePlanID , InitiativeWID , InitiativeReferenceID, WTWID ,WTOrganizationReferenceID ,WTType,WTReferenceID, SuccessRatingWID , SuccessRatingID , AssignedWorkerWID , AssignedWorkerContingentWorkerID , AssignedWorkerEmployeeID
String
Any String
AsOfEffectiveDate
Date
Any Date
StartDateOnorAfter , StartDateOnorBefore , EndDateOnorAfter , EndDateOnorBefore ,AsofEntryDateTime
DateTime
Any DateTime
Billable , NonBillable , Both BillableandNonBillable
Boolean
0/1
RecordCount
Integer
0<n<1000
Remarks:
If one of “WTType” or “WTReferenceID” filter fields contains a value, both fields are required.
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
CompensationPayLevel
Primary Key
CompensationMatrixWID
Services Invoked
Get_Compensation_Matrices
Description
This object retrieves Merit Increase Matrices (MIMs) information such as compensation matrix reference, rating scale reference, non-weighted percent based data, weighted percent based data and amount based data.
Filter Fields
Field Name
Data Type
Value
CompensationMatrixWID, MeritIncreaseMatrixID, Name
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
AsOfEffectiveDate
Date
Any Date
CompensationMatrixAmountBased
CompensationMatrixNonweightedPercentBased
CompensationMatrixWeightedPercentBased
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollInputs
Primary Key
PayrollInputWID
Services Invoked
Get_Submit_Payroll_Inputs
Description
This object retrieves payroll input data from workday system such as start and end dates of payroll input, position reference, worker reference, earning and deduction references, company reference and payroll work-tag reference.
Filter Fields
Field Name
Data Type
Value
PayrollInputWID, PayrollInputID, WorkerWID
ContingentWorkerID, EmployeeID, EarningWID
EarningCode, WorkdayEarningCode, DeductionWID
DeductionCode, WorkdayDeductionCode
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
AsOfEffectiveDate, PayrollInputStartDate
PayrollInputEndDate
Date
Any Date
OpenEndedOngoingInputs
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PaymentHistory
Primary Key
PaymentHistoryWID
Services Invoked
Get_Payroll_History_Payments
Description
Retrieves Workday History Payments. History Payments in Workday are historical payments imported from external and/or legacy payroll systems
Filter Fields
Field Name
Data Type
Value
PaymentHistoryWID, PaymentID
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
AsOfEffectiveDate
Date
Any Date
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
OffcyclePayments
Primary Key
OffcyclePaymentWID
Services Invoked
Get_Payroll_Off-cycle_Payments
Description
This object retrieves offcycle payment data manual and on-demand
Filter Fields
Field Name
Data Type
Value
OffcyclePaymentReference, OffcyclePaymentWID
OffcyclePaymentID, EmployeeReference
EmployeeWID, EmployeeID, PeriodReference
PeriodWID, PeriodID, RunCategoryReference
RunCategoryWID, RunCategoryID, payGroupReference
PayGroupWID
PayGroupOrgReferenceID, BatchID, PaymentDate,
ReasonReference, ReasonWID, ActionReasonID
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
PaymentDate, AsOfEffectiveDate
Date
Any Date
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollResultsData
Primary Key
PayrollResultUniqueIdentifierWID
Services Invoked
Get_Payroll_Results
Description
Return Payroll Results for selected workers, companies, pay calculations for specified date range
Filter Fields
Field Name
Data Type
Value
PayrollResultUniqueIdentifierIID
PayrollResultUniqueIdentifierWID
StartDate, EndDate, PeriodSelectionDateWID
PeriodSelectionDateIndicator, EmployeeWID
EmployeeID, CompanyWID, CompanyReferenceID
EarningWID, EarningCode, WorkdayEarningCode
DeductionWID, DeductionCode, WorkdayDeductionCode, RunCategoryWID
RunCategoryID, PayGroupWID
PeriodWID, PeriodID, SettlementIID, SettlementWID
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
StartDate, EndDate, AsOfEffectiveDate
Date
Any Date
IncludeNameData, IncludeNationalIDData
IncludeRelatedCalculationResultData, IncludeWithholdingOrderData
IncludePayrollWorktagData, IncludeQTDData
IncludeYTDData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayAccumulationData
Services Invoked
Get_Payroll_Results
Description
Return pay accumulation data for selected workers, Companies, Pay Calculations for specified Date Range
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceWorkerData
Primary Key
OutsourcedPaymentGroupWID
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip worker remittance data for an outsourced payment group that was generated by a settlement run
Filter Fields
Field Name
Data Type
Value
OutsourcedPaymentGroupWID
OutsourcedPaymentGroupID
ManagerWID, ManagerContingentWorkerID
ManagerEmployeeID, PaymentIntervalStartDateReference
PaymentIntervalEndDateReference
ExternalFieldParameterInitializationWID
ExternalFieldParameterInitializationIntegrationSystemID
String
Any String
AsOfEntryDateTime
DateTime
Any DateTime
AsOfEffectiveDate, PaymentIntervalStartDateReference
PaymentIntervalEndDateReference
Date
Any Date
IncludeOriginatingContactData
IncludeOriginatingBankData
IncludeReceivingPartyContactData
IncludeReceivingPartyBankData
Boolean
0/1
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceGrossAndNetData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip gross and net data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceEarningsData
Primary Key
OutsourcedPaymentGroupWID
Services Invoked
PayrollRemittanceEarningsData
Description
Return payroll payslip earnings data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayslipsOffCycleData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip offcycle data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayslipIntegrationFieldResultData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip integration field result data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittancePayslipMessageData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip message data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceAbsencePlan
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip absence plan data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceTaxableWagesData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip taxable wages data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceEmployerPaidBenifitsData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip employee paid benefits data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceEmployeeTaxData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip employee tax data for an outsourced payment group that was generated by a settlement run.
Filter Fields
Object Name
PayrollRemittancePostTaxData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip post tax data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittancePreTaxData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip pre-tax data for an outsourced payment group that was generated by a settlement run
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayslipsPaymentData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip payment data for an outsourced payment group that was generated by a settlement run.
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
PayrollRemittanceTotalData
Services Invoked
Get_Payroll_Payslips
Description
Return payroll payslip total remittance data for an outsourced payment group that was generated by a settlement run.
Filter Fields
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
WorkerBonusData
Services Invoked
Get_Workers
Description
Provides bonus plan data of a worker.
Filter Fields
Same as WorkerExport object.
Object Name
Position
Services Invoked
Get_Positions to fetch positions
Create Position to create a position
Edit_Position to update an existing position
Description
Provides position details which includes position reference, supervisory organization, job requisition data for position, position status, position time type, worker reference, required education level, default compensation data and job family reference . We can also create or update a position using this object
Object Name
BankAccount
Services Invoked
Get_Bank_Accounts
Description
BankAccount data includes the Bank Account ID, Account Name, Financial Institution, Bank Branch, Account Closed flag, Routing Transit or Institution Number, Financial Account Number, Bank Identifier Code, IBAN, Payment Type
Filter Fields
Field Name
Data Type
Value
BankAccountWID, BankAccountID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
BankAccount
Primary Key
BankAccountWID
Services Invoked
Get_Bank_Accounts
Description
BankAccount data includes the Bank Account ID, Account Name, Financial Institution, Bank Branch, Account Closed flag, Routing Transit or Institution Number, Financial Account Number, Bank Identifier Code, IBAN, Payment Type
Filter Fields
Field Name
Data Type
Value
BankAccountWID, BankAccountID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Object Name
LeaveofAbsence
Services Invoked
Request_Leave_of_Absence
Description
This object helps you to add new leave of absence requests
Object Name
OverrideBalance
Primary Key
BankAccountWID
Services Invoked
Get_Override_Balances to fetch
Put_Override_Balance to add/update
Description
This object provides Time Off Plan Override Balances for an Employee and Time Off Plan. You can add or update a new Time Off Plan Override Balance record when you the object is selected in Target object list in ICS wizard.
Filter Fields
Field Name
Data Type
Value
OverrideBalanceReference
String
Any String
OverrideBalanceWID
Date
Any Date
CalculatedandOverrideBalanceIndex
DateTime
Any DateTime
EmployeeReference
Integer
0<n<1000
WorkerWID
String
Any String
ContingentWorkerID
String
Any String
EmployeeID
String
Any String
BatchReference
String
Any String
ApplicationBatchWID
String
Any String
ApplicationBatchID
String
Any String
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
DateTime
Any DateTime
RecordCount
Integer
0<n<1000
Note: Use “RecordCount” field to specify the batch size. Default size is 100
Object Name
VacationTimeOff
Services Invoked
Enter_Time_Off to add new entry
Adjust_Time_Off to update
Description
Through this object we can add new time off entries and adjust an existing time off entry
Object Name
FuturePaymentPlanData
Primary Key
CompensationPlanWID
Services Invoked
Get_Compensation_Plans to fetch entries,
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve future payment plan data and also add/modify a compensation plan.
Filter Fields
Field Name
Data Type
Value
CompensationPlanWID
String
Any String
CompensationPlanID
String
Any String
IncludeInactive
Boolean
0/1
AsOfEffectiveDate
Date
Any Date
AsOfEntryDateTime
Datetime
Any DateTime
RecordCount
Integer
0<n<1000
Object Name
VacationTimeOff
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve bonus plan data and also add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
MeritPlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve merit plan data and also add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
StockPlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve stock plan data and also add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
AllowancePlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve allowance plan data and also add/modify a compensation plan
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
CommissionPlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve commission plan data. You can also add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
BasePayPlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve base pay plan data. You can add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
PeriodPlanData
Services Invoked
Get_Compensation_Plans to fetch entries
Put_Compensation_Plans to add a new record or update existing record
Description
You can retrieve period plan data. You can also add/modify a compensation plan.
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
RequestOneTimePayment
Services Invoked
Request_One-Time_Payment
Description
This operation allows the requesting of a one-time payment for an employee
Filter Fields
Same as FuturePaymentPlanData object.
Object Name
RequestOneTimePayment
Services Invoked
Get_Workers of Human_Resources module
Add_Dependent,Edit_Dependent to add / update
Description
This object will provide dependent information of worker .
You can also add / update dependent for a worker using this
Filter Fields
Same as FuturePaymentPlanData object.