UsePayrollEndpoint
Specifies whether the provider uses the Payroll API to retrieve data for payroll-related views.
Data Type
bool
Default Value
false
Remarks
When enabled, the provider retrieves data for the following payroll views using ADP’s Payroll API instead of the default API:
- AssociatePaymentsAllocationsEarningSections
- AssociatePaymentsAllocationsStatutoryDeductions
- AssociatePaymentsAllocationsNonStatutoryDeductions
- AssociatePaymentsSummaryEarningsSections
- AssociatePaymentsSummaryStatutoryDeductions
- AssociatePaymentsSummaryPayrollAccumulations
When this property is set to true, payroll data is returned through the Payroll API, which may increase data retrieval time or impact performance.
This property is useful when you need to query payroll-related data that is only available through the Payroll API.