CData Python Connector for ADP

Build 25.0.9454

PaidTimeOffBalances

The view that returns current paid time-off (PTO) balances for associates. It is used to track available leave accruals, support scheduling, and ensure compliance with company PTO policies.

Table Specific Information

Select

The connector uses the ADP API to process WHERE clause conditions built with the following column and operator. The AssociateOID is required to make a request and the rest of the filter is executed client side within the connector.

  • AssociateOID supports the '=' comparison.

SELECT * FROM PaidTimeOffBalances WHERE AssociateOID = 'G3349PZGBADQY8H7'

Columns

Name Type References Description
AssociateOID String The unique identifier (Id) that represents the associate whose PTO balance is recorded. This Id links the PTO balance record to the associate's employment profile in ADP.
BalanceTypeCode String The code that identifies the type of PTO balance (for example, Vacation, Sick Leave, or Personal Time). This code ensures consistent categorization across payroll and Human Resource (HR) systems.
BalanceTypeLabelName String The descriptive name that corresponds to the balance type code. This field provides a human-readable label for use in reports and employee self-service views.
TotalQuantityValueNumber Double The total quantity of time that is available under the specific PTO balance type. This quantity reflects the cumulative hours or days accrued as of the reporting date.
TotalQuantityUnitTimeCode String The code that identifies the unit of time (for example, Hours or Days) that is associated with the PTO balance. This code ensures correct interpretation of the total quantity.
TotalQuantityLabelName String The descriptive label that represents the time unit of the PTO balance. This label is displayed in reports and employee dashboards.
TotalTime String The total time that is associated with the PTO balance. This field provides an alternate display value for the total accrued time.
AccrualBalances String The accrual balance details that are associated with the PTO policy. This field provides information about accrual calculations, carryovers, or limits applied to the associate's balance.
PaidTimeOffEntries String The individual PTO entries that are associated with the current balance. Each entry represents a recorded accrual, adjustment, or usage transaction within ADP.
PaidTimeOffPolicyCode String The code that identifies the PTO policy under which the balance is calculated. This code links the balance record to the appropriate accrual and usage rules.
PaidTimeOffPolicyLabelName String The descriptive name that corresponds to the PTO policy code. This field provides a readable label for HR teams and managers when reviewing balances or applying adjustments.
AsOfDate Date The date that indicates when the PTO balance is valid. This date is used to determine the point-in-time snapshot of the associate's available time.
PositionRefPositionID String The position Id that identifies the associate's current job position. This Id links the PTO balance to the associate's position record for organizational reporting.
PositionRefSchemeName String The name of the reference scheme that is associated with the position record. This value identifies the structure or naming convention used for position references.
PositionRefSchemeAgencyName String The name of the agency or system that manages the position reference scheme. This value helps distinguish references that originate from different HR or payroll systems.
PositionReftitle String The title of the position that is associated with the PTO balance record. This field provides a human-readable title for reporting and display purposes.

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