ODBC Driver for ADP

Build 25.0.9434

WorkAssignmentHistory

The view that returns the full historical record of work assignments for each associate. It tracks changes in position, department, or reporting structure over time. This view supports compliance, analytics, and employment verification.

Columns

Name Type References Description
PrimaryIndicator Boolean The Boolean value that indicates whether this work assignment record represents the worker's primary assignment. This field is used to distinguish the main employment relationship from secondary or concurrent assignments.
OfferExtensionDate Date The date on which an offer of employment or assignment was extended to the worker. This field is used for recruiting, onboarding, and compliance tracking.
OfferAcceptanceDate Date The date on which the worker accepted the employment or assignment offer. This field helps determine offer-to-hire timelines and onboarding efficiency metrics.
HireDate Date The official date on which the worker was hired. This field marks the beginning of the worker's employment relationship for Human Resources (HR) and payroll purposes.
SeniorityDate Date The date that is used to calculate the worker's seniority within the organization. This field determines tenure-based benefits, accruals, and eligibility thresholds.
ExpectedStartDate Date The date on which the worker was originally expected to begin the assignment. This field supports workforce planning and onboarding schedule tracking.
ActualStartDate Date The date on which the worker actually began the assignment. This field can differ from the expected start date and is used for accurate payroll, benefits, and compliance reporting.
TerminationDate Date The date on which the worker's employment or assignment ended. This field is used to determine final pay, benefits termination, and workforce status reporting.
AssignmentStatusCode String The code that identifies the current status of the work assignment record. This field links to standardized status definitions that govern employment state tracking.
AssignmentStatusCodeValue String The value that is associated with the assignment status code. This field provides the machine-readable representation that is used for data integration and workflow automation.
AssignmentStatusLongName String The full descriptive name of the assignment status. This field provides a clear label for HR and management reporting (for example, Active, On Leave, or Terminated).
AssignmentStatusreasonCodeValue String The code value that identifies the reason associated with the current assignment status. This field provides a standardized classification for status changes.
AssignmentStatusreasonCodeShortName String The abbreviated name that corresponds to the assignment-status reason code. This field provides a concise label for dashboards and compact reports.
AssignmentStatusreasonCodeLongName String The full descriptive name of the assignment-status reason code. This field provides the complete label for HR and audit reports.
AssignmentStatusEffectiveDate Date The effective date of the current assignment status. This field determines when the status change became active for payroll and employment records.
WorkerTypeCodeValue String The code value that identifies the worker type associated with this assignment (for example, Employee, Contractor, or Intern). This field supports labor classification and reporting.
WorkerTypeShortName String The abbreviated name that corresponds to the worker type code. This field provides a short label for quick display in reports and dashboards.
WorkerTypeLongName String The full descriptive name of the worker type code. This field provides a clear definition for reporting and workforce segmentation.
AssignmentTermCodeValue String The code value that identifies the term or duration of the worker's assignment (for example, Permanent, Temporary, or Fixed-Term). This field supports compliance and workforce planning analysis.
AssignmentTermCodeShortName String The abbreviated name that corresponds to the assignment term code. This field provides a compact label for reporting layouts and dashboard displays.
AssignmentTermCodeLongName String The full descriptive name of the assignment term code. This field provides a clear explanation of the assignment type for HR and management use.
WorkLevelCodeValue String The code value that identifies the work level or grade associated with the assignment (for example, Entry-Level, Manager, or Executive). This field supports organizational hierarchy tracking and compensation analysis.
WorkLevelCodeShortName String The abbreviated name that corresponds to the work level code. This field provides a short label used in dashboards and compact tables.
WorkLevelCodeLongName String The full descriptive name of the work level code. This field provides the complete label that appears in HR reports and job classification documents.
NationalityContextCodeValue String The code value that identifies the nationality context associated with the assignment. This field defines how nationality-specific policies or compliance rules are applied.
NationalityContextCodeShortName String The abbreviated name that corresponds to the nationality context code. This field provides a short label that is used in dashboards and internal reports.
NationalityContextCodeLongName String The full descriptive name of the nationality context code. This field provides the complete name that is displayed in HR reports and compliance summaries.
VipIndicator Boolean The Boolean value that indicates whether the worker is classified as a VIP. This field is used to flag high-profile or confidential employees within HR and payroll systems.
VipTypeCodeValue String The code value that identifies the type of VIP classification (for example, Executive Leadership, Key Contributor, or Confidential Employee). This field defines the VIP group or classification assigned to the worker.
VipTypeCodeShortName String The abbreviated name that corresponds to the VIP type code. This field provides a short label for reports and quick reference views.
VipTypeCodeLongName String The full descriptive name of the VIP type code. This field provides the complete label that appears in HR reports and analytics dashboards.
ExecutiveIndicator Boolean The Boolean value that indicates whether the worker holds an executive position. This field is used for organizational hierarchy reporting and compliance disclosure tracking.
ExecutiveTypeCodeValue String The code value that identifies the type of executive classification (for example, Senior Executive, Vice President, or Director). This field defines the executive role assigned to the worker.
ExecutiveTypeCodeShortName String The abbreviated name that corresponds to the executive type code. This field provides a concise label for use in dashboards and internal listings.
ExecutiveTypeCodeLongName String The full descriptive name of the executive type code. This field provides a complete label that appears in HR reports and workforce analytics.
OfficerIndicator Boolean The Boolean value that indicates whether the worker serves as an officer within the organization. This field is used for corporate governance, legal reporting, and regulatory compliance tracking.
OfficerTypeCodeValue String The code value that identifies the type of officer role assigned to the worker (for example, Chief Executive Officer, Chief Financial Officer, or Corporate Secretary). This field defines the officer designation within the organizational structure.
OfficerTypeCodeShortName String The abbreviated name that corresponds to the officer type code. This field provides a concise label for dashboards, organization charts, and summary tables.
OfficerTypeCodeLongName String The full descriptive name of the officer type code. This field provides the complete label that identifies the officer's role within the organization (for example, Chief Executive Officer, Chief Financial Officer).
ManagementPositionIndicator Boolean The Boolean value that indicates whether the worker holds a management position. This field is used to identify supervisory roles for reporting, compliance, and organizational hierarchy analysis.
LegalEntityID String The unique identifier (Id) that represents the legal entity associated with this work assignment. This Id ensures accurate linkage between employment records, tax reporting, and corporate entities.
HighlyCompensatedIndicator Boolean The Boolean value that indicates whether the worker is classified as highly compensated. This field supports compliance reporting and regulatory tracking for payroll and benefits eligibility.
HighlyCompensatedTypeCodeValue String The code value that identifies the type of highly compensated classification that is assigned to the worker (for example, Officer, Director, or Key Employee). This field defines the specific compensation category used for reporting.
HighlyCompensatedTypeCodeShortName String The abbreviated name that corresponds to the highly compensated type code. This field provides a concise label for reports and dashboards.
HighlyCompensatedTypeCodeLongName String The full descriptive name of the highly compensated type code. This field provides a complete label for HR and compliance reporting.
StockOwnerIndicator Boolean The Boolean value that indicates whether the worker holds stock in the organization. This field supports equity management and regulatory disclosure reporting.
StockOwnerPercentage Double The percentage of ownership that represents the portion of company stock held by the worker. This field provides an exact value for equity and compliance calculations.
JobCodeValue String The code value that identifies the worker's job classification or role. This field defines the specific job position within the organization's job catalog or hierarchy.
JobCodeShortName String The abbreviated name that corresponds to the job code. This field provides a short, recognizable label for use in dashboards and reports.
JobCodeLongName String The full descriptive name of the job code. This field provides the complete label used in HR reports, job catalogs, and compliance documents.
JobTitle String The official title of the worker's position. This field displays the title as recognized by the organization and is used in internal systems, communications, and reports.
WageLawCoverageCodeValue String The code value that identifies the wage-law coverage category that applies to this worker. This field ensures that payroll calculations comply with relevant wage laws (for example, FLSA Exempt, Non-Exempt).
WageLawCoverageCodeShortName String The abbreviated name that corresponds to the wage-law coverage code. This field provides a short label for quick reference in HR and payroll systems.
WageLawCoverageCodeLongName String The full descriptive name of the wage-law coverage code. This field provides a clear label that is displayed in reports and compliance documentation.
WageLawCoverageLawNameCodeValue String The code value that identifies the specific law or regulation governing wage coverage. This field links wage-law coverage to applicable legal frameworks or policies.
WageLawCoverageLawNameCodeShortName String The abbreviated name that corresponds to the wage-law name code. This field provides a compact label used in compliance dashboards and HR reports.
WageLawCoverageLawNameCodeLongName String The full descriptive name of the wage-law name code. This field provides a clear and complete label used in payroll compliance reporting.
PositionID String The unique Id that represents the position associated with the worker's assignment. This Id links the assignment to the organization's job structure for workforce planning and analytics.
PositionTitle String The official title of the position that corresponds to the assignment. This field provides the role name as defined within the organizational structure.
LaborUnionCodeValue String The code value that identifies the labor union associated with the worker. This field supports collective bargaining and labor relations reporting.
LaborUnionshortName String The abbreviated name that corresponds to the labor-union code. This field provides a short label for reports and HR dashboards.
LaborUnionlongName String The full descriptive name of the labor-union code. This field provides the complete label used in HR and compliance reports.
LaborUnionSeniorityDate Date The date that represents the worker's seniority within the labor union. This field is used to determine eligibility for benefits, bidding rights, and other union-related provisions.
BargainingUnitCodeValue String The code value that identifies the bargaining unit to which the worker belongs. This field supports collective bargaining agreement administration and compliance tracking.
BargainingUnitshortName String The abbreviated name that corresponds to the bargaining-unit code. This field provides a concise label for use in reports and dashboards.
BargainingUnitlongName String The full descriptive name of the bargaining-unit code. This field provides the complete label used in HR, legal, and compliance reports.
BargainingUnitSeniorityDate Date The date that represents the worker's seniority within the bargaining unit. This field is used to determine eligibility for union-based benefits, promotions, and priority assignments.
WorkShiftCodeValue String The code value that identifies the worker's designated work shift (for example, Day, Night, or Rotating). This field supports scheduling, labor costing, and workforce planning.
WorkShiftCodeshortName String The abbreviated name that corresponds to the work-shift code. This field provides a short label for reports and workforce scheduling dashboards.
WorkShiftCodelongName String The full descriptive name of the work-shift code. This field provides a complete label that appears in HR reports and scheduling documentation.
WorkArrangementCodeValue String The code value that identifies the worker's arrangement or work mode (for example, On-Site, Remote, or Hybrid). This field is used for policy enforcement and workplace flexibility reporting.
WorkArrangementCodeshortName String The abbreviated name that corresponds to the work-arrangement code. This field provides a short label for quick reference in HR systems and dashboards.
WorkArrangementCodelongName String The full descriptive name of the work-arrangement code. This field provides a complete label used in workforce strategy and compliance reports.
StandardHoursQuality String The description or classification that indicates the quality type associated with the standard-hours configuration. This field defines how standard work hours are measured or categorized within the assignment record.
StandardHoursCodeValue Integer The code value that identifies the standard number of hours for the worker's assignment (for example, 40 for full-time, 20 for part-time). This field is used in payroll calculations and labor distribution reporting.
StandardHoursCodeshortName String The abbreviated name that corresponds to the standard-hours code. This field provides a short label for dashboards and time reporting summaries.
StandardHoursCodelongName String The full descriptive name of the standard-hours code. This field provides the complete label that appears in HR reports and configuration documentation.
FullTimeEquivalenceRatio Integer The numeric value that represents the worker's full-time equivalence ratio. This field is used to calculate benefit eligibility, headcount metrics, and workload analysis.
HomeWorkLocationCodeValue String The code value that identifies the worker's home-work location. This field specifies the primary work site that is assigned to the employee (for example, Corporate Office, Remote, or Regional Hub).
HomeWorkLocationCodeshortName String The abbreviated name that corresponds to the home-work-location code. This field provides a short label used in dashboards and workforce reports.
HomeWorkLocationCodelongName String The full descriptive name of the home-work-location code. This field provides the complete label used in HR reports and organizational charts.
HomeWorkLocationAddressScriptCodeValue String The code value that identifies the address script or formatting type used for the home-work location. This field ensures that address formatting aligns with regional or country-specific standards.
HomeWorkLocationAddressScriptCodeshortName String The abbreviated name that corresponds to the address script code. This field provides a short label that is used in system configurations and address templates.
HomeWorkLocationAddressScriptCodelongName String The full descriptive name of the address script code. This field provides the complete label displayed in configuration and address management tools.
HomeWorkLocationAddresslineFour String The fourth line of the home-work location address. This field stores additional address information that is used for extended location details or delivery routing.
HomeWorkLocationAddresslineFive String The fifth line of the home-work-location address. This field allows for the inclusion of supplemental address information that supports complex address formats.
HomeWorkLocationAddressbuildingNumber String The building number that identifies the specific structure at the work location. This field is used for mail delivery and physical site identification.
HomeWorkLocationAddressbuildingName String The name of the building associated with the work location. This field provides a descriptive Id for the facility in HR and facilities management systems.
HomeWorkLocationAddressblockName String The name of the block, district, or area in which the building is located. This field supports more detailed geographic identification for reporting and logistics.
HomeWorkLocationAddressstreetName String The name of the street where the work location is situated. This field provides the primary street Id used in mapping, reporting, and correspondence.
HomeWorkLocationAddressstreetTypeCodeValue String The code value that identifies the type of street (for example, Avenue, Road, or Boulevard). This field ensures consistent classification of address components.
HomeWorkLocationAddressstreetTypeCodeshortName String The abbreviated name that corresponds to the street type code. This field provides a compact label for display in reports and address summaries.
HomeWorkLocationAddressstreetTypeCodelongName String The full descriptive name of the street type code. This field provides the complete label that appears in HR reports and address records.
HomeWorkLocationAddressunit String The unit number or Id within the building. This field identifies a specific office, suite, or apartment as part of the full address.
HomeWorkLocationAddressfloor String The floor number or designation for the work location. This field specifies where the employee's work area is located within the building.
HomeWorkLocationAddressstairCase String The stairwell or section Id within a multi-unit building. This field supports internal location mapping and emergency response records.
HomeWorkLocationAddressdoor String The door or room Id for the work location. This field provides additional detail for internal navigation or facility management.
HomeWorkLocationAddresspostOfficeBox String The post office (PO) box number that is used for mail delivery. This field is populated when the work location uses a PO Box instead of a street address.
HomeWorkLocationAddressdeliveryPoint String The designated delivery point or code for mail routing. This field is used to optimize postal delivery and logistics for the work location.
HomeWorkLocationAddressplotID String The unique plot or parcel Id that is assigned to the physical property. This field is used for mapping, land use, or facility reference purposes.
HomeWorkLocationAddresscountrySubdivisionLevel2Value String The code value that identifies the second-level country subdivision (for example, County, District, or Municipality). This field supports detailed geographic reporting.
HomeWorkLocationAddresscountrySubdivisionLevel2shortName String The abbreviated name that corresponds to the second-level country subdivision. This field provides a short label for display in reports and address records.
HomeWorkLocationAddresscountrySubdivisionLevel2longName String The full descriptive name of the second-level country subdivision. This field provides the complete name for HR, payroll, and compliance reporting.
HomeWorkLocationAddresscountrySubdivisionLevel2subdivisionType String The type of administrative division that is represented by the second-level country subdivision (for example, County, Parish, or Province). This field clarifies jurisdictional context.
HomeWorkLocationAddressnameCodeValue String The code value that identifies the locality or site name within the address. This field provides a system-recognized Id for geographic and operational mapping.
HomeWorkLocationAddressnameCodeshortName String The abbreviated name that corresponds to the locality or site-name code. This field provides a short label for reporting and address formatting.
HomeWorkLocationAddressnameCodelongName String The full descriptive name of the locality or site-name code. This field provides a complete label used in HR and facilities reports.
HomeWorkLocationAddressattentionOfName String The name of the individual or department to whose attention correspondence should be directed. This field supports personalized address routing.
HomeWorkLocationAddresscareOfName String The name of the individual or entity under whose care the address is maintained. This field is used for third-party or temporary mailing arrangements.
HomeWorkLocationAddresslineOne String The first line of the home work-location address. This field typically contains the street number and street name.
HomeWorkLocationAddresslineTwo String The second line of the home work-location address. This field is used for apartment, suite, or unit details.
HomeWorkLocationAddresslineThree String The third line of the home work-location address. This field allows for extended address components such as building or block names.
HomeWorkLocationAddresscountrySubdivisionLevel1Value String The code value that identifies the first-level country subdivision (for example, State, Province, or Region). This field supports geographic and regulatory reporting.
HomeWorkLocationAddresscountrySubdivisionLevel1shortName String The abbreviated name that corresponds to the first-level country subdivision. This field provides a short label for dashboards and reports.
HomeWorkLocationAddresscountrySubdivisionLevel1longName String The full descriptive name of the first-level country subdivision. This field provides the complete label used in compliance and payroll documents.
HomeWorkLocationAddresscountrySubdivisionLevel1subdivisionType String The type of administrative division represented by the first-level country subdivision (for example, State, Province, or Territory). This field clarifies the jurisdictional level.
HomeWorkLocationAddresscountryCode String The ISO country code that identifies the country in which the home work location resides (for example, US, CA, or GB). This field supports global workforce reporting and address validation.
HomeWorkLocationAddresspostalCode String The postal or ZIP code that identifies the delivery area for the home work location. This field supports logistics, tax jurisdiction, and compliance reporting.
HomeWorkLocationAddressgeoCoordinateLatitude Double The latitude coordinate of the home work location. This field supports geospatial mapping, reporting, and workforce planning.
HomeWorkLocationAddressgeoCoordinateLongitude Double The longitude coordinate of the home work location. This field provides the geographic reference needed for mapping and site-level analysis.
RemunerationBasisCodeValue String The code value that identifies the remuneration basis for the worker's compensation (for example, Salary, Hourly,or Commission). This field defines how pay is structured for the assignment.
RemunerationBasisCodeshortName String The abbreviated name that corresponds to the remuneration basis code. This field provides a short label that is used in dashboards and compensation reports.
RemunerationBasisCodelongName String The full descriptive name of the remuneration basis code. This field provides a complete label used in payroll configuration and HR analytics.
PayCycleCodeValue String The code value that identifies the pay cycle or pay frequency associated with the worker's assignment (for example, Weekly, Biweekly, or Monthly). This field determines payroll timing and scheduling.
PayCycleCodeshortName String The abbreviated name that corresponds to the pay-cycle code. This field provides a concise label that is displayed in HR dashboards, reports, and payroll configuration tools.
PayCycleCodelongName String The full descriptive name of the pay-cycle code. This field provides the complete label used in payroll schedules, reporting, and workforce planning.
StandardPayPeriodHourshoursQuantity Integer The numeric value that represents the standard number of hours in a pay period. This field is used for payroll calculation, time tracking, and labor allocation reporting.
StandardPayPeriodHoursCodeValue String The code value that identifies the classification or type of standard pay-period hours (for example, Standard, Reduced, or Extended). This field defines how scheduled hours are categorized for the worker's assignment.
StandardPayPeriodHoursCodeshortName String The abbreviated name that corresponds to the standard pay-period hours code. This field provides a short label for dashboards and reports.
StandardPayPeriodHoursCodelongName String The full descriptive name of the standard pay-period hours code. This field provides a clear label that is used in HR reports, scheduling systems, and payroll documentation.
BaseRemunerationhourlyRateAmountcodeValue String The code value that identifies the classification associated with the worker's hourly base rate. This field is used to categorize the hourly rate for payroll and compensation analysis.
BaseRemunerationhourlyRateAmountshortName String The abbreviated name that corresponds to the hourly rate code. This field provides a concise label for dashboards and payroll reports.
BaseRemunerationhourlyRateAmountlongName String The full descriptive name of the hourly rate code. This field provides the complete label used in HR reports and compensation documentation.
BaseRemunerationhourlyRateAmountValue String The numeric value that represents the worker's hourly rate of pay. This field is used to calculate gross earnings for hourly employees.
BaseRemunerationhourlyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the hourly rate amount (for example, USD, CAD, or EUR). This field ensures correct currency alignment in payroll calculations and reporting.
BaseRemunerationdailyRateAmountcodeValue String The code value that identifies the classification associated with the worker's daily base rate. This field categorizes the daily rate for payroll processing and compliance purposes.
BaseRemunerationdailyRateAmountshortName String The abbreviated name that corresponds to the daily rate code. This field provides a concise label for display in reports and pay configuration tools.
BaseRemunerationdailyRateAmountlongName String The full descriptive name of the daily rate code. This field provides a complete label used in payroll configuration and HR documentation.
BaseRemunerationdailyRateAmountValue String The numeric value that represents the worker's daily rate of pay. This field is used to calculate gross earnings for daily-compensated employees.
BaseRemunerationdailyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the daily rate amount (for example, USD, GBP, or CAD). This field supports accurate pay calculation and cross-currency reporting.
BaseRemunerationweeklyRateAmountcodeValue String The code value that identifies the classification associated with the worker's weekly base rate. This field is used to categorize pay rates for weekly-paid employees.
BaseRemunerationweeklyRateAmountshortName String The abbreviated name that corresponds to the weekly rate code. This field provides a short label for dashboards and payroll reports.
BaseRemunerationweeklyRateAmountlongName String The full descriptive name of the weekly rate code. This field provides a complete label used in HR and payroll configuration documentation.
BaseRemunerationweeklyRateAmountValue String The numeric value that represents the worker's weekly rate of pay. This field is used to determine gross earnings for weekly-paid employees.
BaseRemunerationweeklyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the weekly rate amount (for example, USD, CAD, or GBP). This field ensures accuracy in international payroll reporting.
BaseRemunerationbiweeklyRateAmountcodeValue String The code value that identifies the classification associated with the worker's biweekly base rate. This field categorizes the rate for payroll and compensation tracking.
BaseRemunerationbiweeklyRateAmountshortName String The abbreviated name that corresponds to the biweekly rate code. This field provides a concise label for display in dashboards and reports.
BaseRemunerationbiweeklyRateAmountlongName String The full descriptive name of the biweekly rate code. This field provides a complete label that appears in HR and payroll configuration documents.
BaseRemunerationbiweeklyRateAmountValue String The numeric value that represents the worker's biweekly rate of pay. This field is used to calculate pay for employees on a biweekly payroll cycle.
BaseRemunerationbiweeklyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the biweekly rate amount (for example, USD, EUR, or AUD). This field ensures proper currency conversion in payroll systems.
BaseRemunerationsemiMonthlyRateAmountcodeValue String The code value that identifies the classification associated with the worker's semi-monthly base rate. This field categorizes the rate for semi-monthly payroll and compensation analysis.
BaseRemunerationsemiMonthlyRateAmountshortName String The abbreviated name that corresponds to the semi-monthly rate code. This field provides a short label for reports and compensation dashboards.
BaseRemunerationsemiMonthlyRateAmountlongName String The full descriptive name of the semi-monthly rate code. This field provides the complete label used in HR and payroll configuration records.
BaseRemunerationsemiMonthlyRateAmountValue String The numeric value that represents the worker's semi-monthly rate of pay. This field is used to calculate earnings for employees on a semi-monthly pay schedule.
BaseRemunerationsemiMonthlyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the semi-monthly rate amount (for example, USD, CAD, or GBP). This field ensures consistency in payroll reporting and calculations.
BaseRemunerationmonthlyRateAmountcodeValue String The code value that identifies the classification associated with the worker's monthly base rate. This field categorizes pay for employees compensated on a monthly basis.
BaseRemunerationmonthlyRateAmountshortName String The abbreviated name that corresponds to the monthly rate code. This field provides a concise label used in dashboards and payroll configuration screens.
BaseRemunerationmonthlyRateAmountlongName String The full descriptive name of the monthly rate code. This field provides the complete label that is displayed in HR reports and payroll documentation.
BaseRemunerationmonthlyRateAmountValue String The numeric value that represents the worker's monthly rate of pay. This field is used to calculate gross earnings for employees on a monthly payroll schedule.
BaseRemunerationmonthlyRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the monthly rate amount (for example, USD, CAD, or EUR). This field ensures proper currency conversion and reporting consistency.
BaseRemunerationannualRateAmountcodeValue String The code value that identifies the classification associated with the worker's annual base rate. This field categorizes compensation for yearly-paid employees and supports reporting and compliance.
BaseRemunerationannualRateAmountshortName String The abbreviated name that corresponds to the annual rate code. This field provides a concise label for dashboards and HR reports.
BaseRemunerationannualRateAmountlongName String The full descriptive name of the annual rate code. This field provides the complete label used in payroll configuration and compensation analysis.
BaseRemunerationannualRateAmountValue String The numeric value that represents the worker's annual rate of pay. This field is used for total compensation reporting and executive-level payroll summaries.
BaseRemunerationannualRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the annual rate amount (for example, USD, GBP, or CAD). This field ensures consistency in payroll and financial reporting.
BaseRemunerationpayPeriodRateAmountcodeValue String The code value that identifies the classification associated with the pay-period rate amount. This field defines the worker's recurring pay amount per cycle for payroll processing.
BaseRemunerationpayPeriodRateAmountshortName String The abbreviated name that corresponds to the pay-period rate code. This field provides a short label for use in dashboards and reporting tools.
BaseRemunerationpayPeriodRateAmountlongName String The full descriptive name of the pay-period rate code. This field provides the complete label displayed in payroll configuration and analytics reports.
BaseRemunerationpayPeriodRateAmountValue String The numeric value that represents the worker's rate of pay per pay period. This field is used for calculating gross pay within each payroll cycle.
BaseRemunerationpayPeriodRateAmountCurrencyCode String The three-letter ISO currency code that identifies the currency of the pay-period rate amount (for example, USD, EUR, or JPY). This field supports global payroll accuracy and reporting alignment.
BaseRemunerationcommissionRatePercentagecodeValue String The code value that identifies the classification associated with the worker's commission rate percentage. This field defines how commission-based pay is structured for sales or incentive compensation.
BaseRemunerationcommissionRatePercentageshortName String The abbreviated name that corresponds to the commission-rate percentage code. This field provides a short label for reporting and configuration tools.
BaseRemunerationcommissionRatePercentagelongName String The full descriptive name of the commission-rate percentage code. This field provides the complete label used in HR and payroll documentation.
BaseRemunerationcommissionRatePercentageValue String The numeric value that represents the commission-rate percentage applied to earnings. This field determines variable pay for commission-based employees.
BaseRemunerationcommissionRatePercentagebaseUnitCodeValue String The code value that identifies the base unit of measure that is used for calculating commission percentages (for example, Sales Amount, Units Sold, or Revenue). This field defines the metric to which the commission rate is applied.
BaseRemunerationcommissionRatePercentageCurrencyCodeshortName String The abbreviated name that corresponds to the commission-rate currency code. This field provides a short label used in dashboards and reports.
BaseRemunerationcommissionRatePercentageCurrencyCodelongName String The full descriptive name of the commission-rate currency code. This field provides the complete label used in payroll documentation and analytics reports.
BaseRemunerationeffectiveDate Date The date on which the current base remuneration information became effective. This field is used to track changes in pay rates over time and supports audit reporting.
PayrollProcessingStatusCodecodeValue String The code value that identifies the payroll-processing status for the worker (for example, Pending, Approved, or Processed). This field defines the current payroll workflow state.
PayrollProcessingStatusCodeshortName String The abbreviated name that corresponds to the payroll-processing status code. This field provides a concise label for dashboards and payroll monitoring tools.
PayrollProcessingStatusCodelongName String The full descriptive name of the payroll-processing status code. This field provides a complete label used in HR, payroll, and compliance reports.
PayrollProcessingStatusCodeEffectiveDate Date The date on which the current payroll-processing status became effective. This field marks when the payroll state changed within the system.
PayrollGroupCode String The code that identifies the payroll group to which the worker belongs. This field groups workers for payroll processing, scheduling, and reporting.
PayrollFileNumber String The file number that represents the payroll file or batch in which the worker's pay data is included. This field supports reconciliation and auditing of payroll runs.
PayrollRegionCode String The code that identifies the payroll region associated with the worker's assignment. This field determines regional payroll rules, taxes, and compliance configurations.
PayScaleCodecodeValue String The code value that identifies the pay scale associated with the worker's job classification. This field defines structured compensation ranges used for salary administration.
PayScaleCodeshortName String The abbreviated name that corresponds to the pay-scale code. This field provides a concise label for dashboards, reports, and job evaluation tools.
PayScaleCodelongName String The full descriptive name of the pay-scale code. This field provides the complete label used in HR reports and compensation management systems.
PayGradeCodecodeValue String The code value that identifies the pay-grade level associated with the worker's position. This field defines pay structure within the organization's compensation framework.
PayGradeCodeshortName String The abbreviated name that corresponds to the pay-grade code. This field provides a short label used in dashboards and HR analytics reports.
PayGradeCodelongName String The full descriptive name of the pay-grade code. This field provides the complete label that appears in HR and payroll reports.
PayGradePayRangeminimumRateamountValue String The numeric value that represents the minimum rate of pay within the pay-grade range. This field defines the lower limit for the compensation range.
PayGradePayRangeminimumRatecurrencyCode String The three-letter ISO currency code that identifies the currency used for the minimum rate amount (for example, USD, CAD, or GBP). This field ensures proper payroll currency consistency.
PayGradePayRangeminimumRateUnitCodeValue String The code value that identifies the unit of measure for the minimum rate (for example, Hourly, Weekly, or Annual). This field specifies how the pay rate is calculated.
PayGradePayRangeminimumRateUnitshortName String The abbreviated name that corresponds to the minimum rate-unit code. This field provides a concise label for reports and pay structure documentation.
PayGradePayRangeminimumRateUnitlongName String The full descriptive name of the minimum rate-unit code. This field provides the complete label that is used in HR and compensation reports.
PayGradePayRangeminimumRateBaseUnitCodeValue String The code value that identifies the base unit of measure used to calculate the minimum rate (for example, Hour, Day, or Month). This field defines the rate basis for payroll calculations.
PayGradePayRangeminimumRateBaseUnitshortName String The abbreviated name that corresponds to the minimum rate-base unit code. This field provides a short label for dashboards and reports.
PayGradePayRangeminimumRateBaseUnitlongName String The full descriptive name of the minimum rate base unit code. This field provides the complete label used in payroll and compensation documentation.
PayGradePayRangeminimumRatebaseMultiplierValue Integer The numeric multiplier that is applied to the base rate to determine the minimum pay rate. This field is used for pay scale conversions and compensation modeling.
PayGradePayRangemedianRateamountValue String The numeric value that represents the median rate of pay within the pay-grade range. This field defines the midpoint of the compensation range.
PayGradePayRangemedianRatecurrencyCode String The three-letter ISO currency code that identifies the currency of the median-rate amount (for example, USD, EUR, or CAD). This field ensures currency accuracy in reporting.
PayGradePayRangemedianRateUnitCodeValue String The code value that identifies the unit of measure for the median rate (for example, Hourly, Weekly, or Annual). This field specifies how the median pay rate is defined.
PayGradePayRangemedianRateUnitshortName String The abbreviated name that corresponds to the median-rate unit code. This field provides a short label for reports and dashboards.
PayGradePayRangemedianRateBaseUnitCodeValue String The code value that identifies the base unit of measure for the median rate (for example, Hour, Day, or Month). This field defines the standard basis for payroll calculations.
PayGradePayRangemedianRateBaseUnitshortName String The abbreviated name that corresponds to the median-rate base unit code. This field provides a concise label for dashboards and summary reports.
PayGradePayRangemedianRateBaseUnitlongName String The full descriptive name of the median-rate base unit code. This field provides the complete label for HR, payroll, and compensation documentation.
PayGradePayRangemedianRatebaseMultiplierValue Integer The numeric multiplier that is applied to the base rate to calculate the median rate. This field is used in compensation modeling and analytics.
PayGradePayRangemaximumRateamountValue String The numeric value that represents the maximum rate of pay within the pay-grade range. This field defines the upper limit of the compensation range for the job classification.
PayGradePayRangemaximumRatecurrencyCode String The three-letter ISO currency code that identifies the currency of the maximum rate amount (for example, USD, CAD, or GBP). This field supports consistent payroll calculations and reporting.
PayGradePayRangemaximumRateUnitCodeValue String The code value that identifies the unit of measure for the maximum rate (for example, Hourly, Weekly, or Annual). This field defines how the pay rate is calculated.
PayGradePayRangemaximumRateUnitshortName String The abbreviated name that corresponds to the maximum-rate unit code. This field provides a concise label for reports and compensation tools.
PayGradePayRangemaximumRateUnitlongName String The full descriptive name of the maximum-rate unit code. This field provides the complete label that is used in HR, payroll, and compensation documentation.
PayGradePayRangemaximumRateBaseUnitCodeValue String The code value that identifies the base unit of measure for the maximum rate (for example, Hour, Day, or Month). This field defines the unit basis for pay structure calculations.
PayGradePayRangemaximumRateBaseUnitshortName String The abbreviated name that corresponds to the maximum-rate base unit code. This field provides a concise label for dashboards and payroll configuration reports.
PayGradePayRangemaximumRateBaseUnitlongName String The full descriptive name of the maximum-rate base unit code. This field provides the complete label used in compensation and HR documentation.
PayGradePayRangemaximumRatebaseMultiplierValue Integer The numeric multiplier that is applied to the base rate to determine the maximum pay rate. This field is used in compensation modeling and pay structure analysis.
CompaRatio Double The compensation ratio value that compares an employee's current pay to the midpoint or range of the pay grade. This field is used in compensation analysis to assess pay equity and alignment.
PayGradeStepCodeValue String The code value that identifies the pay-grade step associated with the worker's position. This field defines the specific level or progression point within a structured pay grade.
PayGradeStepshortName String The abbreviated name that corresponds to the pay-grade step code. This field provides a concise label for reports and HR dashboards.
PayGradeSteplongName String The full descriptive name of the pay-grade step code. This field provides the complete label used in HR and compensation reports.
PayGradeStepPayRateamountValue String The numeric value that represents the rate of pay for the pay-grade step. This field defines the specific compensation amount at the given step within the pay grade.
PayGradeStepPayRatecurrencyCode String The three-letter ISO currency code that identifies the currency of the pay rate for the pay-grade step (for example, USD, CAD, or GBP). This field ensures currency consistency in payroll calculations.
PayGradeStepPayRateUnitCodeValue String The code value that identifies the unit of measure for the pay-grade step rate (for example, Hourly, Weekly, or Annual). This field defines how the rate is expressed.
PayGradeStepPayRateUnitshortName String The abbreviated name that corresponds to the pay-rate unit code. This field provides a short label for reports and dashboards.
PayGradeStepPayRateUnitlongName String The full descriptive name of the pay-rate unit code. This field provides the complete label used in HR and compensation documentation.
PayGradeStepPayRateBaseUnitCodeValue String The code value that identifies the base unit of measure for the pay-grade step rate (for example, Hour, Day, or Month). This field defines the rate basis for payroll calculations.
PayGradeStepPayRateBaseUnitshortName String The abbreviated name that corresponds to the base unit code for the pay-grade step rate. This field provides a concise label for dashboards and summary reports.
PayGradeStepPayRateBaseUnitlongName String The full descriptive name of the base unit code for the pay-grade step rate. This field provides a complete label for HR and payroll reports.
PayGradeStepPayRatebaseMultiplierValue Integer The numeric multiplier that is applied to the base rate to calculate the pay-grade step rate. This field supports compensation modeling and range calculations.
NextPayGradeStepDate Date The date on which the worker is scheduled to advance to the next pay-grade step. This field supports career progression and compensation planning. MinimumPayGradeStepDuration,column:string,The minimum required duration that a worker must remain in the current pay-grade step before becoming eligible for advancement. This field ensures compliance with progression policies.
MinimumPayGradeStepDuration String
GeographicPayDifferentialCodeValue String The code value that identifies the geographic pay differential applicable to the worker's location. This field accounts for regional cost-of-living or market rate adjustments.
GeographicPayDifferentialshortName String The abbreviated name that corresponds to the geographic pay-differential code. This field provides a concise label for reports and compensation dashboards.
GeographicPayDifferentiallongName String The full descriptive name of the geographic pay-differential code. This field provides the complete label used in HR, payroll, and compliance reports.
GeographicPayDifferentialPercentage Double The percentage value that represents the adjustment applied to base pay as a result of geographic differences. This field supports equitable compensation across regions.
ItemID String The unique Id that represents the individual historical record for this work assignment. This Id is used to track changes and maintain version history across the worker's employment timeline.
EffectiveDate Date The date on which the current record or change became effective. This field is used to determine when updates to the worker's assignment or compensation take effect.
FromDate Date The start date of the period during which this historical record is valid. This field defines the beginning of the effective period for the record.
ThruDate Date The end date of the period during which this historical record is valid. This field defines when the record ceases to be effective.
HistoryEventID String The unique Id that represents the historical event recorded in this entry. This Id links the change to specific actions or transactions within the HR system.
HistoryEventNameCodeValue String The code value that identifies the type of historical event (for example, Hire, Promotion, or Termination). This field classifies the event type for reporting and auditing.
HistoryEventNameshortName String The abbreviated name that corresponds to the historical-event code. This field provides a short label for dashboards and event summaries.
HistoryEventNamelongName String The full descriptive name of the historical-event code. This field provides the complete label for HR and compliance reports.
HistoryReasonCodeValue String The code value that identifies the reason for the historical event (for example, Transfer, Pay Adjustment, or Job Change). This field provides additional context for event tracking.
HistoryReasonshortName String The abbreviated name that corresponds to the history-reason code. This field provides a concise label for reports and analytics dashboards.
HistoryReasonlongName String The full descriptive name of the history-reason code. This field provides the complete label used in HR and payroll documentation.
HistoryEventActorId String The unique Id that represents the actor responsible for the historical event. This Id identifies the person, system, or process that performed the action.
HistoryEventActorCodeValue String The code value that identifies the type of actor associated with the historical event (for example, Employee, Manager, or System). This field defines the role that initiated the change.
HistoryEventActorshortName String The abbreviated name that corresponds to the actor code. This field provides a concise label for reports and audit dashboards.
HistoryEventActorlongName String The full descriptive name of the actor code. This field provides the complete label used in HR and system audit records.
HistoryEventActorassociateOID String The Id that represents the associate involved in the historical event. This field links the action to the correct worker record in HR systems.
HistoryEventActorpersonOID String The Id that represents the person associated with the historical-event actor. This field provides an additional reference for cross-system identification.
HistoryEventActorformattedName String The formatted full name of the historical-event actor. This field provides a readable name for display in HR reports, audit logs, and analytics tools.
HistoryEventActordeviceID String The Id that represents the device used to perform the historical event. This field supports audit tracking and security verification.
HistoryEventActorlatitude Double The latitude coordinate captured when the historical event occurred. This field supports audit tracking, compliance verification, and geolocation analysis.
HistoryEventActorlongitude Double The longitude coordinate captured when the historical event occurred. This field complements the latitude field for geographic audit tracking.
HistoryEventActordeviceUserAgentID String The Id of the user agent or application that executed the historical event. This field is used for system audits and device traceability.
WorkAssignmentID String The unique Id that represents the specific work assignment associated with this historical record. This Id links all related events, pay details, and organizational changes.
AssociateOID String

Workers.AssociateOID

The Id that represents the associate to whom this historical work-assignment record belongs. This field ensures that all historical changes are properly linked to the correct worker profile within HR and payroll systems.

Copyright (c) 2025 CData Software, Inc. - All rights reserved.
Build 25.0.9434