CData Cloud offers access to ADP across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a MySQL or SQL Server database can connect to ADP through CData Cloud.
CData Cloud allows you to standardize and configure connections to ADP as though it were any other OData endpoint, or standard SQL Server/MySQL database.
This page provides a guide to Establishing a Connection to ADP in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to ADP and configure any necessary connection properties to create a database in CData Cloud
Accessing data from ADP through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to ADP by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
Before you can establish a connection, you must contact ADP and ask that they provide you with an OAuth app and its associated credentials.
These credentials can only be obtained from ADP and can't be retrieved directly.
Connect to ADP by specifying the following properties:
Note: SSLClientCert requires that you create your own certificate. See ADP Developer Resources for more information.
By default, the Cloud attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.
To specify another certificate, see the SSLServerCert property for the available formats to do so.
To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.
In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.
Set the following properties:
The CData Cloud models ADP objects as relational tables and views. An ADP object has relationships to other objects; in the tables, these relationships are expressed through foreign keys. The following sections show the available API objects and provide more information on executing SQL to ADP APIs.
Schemas for most database objects are defined in simple, text-based configuration files.
The Cloud models the data exposed by the ADP APIs as relational Tables.
Views describes the available read-only views.
Stored Procedures are function-like interfaces to ADP.
The Cloud models the data in ADP as a list of tables in a relational database that can be queried using standard SQL statements.
Name | Description |
Input_AdditionalRemunerations | Create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_configurationTags | Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_DeductionInputs | Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_EarningInputs | Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
Input_ReimbursementInputs | Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared. |
PayrollRuns | Add and view the payroll runs. |
Workers | Returns workers details. |
WorkersPersonCommunicationEmails | Returns workers person communication emails. |
WorkersPersonCommunicationFaxes | Returns workers person communication faxes. |
WorkersPersonCommunicationLandlines | Returns workers person communication landlines. |
WorkersPersonCommunicationMobiles | Returns workers person communication mobiles. |
WorkersPersonCommunicationPagers | Returns workers person communication pagers. |
WorkersWorkAssignments | Returns workers details. |
Create aggregates for WorkersWorkAssignments.AdditionalRemunerations using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Name | Type | ReadOnly | References | Description |
RemunerationTypeCode | String | True | ||
RemunerationTypeCodeName | String | True | ||
RemunerationRate | Decimal | True | ||
RemunerationCurrencyCode | String | True | ||
effectiveDate | Date | True | ||
NameCode | String | True |
AdditionalRemunerationNameCode.CodeValue | |
InactiveIndicator | Boolean | True |
Add configurationTags aggregate for Input_DeductionInputs.DeductionConfigurationTags OR Input_EarningInputs.EarningConfigurationTags OR Input_ReimbursementInputs.ReimbursementConfigurationTags using this as TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Name | Type | ReadOnly | References | Description |
TagCode | String | True | ||
TagDataType | String | True | ||
TagValues | String | True |
Add comma separeted values with double quote | |
ReferenceNumber | Integer | True |
Configuration tag reference number |
Create aggregates for PayrollRuns.DeductionInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Name | Type | ReadOnly | References | Description |
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
DeductionCodeValue | String | True |
DeductionInputCode.CodeValue | |
DeductionRateValue | Decimal | True | ||
DeductionAmountcurrencyCode | String | True | ||
DeductionBaseUnitCodeValue | String | True | ||
DeductionConfigurationTags | String | True | ||
ReferenceNumber | Integer | True |
Configuration tag reference number |
Create aggregates for PayrollRuns.EarningInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Name | Type | ReadOnly | References | Description |
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
EarningCodeValue | String | True |
EarningInputCode.CodeValue | |
RateValue | Decimal | True | ||
RatecurrencyCode | String | True | ||
NumberOfHours | String | True | ||
EarningsAmountValue | Decimal | True | ||
EarningsCurrencyCode | String | True | ||
EarningConfigurationTags | String | True | ||
ReferenceNumber | Integer | True |
Configuration tag reference number |
Create aggregates for PayrollRuns.ReimbursementInputs using this as a TEMP table. This table values only last as long as the connection remains open. When the connection to ADP is closed, all tables names started with Input are cleared.
Name | Type | ReadOnly | References | Description |
AssociateOID | String | True | ||
PayrollGroupCode | String | True | ||
ReimbursementCodeValue | String | True |
ReimbursementInputCode.CodeValue | |
ReimbursementAmountValue | Decimal | True | ||
ReimbursementAmountCurrencyCode | String | True | ||
ReimbursementConfigurationTags | String | True | ||
ReferenceNumber | Integer | True |
Configuration tag reference number |
Add and view the payroll runs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM PayrollRuns WHERE ItemID = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM PayrollRuns WHERE PayrollRegionCodeValue = 'BOST' SELECT * FROM PayrollRuns WHERE PayrollGroupCodeValue = '3TN' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferenceScheduleEntryID = '20201117141612-l6OF8VuGHJD1ydLFoe5+nGBEm7rZkaRSorra0woRs04=' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollWeekNumber = '40' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollYear = '2020' SELECT * FROM PayrollRuns WHERE PayrollScheduleReferencePayrollRunNumber = '1' SELECT * FROM PayrollRuns WHERE Level = 'payroll'
Following is an example of how to inserting pay data inputs into PayrollRuns table. For example:
INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', 'G3BGDF8JG32ERTGK', '1', '020024', '[{"earningCode":{"codeValue":"R"},"modifierCode":{"codeValue":"1"},"rate":{"rateValue":"44.50"},"configurationTags":[{"tagCode":"ShiftCode","tagValues":["1"]}],"numberOfHours":40},{"earningCode":{"codeValue":"O"},"modifierCode":{"codeValue":"2"},"numberOfHours":4}]', '[{"deductionCode":{"codeValue":"A"},"deductionRate":{"rateValue":9.5,"currencyCode":"USD"}}]', '[{"reimbursementCode":{"codeValue":"B"},"reimbursementAmount":{"amountValue":25,"currencyCode":"USD"}}]')
Inserting pay data inputs using Temp Table.
INSERT INTO PayrollRunsEarningInputs#TEMP (EarningCodeValue, RateValue, NumberOfHours) VALUES ('R', '50.50', '40'); INSERT INTO PayrollRunsDeductionInputs#TEMP (DeductionCodeValue, DeductionRateValue, DeductionAmountcurrencyCode) VALUES ('A', '10', 'USD'); INSERT INTO PayrollRunsReimbursementInputs#TEMP (ReimbursementCodeValue, ReimbursementAmountValue, ReimbursementAmountCurrencyCode) VALUES ('B', '25.00', 'USD'); INSERT INTO PayrollRuns (PayrollGroupCodeValue, PayrollProcessingJobID, PayrollWeekNumber, AssociateOID, PayNumber, PayrollFileNumber, EarningInputs, DeductionInputs, ReimbursementInputs) VALUES ('3U7', 'TestProcessing', '53', 'G3BGDF8JG32ERTGK', '1', '020024', 'PayrollRunsEarningInputs#TEMP', 'PayrollRunsDeductionInputs#TEMP', 'PayrollRunsReimbursementInputs#TEMP');
Name | Type | ReadOnly | References | Description |
ItemID [KEY] | String | True |
The unique identifier of a instance within the collection. | |
PayrollProcessingJobID | String | False |
The unique identifier of the related payroll processing job. This is generated as the result of the payrollProcessingJob.initiate event. | |
AlternateJobIDs | String | True | ||
PayrollRegionCodeValue | String | True |
The region in which the payroll is processed. | |
PayrollGroupCodeValue | String | False |
PayrollGroup.Code |
The payroll group code relevant to payroll processing. |
PayrollGroupCodeShortName | String | True |
Short description of the related code. | |
PayrollGroupCodeLongName | String | True |
Long description of the related code. | |
PayrollScheduleReferencePayrollScheduleID | String | True |
The unique identifier of the payroll schedule associated with the payroll output. | |
PayrollScheduleReferenceScheduleEntryID | String | True |
The unique identifier of payroll schedule entry associated to the payroll schedule associated with the payroll output. | |
PayrollScheduleReferencePayrollWeekNumber | String | True |
The week number for a payroll in the payroll schedule. This does not necessarily align with the calendar week number. | |
PayrollScheduleReferencePayrollYear | String | True |
The year associated to a payroll in the payroll schedule. | |
PayrollScheduleReferencePayrollRunNumber | String | True |
For a given payroll week number, this is the numbered run for that week. | |
PayrollProcessingJobStatusCodeValue | String | True |
The Job status code of the payroll processing. | |
PayrollProcessingJobStatusCodeShortName | String | True |
Short description of the related Job status code. | |
PayrollProcessingJobStatusCodelongName | String | True |
Long description of the related Job status code. | |
AssociatePayments | String | True |
This column will return data. If level set to detail. |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
Level | String |
The allowed values are payroll, pay, details, payDetails, acc, acc-all, error, dropped pay, wage garnishements. |
AssociateOID | String |
Payroll Insert Only |
PayrollWeekNumber | String |
Payroll Insert Only |
PayrollFileNumber | String |
Payroll Insert Only |
PayNumber | String |
Payroll Insert Only |
EarningInputs | String |
Payroll Insert Only. Following Modifier codes are supported for pay data input 1 - 'Hours 1 (Regular)', 2 - 'Hours 3 Code & Quantity', 3 - 'Hours 3 Code & Quantity', 4 - 'Hours 4 Code & Quantity', 7 - 'Earnings 3 Code & Amount', 8 - 'Earnings 4 Code & Amount', 9 - 'Earnings 5 Code & Amount', 24 - 'Temporary Hourly Rate'. |
DeductionInputs | String |
Payroll Insert Only |
ReimbursementInputs | String |
Payroll Insert Only |
Returns workers details.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM Workers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM Workers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM Workers WHERE AsOfDate = '2020-01-01'
Following is an example of how to inserting into Workers table. For example:
INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonLegalNameGivenName, PersonLegalNameFamilyName1, PersonBirthDate, PersonHighestEducationLevelCode) VALUES ('3UD', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 4', '2020-11-10', 'TestGivenName', 'TestFamilyName', '1990-06-01', 'DOC')
Following is an example of how to inserting into Workers table with WorkAssignements. For example:
INSERT INTO WorkersWorkAssignments#TEMP (StandardHoursQuantity, PayCycleCodeValue, BaseRemunerationHourlyRateAmountValue, WageLawCoverageCodeValue, BaseRemunerationDailyRateAmountValue) VALUES ('45', '4', 300, 'N', 100) INSERT INTO Workers (PayrollGroupCode, OnboardingTemplateCode, OnboardingTemplateCodeName, OnboardingStatusCode, OnboardingStatusCodeName, HireReasonCode, HireReasonCodeName, WorkerOriginalHireDate, PersonBirthDate, PersonLegalNameFamilyName1, PersonLegalNameGivenName, PersonDisabledIndicator, PersonGenderCode, PersonHighestEducationLevelCode, PersonLegalAddressCityName, PersonLegalAddressCountryCode, PersonLegalAddressCountrySubdivisionLevel1Code, PersonLegalAddressCountrySubdivisionLevel1SubdivisionType, PersonLegalAddressLineOne, PersonLegalAddressLineTwo, PersonLegalAddressLineThree, PersonLegalAddressNameCodeShortName, PersonLegalAddressPostalCode, PersonLegalNameFamilyName1Prefix, PersonLegalNameGenerationAffixCode, PersonLegalNameInitials, PersonLegalNameMiddleName, PersonLegalNameNickName, PersonLegalNameQualificationAffixCode, PersonMaritalStatusCode, PersonMilitaryDischargeDate, PersonMilitaryStatusCode, WorkAssignments) VALUES ('3TQ', '15336_7354', 'HR Only (System)', 'complete', 'complete', 'new', 'TESTHIRE 16', '2020-12-30', '1990-06-02', 'TestGivenName', 'TestFamilyName', 'FALSE', 'M', 'GRD', 'Millburn', 'US', 'NJ', 'state', 'LineOne', 'LineTwo', 'LineThree', 'Legal Residence', '07041', 'Prefix1', '2nd', 'I', 'MiddleName', 'NickName', 'CFA', 'M', '2013-04-01', '12', 'WorkersWorkAssignments#TEMP')
Following is an example of how to Update a Workers table:
UPDATE Workers SET PersonLegalNameGenerationAffixCode = '2nd', PersonLegalNameGivenName = 'GivenName', PersonLegalNameFamilyName1 = 'FamilyName1', PersonLegalNameFamilyName1Prefix = 'Prefix1', PersonLegalNameFamilyName2 = 'FamilyName2', PersonLegalNameFamilyName2Prefix = 'Prefix2', PersonLegalNameInitials = 'C', PersonLegalNameMiddleName = 'MiddleName', PersonLegalNameNickName = 'NickName', PersonLegalNamePreferredSalutations = '[{"salutationCode":{"codeValue":"Mr."},"typeCode":{"shortName":"Social"},"sequenceNumber":1}]', PersonLegalNameQualificationAffixCode = 'CFA' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonLegalAddressNameCodeShortName = 'Legal Residence', PersonLegalAddressLineOne = 'LineOne', PersonLegalAddressLineTwo = 'LineTwo', PersonLegalAddressCityName = 'Millburn', PersonLegalAddressCountryCode = 'US', PersonLegalAddressCountrySubdivisionLevel1SubdivisionType = 'state', PersonLegalAddressPostalCode = '07041' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonMaritalStatusCode = 'M', PersonMaritalStatusEffectiveDateTime = '2020-12-01T00:00:00Z' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonHighestEducationLevelCode = 'GRD' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonGenderCode = 'M' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonBirthDate = '1990-06-01' WHERE AssociateOID = 'G3DXX3CRDERXK3C9' UPDATE Workers SET PersonMilitaryClassificationCodes = '[{"codeValue":"R"}]' WHERE AssociateOID = 'G3DXX3CRDERXK3C9'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True | ||
WorkerID | String | True | ||
WorkAssignments | String | False | ||
WorkerAcquisitionDate | Date | True | ||
WorkerAdjustedServiceDate | Date | True | ||
WorkerExpectedTerminationDate | Date | True | ||
WorkerOriginalHireDate | Date | False | ||
WorkerRehireDate | Date | True | ||
WorkerRetirementDate | Date | True | ||
WorkerTerminationDate | Date | True | ||
WorkerIDSchemeCode | String | True | ||
WorkerIDSchemeLongName | String | True | ||
WorkerIDSchemeShortName | String | True | ||
WorkerStatusEffectiveDate | Date | True | ||
WorkerStatusReasonCode | String | True | ||
WorkerStatusReasonLongName | String | True | ||
WorkerStatusReasonShortName | String | True | ||
WorkerStatusStatusCode | String | True | ||
WorkerStatusStatusLongName | String | True | ||
WorkerStatusStatusShortName | String | True | ||
Photos | String | True | ||
BusinessCommunicationEmails | String | False | ||
BusinessCommunicationFaxes | String | False | ||
BusinessCommunicationLandlines | String | False | ||
BusinessCommunicationMobiles | String | False | ||
BusinessCommunicationPagers | String | False | ||
PersonAlternatePreferredNames | String | True | ||
PersonCommunicationEmails | String | False | ||
PersonCommunicationFaxes | String | False | ||
PersonCommunicationLandlines | String | False | ||
PersonCommunicationMobiles | String | False | ||
PersonCommunicationPagers | String | False | ||
PersonDeathDate | Date | True | ||
PersonDeceasedIndicator | Boolean | True | ||
PersonDisabilityIdentificationDeclinedIndicator | Boolean | True | ||
PersonDisabilityPercentage | Integer | True | ||
PersonDisabilityTypeCodes | String | False | ||
PersonDisabledIndicator | Boolean | False | ||
PersonGenderCode | String | False |
The allowed values are M, F, N. | |
PersonGenderLongName | String | True | ||
PersonGenderShortName | String | True | ||
PersonGovernmentIDs | String | False | ||
PersonHighestEducationLevelCode | String | False |
HighestEducationLevelCode.CodeValue | |
PersonHighestEducationLevelLongName | String | True | ||
PersonHighestEducationLevelShortName | String | True | ||
PersonIdentityDocuments | String | True | ||
PersonImmigrationDocuments | String | True | ||
PersonLegalAddressCityName | String | False | ||
PersonLegalAddressCountryCode | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1Code | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1LongName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1ShortName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2Code | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2LongName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2ShortName | String | False | ||
PersonLegalAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
PersonLegalAddressDeliveryPoint | String | False | ||
PersonLegalAddressLineOne | String | False | ||
PersonLegalAddressLineTwo | String | False | ||
PersonLegalAddressLineThree | String | False | ||
PersonLegalAddressNameCodeValue | String | False | ||
PersonLegalAddressNameCodeLongName | String | True | ||
PersonLegalAddressNameCodeShortName | String | False | ||
PersonLegalAddressPostalCode | String | False | ||
PersonLegalAddressSameAsAddressIndicator | Boolean | False | ||
PersonLegalAddressSameAsAddressLinkCanonicalUri | String | False | ||
PersonLegalAddressSameAsAddressLinkEncType | String | False | ||
PersonLegalAddressSameAsAddressLinkHref | String | False | ||
PersonLegalAddressSameAsAddressLinkMediaType | String | False | ||
PersonLegalAddressSameAsAddressLinkMethod | String | False | ||
PersonLegalAddressSameAsAddressLinkPayLoadArguments | String | False | ||
PersonLegalAddressSameAsAddressLinkRel | String | False | ||
PersonLegalAddressSameAsAddressLinkSchema | String | False | ||
PersonLegalAddressSameAsAddressLinkTargetSchema | String | False | ||
PersonLegalAddressSameAsAddressLinkTitle | String | False | ||
PersonLegalNameFamilyName1 | String | False | ||
PersonLegalNameFamilyName1Prefix | String | False | ||
PersonLegalNameFamilyName2 | String | False | ||
PersonLegalNameFamilyName2Prefix | String | False | ||
PersonLegalNameFormattedName | String | False | ||
PersonLegalNameGenerationAffixCode | String | False |
GenerationAffixCode.CodeValue | |
PersonLegalNameGenerationAffixLongName | String | True | ||
PersonLegalNameGenerationAffixShortName | String | True | ||
PersonLegalNameGivenName | String | False | ||
PersonLegalNameInitials | String | False | ||
PersonLegalNameMiddleName | String | False | ||
PersonLegalNameCode | String | False | ||
PersonLegalNameLongName | String | True | ||
PersonLegalNameShortName | String | False | ||
PersonLegalNameNickName | String | False | ||
PersonLegalNamePreferredSalutations | String | False | ||
PersonLegalNameQualificationAffixCode | String | False |
QualificationAffixCode.CodeValue | |
PersonLegalNameQualificationAffixLongName | String | False | ||
PersonLegalNameQualificationAffixShortName | String | False | ||
PersonLinks | String | True | ||
PersonMaritalStatusCode | String | False |
MaritalStatusCode.CodeValue | |
PersonMaritalStatusEffectiveDateTime | Datetime | False | ||
PersonMaritalStatusLongName | String | True | ||
PersonMaritalStatusShortName | String | False |
MaritalStatusCode.ShortName | |
PersonMilitaryClassificationCodes | String | False |
Supported values Disabled Veteran,Active Duty Wartime or Campaign Badge Veteran,Armed Forces Service Medal Veteran,Recently Separated Veteran | |
PersonMilitaryDischargeDate | Date | False | ||
PersonMilitaryStatusCode | String | False | ||
PersonMilitaryStatusEffectiveDate | Datetime | True | ||
PersonMilitaryStatusLongName | String | True | ||
PersonMilitaryStatusShortName | String | False | ||
PersonOtherPersonalAddresses | String | False | ||
PersonPassports | String | False | ||
PersonPreferredNameFamilyName1 | String | True | ||
PersonPreferredNameFamilyName1Prefix | String | True | ||
PersonPreferredNameFamilyName2 | String | True | ||
PersonPreferredNameFamilyName2Prefix | String | True | ||
PersonPreferredNameFormattedName | String | True | ||
PersonPreferredNameGenerationAffixCode | String | True | ||
PersonPreferredNameGenerationAffixLongName | String | True | ||
PersonPreferredNameGenerationAffixShortName | String | True | ||
PersonPreferredNameGivenName | String | True | ||
PersonPreferredNameInitials | String | True | ||
PersonPreferredNameMiddleName | String | True | ||
PersonPreferredNameCode | String | True | ||
PersonPreferredNameLongName | String | True | ||
PersonPreferredNameShortName | String | True | ||
PersonPreferredNameNickName | String | True | ||
PersonPreferredNamePreferredSalutations | String | True | ||
PersonPreferredNameQualificationAffixCode | String | True | ||
PersonPreferredNameQualificationAffixLongName | String | True | ||
PersonPreferredNameQualificationAffixShortName | String | True | ||
PersonPreferredNameScriptCode | String | True | ||
PersonPreferredNameScriptLongName | String | True | ||
PersonPreferredNameScriptShortName | String | True | ||
PersonPreferredNameTitleAffixCodes | String | True | ||
PersonPreferredNameTitlePrefixCodes | String | True | ||
PersonReligionCode | String | True | ||
PersonReligionLongName | String | True | ||
PersonReligionShortName | String | True | ||
PersonResidencyCountryCodes | String | True | ||
PersonSexualOrientationCode | String | True | ||
PersonSexualOrientationLongName | String | True | ||
PersonSexualOrientationShortName | String | True | ||
PersonSocialInsurancePrograms | String | True | ||
PersonStudentIndicator | Boolean | True | ||
PersonStudentStatusCode | String | True | ||
PersonStudentStatusEffectiveDate | Date | True | ||
PersonStudentStatusLongName | String | True | ||
PersonStudentStatusShortName | String | True | ||
PersonTobaccoUserIndicator | Boolean | True | ||
PersonWorkAuthorizationDocuments | String | True | ||
Links | String | True | ||
AsOfDate | Date | True | ||
PersonBirthDate | Date | False |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
PayrollGroupCode | String |
Insert Only |
OnboardingTemplateCode | String |
Insert Only |
OnboardingTemplateCodeName | String |
Insert Only |
OnboardingStatusCode | String |
Insert Only |
OnboardingStatusCodeName | String |
Insert Only |
HireReasonCode | String |
Insert Only |
HireReasonCodeName | String |
Insert Only |
Returns workers person communication emails.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationEmails WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationEmails table:
UPDATE WorkersPersonCommunicationEmails SET EmailUri = '[email protected]' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerID | String | True |
Workers.WorkerID | |
EmailUri | String | False | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
Returns workers person communication faxes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationFaxes table:
UPDATE WorkersPersonCommunicationFaxes SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerID | String | True |
Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
Returns workers person communication landlines.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationLandlines table:
UPDATE WorkersPersonCommunicationLandlines SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerID | String | True |
Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
Returns workers person communication mobiles.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationMobiles table:
UPDATE WorkersPersonCommunicationMobiles SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerID | String | True |
Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
Returns workers person communication pagers.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonCommunicationPagers WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update a WorkersPersonCommunicationPagers table:
UPDATE WorkersPersonCommunicationPagers SET AreaDialing = '232', DialNumber = '1234567' WHERE AssociateOID = 'G3349PZGBADQY8H8'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerID | String | True |
Workers.WorkerID | |
Access | String | False | ||
AreaDialing | String | False | ||
CountryDialing | String | False | ||
DialNumber | String | False | ||
Extension | String | False | ||
FormattedNumber | String | True | ||
ItemID | String | True | ||
NameCode | String | True | ||
NameCodeLongName | String | True | ||
NameCodeShortName | String | True | ||
NotificationIndicator | Boolean | True | ||
AsOfDate | Date | True |
Returns workers details.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignments WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignments WHERE WorkerIdValue = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignments WHERE AsOfDate = '2020-01-01'
Following is an example of how to Update BaseRemuneration:
UPDATE WorkersWorkAssignments SET StandardHoursQuantity = '45', BaseRemunerationEffectiveDate = '2020-12-21', PayCycleCodeValue = '4', BaseRemunerationHourlyRateAmountValue = 300, WageLawCoverageCodeValue = 'N', BaseRemunerationCode = 'ADJ', ItemId = '34321368N' WHERE AssociateOID = 'G3GMC21PJFZT7K4F'
Following is an example of how to Update AdditionalRemuneration using aggregates:
UPDATE WorkersWorkAssignments SET AdditionalRemunerations = '[{"remunerationTypeCode":{"code":"AE","name":"additional earnings"},"remunerationRate":{"rate":70,"currencyCode":"USD"},"effectiveDate":"2020-12-20","nameCode":{"code":"1FA"},"inactiveIndicator":false}]', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update AdditionalRemuneration using Temp Table:
INSERT INTO Input_AdditionalRemunerations#TEMP (RemunerationTypeCode, RemunerationRate, RemunerationCurrencyCode, effectiveDate, NameCode, InactiveIndicator) VALUES ('AE', '70', 'USD', '2021-01-04', 'R', false) UPDATE WorkersWorkAssignments SET AdditionalRemunerations = 'Input_AdditionalRemunerations#TEMP', itemid = '35777493N' WHERE AssociateOID = 'G3TGG0M57JZEXCP1'
Following is an example of how to Update Worker Assignment Termination:
UPDATE WorkersWorkAssignments SET TerminationDate = '2020-01-31', LastWorkedDate = '2020-01-31', AssignmentStatusReasonCodeValue = 'A00', RehireEligibleIndicator = true, SeveranceEligibleIndicator = true, TerminationComments = 'Looking for better growth and oppurtunities', itemid = '00691088N' WHERE AssociateOID = 'G3TGG0M57JZECKRB'
Following is an example of how to Update Worker Type:
UPDATE WorkersWorkAssignments SET WorkerTypeCodeValue = 'F', ItemId = '31095304_1668', EventReasonCode = 'ADL', EffectiveDate = '2021-01-01' WHERE AssociateOID = 'G3Q8G47NKHBV1SMT'
Name | Type | ReadOnly | References | Description |
AssociateOID [KEY] | String | True |
Workers.AssociateOID | |
WorkerIdValue | String | True |
Workers.WorkerID | |
ItemID [KEY] | String | False | ||
ActualStartDate | Date | True | ||
CompaRatio | Integer | True | ||
AdditionalRemunerations | String | False | ||
AnnualBenefitBaseRateAmountValue | Integer | True | ||
AnnualBenefitBaseRateCurrencyCode | String | True | ||
AnnualBenefitBaseRateNameCodeValue | String | True | ||
AnnualBenefitBaseRateNameCodeLongName | String | True | ||
AnnualBenefitBaseRateNameCodeShortName | String | True | ||
AssignedOrganizationalUnits | String | False | ||
AssignedWorkLocations | String | True | ||
AssignmentCostCenters | String | True | ||
AssignmentStatusEffectiveDate | Date | True | ||
AssignmentStatusReasonCodeValue | String | False | ||
AssignmentStatusReasonCodeLongName | String | True | ||
AssignmentStatusReasonCodeShortName | String | True | ||
AssignmentStatusStatusCodeValue | String | True | ||
AssignmentStatusStatusCodeLongName | String | True | ||
AssignmentStatusStatusCodeShortName | String | True | ||
AssignmentTermCodeValue | String | True | ||
AssignmentTermCodeLongName | String | True | ||
AssignmentTermCodeShortName | String | True | ||
BargainingUnitBargainingUnitCodeValue | String | False | ||
BargainingUnitBargainingUnitCodeLongName | String | True | ||
BargainingUnitBargainingUnitCodeShortName | String | False | ||
BargainingUnitSeniorityDate | Date | False | ||
BaseRemunerationAnnualRateAmountValue | Decimal | True | ||
BaseRemunerationAnnualRateAmountCurrencyCode | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeValue | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeLongName | String | True | ||
BaseRemunerationAnnualRateAmountNameCodeShortName | String | True | ||
BaseRemunerationAssociatedRateQualifiers | String | True | ||
BaseRemunerationBiweeklyRateAmountValue | Decimal | True | ||
BaseRemunerationBiweeklyRateAmountCurrencyCode | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeValue | String | True | ||
BaseRemunerationBiweeklyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeValue | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeLongName | String | True | ||
BaseRemunerationCommissionRatePercentageBaseUnitCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeValue | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeLongName | String | True | ||
BaseRemunerationCommissionRatePercentageNameCodeShortName | String | True | ||
BaseRemunerationCommissionRatePercentagePercentageValue | Integer | True | ||
BaseRemunerationDailyRateAmountValue | Decimal | False | ||
BaseRemunerationDailyRateAmountCurrencyCode | String | True | ||
BaseRemunerationDailyRateAmountNameCodeValue | String | False | ||
BaseRemunerationDailyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationDailyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationEffectiveDate | Date | False | ||
BaseRemunerationHourlyRateAmountValue | Decimal | False | ||
BaseRemunerationHourlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeValue | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationHourlyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationMonthlyRateAmountValue | Decimal | True | ||
BaseRemunerationMonthlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationMonthlyRateAmountNameCodeValue | String | False | ||
BaseRemunerationMonthlyRateAmountNameLongName | String | True | ||
BaseRemunerationMonthlyRateAmountNameShortName | String | False | ||
BaseRemunerationPayPeriodRateAmountValue | Decimal | True | ||
BaseRemunerationPayPeriodRateAmountCurrencyCode | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeValue | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeLongName | String | True | ||
BaseRemunerationPayPeriodRateAmountNameCodeShortName | String | True | ||
BaseRemunerationRecordingBasisCodeValue | String | True | ||
BaseRemunerationRecordingBasisCodelongName | String | True | ||
BaseRemunerationRecordingBasisCodeShortName | String | True | ||
BaseRemunerationSemiMonthlyRateAmountValue | Decimal | True | ||
BaseRemunerationSemiMonthlyRateAmountCurrencyCode | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeValue | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationSemiMonthlyRateAmountNameCodeShortName | String | True | ||
BaseRemunerationWeeklyRateAmountValue | Decimal | True | ||
BaseRemunerationWeeklyRateAmountCurrencyCode | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeValue | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeLongName | String | True | ||
BaseRemunerationWeeklyRateAmountNameCodeShortName | String | True | ||
ExecutiveIndicator | Boolean | True | ||
ExecutiveTypeCodeValue | String | True | ||
ExecutiveTypeCodeLongName | String | True | ||
ExecutiveTypeCodeShortName | String | True | ||
ExpectedStartDate | Date | True | ||
ExpectedTerminationDate | Date | True | ||
FullTimeEquivalenceRatio | Integer | True | ||
GeographicPayDifferentialCodeValue | String | True | ||
GeographicPayDifferentialCodeLongName | String | True | ||
GeographicPayDifferentialCodeShortName | String | True | ||
GeographicPayDifferentialPercentage | Integer | True | ||
HighlyCompensatedIndicator | Boolean | True | ||
HighlyCompensatedTypeCodeValue | String | True | ||
HighlyCompensatedTypeCodeLongName | String | True | ||
HighlyCompensatedTypeCodeShortName | String | True | ||
HireDate | Date | True | ||
HomeOrganizationalUnits | String | False | ||
HomeWorkLocationAddressAttentionOfName | String | True | ||
HomeWorkLocationAddressBlockName | String | True | ||
HomeWorkLocationAddressBuildingName | String | True | ||
HomeWorkLocationAddressBuildingNumber | String | True | ||
HomeWorkLocationAddressCareOfName | String | True | ||
HomeWorkLocationAddressCityName | String | False | ||
HomeWorkLocationAddressCountryCode | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1CodeValue | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1LongName | String | True | ||
HomeWorkLocationAddressCountrySubdivisionLevel1ShortName | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel1SubdivisionType | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2CodeValue | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2LongName | String | True | ||
HomeWorkLocationAddressCountrySubdivisionLevel2ShortName | String | False | ||
HomeWorkLocationAddressCountrySubdivisionLevel2SubdivisionType | String | False | ||
HomeWorkLocationAddressDeliveryPoint | String | True | ||
HomeWorkLocationAddressDoor | String | True | ||
HomeWorkLocationAddressFloor | String | True | ||
HomeWorkLocationAddressGeoCoordinateLatitude | Integer | True | ||
HomeWorkLocationAddressGeoCoordinateLongitude | Integer | True | ||
HomeWorkLocationAddressLineFive | String | True | ||
HomeWorkLocationAddressLineFour | String | True | ||
HomeWorkLocationAddressLineOne | String | False | ||
HomeWorkLocationAddressLineTwo | String | False | ||
HomeWorkLocationAddressLineThree | String | False | ||
HomeWorkLocationAddressNameCodeValue | String | True | ||
HomeWorkLocationAddressNameCodeLongName | String | True | ||
HomeWorkLocationAddressNameCodeShortName | String | True | ||
HomeWorkLocationAddressPlotID | String | True | ||
HomeWorkLocationAddressPostalCode | String | False | ||
HomeWorkLocationAddressPostOfficeBox | String | True | ||
HomeWorkLocationAddressScriptCodeValue | String | True | ||
HomeWorkLocationAddressScriptCodeLongName | String | True | ||
HomeWorkLocationAddressScriptCodeShortName | String | True | ||
HomeWorkLocationAddressStairCase | String | True | ||
HomeWorkLocationAddressStreetName | String | True | ||
HomeWorkLocationAddressStreetTypeCodeValue | String | True | ||
HomeWorkLocationAddressStreetTypeCodeLongName | String | True | ||
HomeWorkLocationAddressStreetTypeCodeShortName | String | True | ||
HomeWorkLocationAddressUnit | String | True | ||
HomeWorkLocationCommunicationEmails | String | True | ||
HomeWorkLocationCommunicationFaxes | String | True | ||
HomeWorkLocationCommunicationLandlines | String | True | ||
HomeWorkLocationCommunicationMobiles | String | True | ||
HomeWorkLocationCommunicationPagers | String | True | ||
HomeWorkLocationNameCodeValue | String | False | ||
HomeWorkLocationNameCodeLongName | String | True | ||
HomeWorkLocationNameCodeShortName | String | False | ||
IndustryClassifications | String | False | ||
JobCodeValue | String | False | ||
JobCodeEffectiveDate | Date | True | ||
JobCodeLongName | String | True | ||
JobCodeShortName | String | False | ||
JobTitle | String | True | ||
LaborUnionLaborUnionCodeValue | String | False | ||
LaborUnionLaborUnionCodeLongName | String | True | ||
LaborUnionLaborUnionCodeShortName | String | False | ||
LaborUnionSeniorityDate | Date | True | ||
LegalEntityID | String | True | ||
Links | String | True | ||
ManagementPositionIndicator | Boolean | False | ||
MinimumPayGradeStepDuration | String | True | ||
NationalityContextCodeValue | String | True | ||
NationalityContextCodeLongName | String | True | ||
NationalityContextCodeShortName | String | True | ||
NextPayGradeStepDate | Date | True | ||
OccupationalClassifications | String | False | ||
OfferAcceptanceDate | Date | True | ||
OfferExtensionDate | Date | True | ||
OfficerIndicator | Boolean | True | ||
OfficerTypeCodeValue | String | False | ||
OfficerTypeCodeLongName | String | True | ||
OfficerTypeCodeShortName | String | False | ||
PayCycleCodeValue | String | False | ||
PayCycleCodeLongName | String | True | ||
PayCycleCodeShortName | String | False | ||
PayGradeCodeValue | String | False | ||
PayGradeCodeLongName | String | True | ||
PayGradeCodeShortName | String | False | ||
PayGradePayRangeMaximumRateAmountValue | Decimal | True | ||
PayGradePayRangeMaximumRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMaximumRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMaximumRateCurrencyCode | String | True | ||
PayGradePayRangeMaximumRateUnitCodeValue | String | True | ||
PayGradePayRangeMaximumRateUnitCodeLongName | String | True | ||
PayGradePayRangeMaximumRateUnitCodeShortName | String | True | ||
PayGradePayRangeMedianRateAmountValue | Decimal | True | ||
PayGradePayRangeMedianRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMedianRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMedianRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMedianRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMedianRateCcurrencyCode | String | True | ||
PayGradePayRangeMedianRateUnitCodeValue | String | True | ||
PayGradePayRangeMedianRateUnitCodeLongName | String | True | ||
PayGradePayRangeMedianRateUnitCodeShortName | String | True | ||
PayGradePayRangeMinimumRateAmountValue | Decimal | True | ||
PayGradePayRangeMinimumRateBaseMultiplierValue | Integer | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeValue | String | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeLongName | String | True | ||
PayGradePayRangeMinimumRateBaseUnitCodeShortName | String | True | ||
PayGradePayRangeMinimumRateCurrencyCode | String | True | ||
PayGradePayRangeMinimumRateUnitCodeValue | String | True | ||
PayGradePayRangeMinimumRateUnitCodeLongName | String | True | ||
PayGradePayRangeMinimumRateUnitCodeShortName | String | True | ||
PayGradeStepCodeValue | String | True | ||
PayGradeStepCodeLongName | String | True | ||
PayGradeStepCodeShortName | String | True | ||
PayGradeStepPayRateAmountValue | Decimal | True | ||
PayGradeStepPayRateBaseMultiplierValue | Integer | True | ||
PayGradeStepPayRateBaseUnitCodeValue | String | True | ||
PayGradeStepPayRateBaseUnitCodeLongName | String | True | ||
PayGradeStepPayRateBaseUnitCodeShortName | String | True | ||
PayGradeStepPayRateCurrencyCode | String | True | ||
PayGradeStepPayRateUnitCodeValue | String | True | ||
PayGradeStepPayRateUnitCodeLongName | String | True | ||
PayGradeStepPayRateUnitCodeShortName | String | True | ||
PayrollFileNumber | String | False | ||
PayrollGroupCode | String | False | ||
PayrollProcessingStatusCodeValue | String | True | ||
PayrollProcessingStatusCodeEffectiveDate | Date | True | ||
PayrollProcessingStatusCodeLongName | String | True | ||
PayrollProcessingStatusCodeShortName | String | True | ||
PayrollRegionCode | String | True | ||
PayrollScheduleGroupID | String | True | ||
PayScaleCodeValue | String | True | ||
PayScaleCodeLongName | String | True | ||
PayScaleCodeShortName | String | True | ||
PositionID | String | False | ||
PositionTitle | String | True | ||
PrimaryIndicator | Boolean | True | ||
RemunerationBasisCodeValue | String | True | ||
RemunerationBasisCodeLongName | String | True | ||
RemunerationBasisCodeShortName | String | True | ||
ReportsTo | String | False | ||
SeniorityDate | Date | True | ||
StandardHoursQuantity | Integer | False | ||
StandardHoursUnitCodeValue | String | True | ||
StandardHoursUnitCodeLongName | String | True | ||
StandardHoursUnitCodeShortName | String | True | ||
StandardPayPeriodHoursHoursQuantity | Integer | True | ||
StandardPayPeriodHoursUnitCodeValue | String | True | ||
StandardPayPeriodHoursUnitCodeLongName | String | True | ||
StandardPayPeriodHoursUnitCodeShortName | String | True | ||
StockOwnerIndicator | Boolean | True | ||
StockOwnerPercentage | Integer | True | ||
TerminationDate | Date | False | ||
VipIndicator | Boolean | True | ||
VipTypeCodeValue | String | True | ||
VipTypeCodeLongName | String | True | ||
VipTypeCodeShortName | String | True | ||
WageLawCoverageCodeValue | String | False |
WageLawCoverageCode.CodeValue | |
WageLawCoverageCodeLongName | String | True | ||
WageLawCoverageCodeShortName | String | False | ||
WageLawCoverageWageLawNameCodeValue | String | True | ||
WageLawCoverageWageLawNameCodeLongName | String | True | ||
WageLawCoverageWageLawNameCodeShortName | String | True | ||
WorkArrangementCodeValue | String | True | ||
WorkArrangementCodeLongName | String | True | ||
WorkArrangementCodeShortName | String | True | ||
WorkerGroups | String | True | ||
WorkerProbationIndicator | Boolean | True | ||
WorkerProbationPeriodEndDate | Date | True | ||
WorkerProbationPeriodStartDate | Date | True | ||
WorkerTypeCodeValue | String | False |
WorkerTypeCode.CodeValue | |
WorkerTypeCodeLongName | String | True | ||
WorkerTypeCodeShortName | String | True | ||
WorkLevelCodeValue | String | True | ||
WorkLevelCodeLongName | String | True | ||
WorkLevelCodeShortName | String | True | ||
WorkShiftCodeValue | String | True | ||
WorkShiftCodeLongName | String | True | ||
WorkShiftCodeShortName | String | True | ||
AsOfDate | Date | True |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
EffectiveDate | Date |
To update positionid and AssignedOrganizationalUnits |
LastWorkedDate | Date |
Worker Termination Update |
RehireEligibleIndicator | Boolean |
Worker Termination Update |
SeveranceEligibleIndicator | Boolean |
Worker Termination Update |
TerminationComments | String |
Worker Termination Update |
BaseRemunerationCode | String | |
EventReasonCode | String |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
Name | Description |
AdditionalRemunerationNameCode | Returns additional remuneration name code. |
AssociatePaymentsAllocationsEarningsAndBenefits | View the associate payment allocation earnings and benefits in the payroll outputs. |
AssociatePaymentsAllocationsEarningSections | View the earning sections for the associate payments allocations in payroll outputs. |
AssociatePaymentsAllocationsNonStatutoryDeductions | View the non-statutory deductions for the associate payments allocations in payroll outputs. |
AssociatePaymentsAllocationsStatutoryDeductions | View the statutory deductions for the associate payments allocations in payroll outputs. |
AssociatePaymentsSummaryEarningsAndBenefits | View the associate payments earnings and benefits in the payroll outputs. |
AssociatePaymentsSummaryEarningsSections | View the associate payments earnings sections items in the payroll outputs. |
AssociatePaymentsSummaryNonStatutoryDeductions | To view the non statutory deduction for the associate in payroll outputs. |
AssociatePaymentsSummaryPayrollAccumulations | To View the associate payments payroll accumulations in the payroll outputs. |
AssociatePaymentsSummaryStatutoryDeductions | View the statutory deduction for the associate in payroll outputs. |
CostCenters | Returns all Cost number codes setup for the client. |
DeductionInputCode | Returns deduction input code. |
EarningInputCode | Returns earning input code. |
GenerationAffixCode | Returns legal name generation affix code. |
HighestEducationLevelCode | Returns highest education level code value. |
JobApplications | Returns a list of job applications. |
jobRequisitions | Returns a list of job requisitions. |
MaritalStatusCode | Returns marital status codes. |
OnboardingTemplate | Returns onboarding template. |
PaidTimeOffBalances | Returns Paid TimeOff Balances. |
PaidTimeOffRequestEntries | Returns PaidTimeOff Requests. |
PaidTimeOffRequests | Returns PaidTimeOff Requests. |
PayrollGroup | Returns payroll group. |
PersonalContacts | Personal emergency contacts. |
QualificationAffixCode | Returns work assignement worker type code. |
ReimbursementInputCode | Returns reimbursement input code. |
TeamTimeCards | View the Team Time Cards. |
TeamTimeCardsDailyTotals | View the Team Time Cards daily totals aggregate. |
TeamTimeCardsHomeLaborAllocations | View the Team Time Cards period totals aggregate. |
TeamTimeCardsPeriodTotals | View the Team Time Cards period totals aggregate. |
TimeCards | View the worker Time Cards. |
TimeCardsDailyTotals | View the worker Time Cards daily totals aggregate. |
TimeCardsPeriodTotals | View the worker Time Cards period totals aggregate. |
WageLawCoverageCode | Returns wage law coverage code. |
WorkAssignmentCustomHistoryCustomGroupAmountFields | Work assignment CustomGroup amount. |
WorkAssignmentCustomHistoryCustomGroupCodeFields | Work assignment CustomGroup code. |
WorkAssignmentCustomHistoryCustomGroupDateFields | Work assignment CustomGroup date. |
WorkAssignmentCustomHistoryCustomGroupDateTimeFields | Work assignment CustomGroup date time. |
WorkAssignmentCustomHistoryCustomGroupIndicatorFields | Work assignment CustomGroup indicator. |
WorkAssignmentCustomHistoryCustomGroupLinks | Work assignment CustomGroup links. |
WorkAssignmentCustomHistoryCustomGroupNumberFields | Work assignment CustomGroup number. |
WorkAssignmentCustomHistoryCustomGroupPercentFields | Work assignment CustomGroup percent. |
WorkAssignmentCustomHistoryCustomGroupStringFields | Work assignment CustomGroup string. |
WorkAssignmentCustomHistoryCustomGroupTelephoneFields | Work assignment CustomGroup telephone. |
WorkAssignmentHistory | Work assignment history. |
WorkAssignmentHistoryAdditionalRemunerations | Work assignment additionsla remunerations history. |
WorkAssignmentHistoryAssignedOrganizationalUnits | Work assignment organization units history. |
WorkAssignmentHistoryAssignedWorkLocations | Work assignment Assigned locations history. |
WorkAssignmentHistoryCommunicationsEmails | Work assignment communication history mail. |
WorkAssignmentHistoryCommunicationsFaxes | Work assignment communication Fax History. |
WorkAssignmentHistoryCommunicationsInstantMessages | Work assignment communication message History. |
WorkAssignmentHistoryCommunicationsInternetAddresses | Work assignment communication Internet address History. |
WorkAssignmentHistoryCommunicationsLandlines | Work assignment communication landline history. |
WorkAssignmentHistoryCommunicationsMobiles | Work assignment communication mobile History. |
WorkAssignmentHistoryCommunicationsPagers | Work assignment communication Pager History. |
WorkAssignmentHistoryCommunicationsSocialNetworks | Work assignment communication social network history. |
WorkAssignmentHistoryHomeOrganizationalUnits | Work assignment Home organization history. |
WorkAssignmentHistoryIndustryClassifications | Work assignment industry classification history. |
WorkAssignmentHistoryOccupationalClassifications | Work assignment occupational classification history. |
WorkAssignmentHistoryReport | Work assignment Report. |
WorkAssignmentHistoryWorkerGroups | Work assignment group history. |
WorkerDemographics | Returns a list of demographics for each worker in the organization. |
WorkersBusinessCommunicationEmails | Returns workers business communication emails. |
WorkersBusinessCommunicationFaxes | Returns workers business communication faxes. |
WorkersBusinessCommunicationLandlines | Returns workers business communication landlines. |
WorkersBusinessCommunicationMobiles | Returns workers business communication mobiles. |
WorkersBusinessCommunicationPagers | Returns workers business communication pagers. |
WorkersPersonBirthNamePreferredSalutations | Returns workers person birth name preferred salutations. |
WorkersPersonBirthNameTitleAffixCodes | Returns workers person birth name title affix codes. |
WorkersPersonBirthNameTitlePrefixCodes | Returns workers person birth name title prefix codes. |
WorkersPersonGovernmentIDs | Returns workers person government IDs. |
WorkersPersonLegalNamePreferredSalutations | Returns workers person legal name preferred salutations. |
WorkersPersonLegalNameTitleAffixCodes | Returns workers person legal name title affix codes. |
WorkersPersonLegalNameTitlePrefixCodes | Returns workers person legal name title prefix codes. |
WorkersPersonMilitaryClassificationCodes | Returns workers person military classification codes. |
WorkersPhotoLinks | Returns workers photo links. |
WorkersPhotos | Returns workers photos. |
WorkersWorkAssignmentReportsTo | Returns workers work assignment ReportsTo. |
WorkersWorkAssignmentsAssignedOrganizationalUnits | Returns workers work assignments assigned organizational units. |
WorkersWorkAssignmentsAssignedWorkLocations | Returns workers work assignments assigned work locations. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails | Returns workers work assignments assigned work locations communication emails. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes | Returns workers work assignments assigned work locations communication faxes. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines | Returns workers work assignments assigned work locations communication landlines. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles | Returns workers work assignments assigned work locations communication mobiles. |
WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers | Returns workers work assignments assigned work locations communication pagers. |
WorkersWorkAssignmentsHomeOrganizationalUnits | Returns workers work assignments home organizational units. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails | Returns workers work assignments home work location communication emails. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationInstantMessages | Returns workers work assignments home work location communication instant messages. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines | Returns workers work assignments home work location communication landlines. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles | Returns workers work assignments home work location communication mobiles. |
WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers | Returns workers work assignments home work location communication pagers. |
WorkersWorkAssignmentsIndustryClassifications | Returns workers work assignments industry classifications. |
WorkersWorkAssignmentsLinks | Returns workers work assignments links. |
WorkersWorkAssignmentsOccupationalClassifications | Returns workers work assignments occupational classifications. |
WorkersWorkAssignmentsWorkerGroups | Work assignments worker groups. |
WorkerTypeCode | Returns work assignement worker type code. |
WorkSchedules | View the Work Schedules. |
WorkSchedulesEntries | View the schedule days entries in Work Schedules. |
Returns additional remuneration name code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String |
View the associate payment allocation earnings and benefits in the payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsAllocationsEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
payments | String |
View the earning sections for the associate payments allocations in payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsAllocationsEarningSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
ConfigurationTags | String | ||
EarningAmountValue | Double | ||
EarningClassificationCodeValue | String | ||
EarningClassificationCodeShortName | String | ||
EarningIDDescription | String | ||
EarningIDValue | String | ||
PayRateBaseUnitCodeValue | String | ||
PayRateBaseUnitCodeShortName | String | ||
PayRateValue | Double | ||
TimeWorkedQuantityValue | Double | ||
TimeWorkedQuantityunitTimeCodeValue | String | ||
TimeWorkedQuantityUnitTimeCodeShortName | String | ||
DepartmentId | String |
View the non-statutory deductions for the associate payments allocations in payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsAllocationsNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | . | |
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionTakenAmountValue | Double | ||
DeductionIDDescription | String | ||
DeductionIDValue | String | ||
DepartmentId | String |
View the statutory deductions for the associate payments allocations in payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionTakenAmountValue | Double | ||
AssociateTaxableAmountValue | Double | ||
ConfigurationTags | String | ||
EmployerPaidAmountValue | Double | ||
EmployerTaxableAmountValue | Double | ||
StatutoryDeductionTypeCodeValue | String | ||
StatutoryDeductionTypeCodeShortName | String | ||
StatutoryJurisdictionAdministrativeLevel1.codeValue | String | ||
StatutoryJurisdictionWorkedInIndicator | Boolean | ||
DepartmentId | String |
View the associate payments earnings and benefits in the payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryEarningsAndBenefits WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
Payments | String |
View the associate payments earnings sections items in the payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryEarningsSections WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
ConfigurationTags | String | ||
EarningAmountValue | Double | ||
EarningClassificationCodeValue | String | ||
EarningClassificationCodeShortName | String | ||
EarningIDDescription | String | ||
EarningIDValue | String | ||
PayRateBaseUnitCodeValue | String | ||
PayRateBaseUnitCodeShortName | String | ||
PayRateRateValue | Double | ||
PayrollAccumulations | String | ||
TimeWorkedQuantityValue | Double | ||
TimeWorkedQuantityUnitTimeCodeValue | String | ||
TimeWorkedQuantityUnitTimeCodeName | String | ||
DepartmentId | String |
To view the non statutory deduction for the associate in payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryNonStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection |
AssociateOID | String | ||
SectionName | String | ||
SectionCategory | String | ||
AssociateDeductionAmountValue | Double | ||
AssociateDeductionTakenAmountValue | Double | ||
DeductionIDDescription | String | ||
DeductionIDValue | String | ||
PayrollAccumulations | String | ||
DepartmentId | String |
To View the associate payments payroll accumulations in the payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryPayrollAccumulations WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
AccumulatedAmountValue | Double | ||
AccumulatedTimeWorkedQuantityValue | Double | ||
AccumulatedTimeWorkedQuantityUnitTimeCodeValue | String | ||
AccumulatedTimeWorkedQuantityUnitTimeCodeShortName | String | ||
AccumulatorCodeValue | String | ||
AccumulatorCodeLongName | String | ||
AccumulatorCodeShortName | String | ||
AccumulatorDescription | String | ||
AccumulatorTimeUnitCodeValue | String | ||
AccumulatorTimeUnitCodeShortName | String | ||
DepartmentId | String |
View the statutory deduction for the associate in payroll outputs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ItemId is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId = 'TXSMIb+yh9UbJ9-im9au7g==' SELECT * FROM AssociatePaymentsSummaryStatutoryDeductions WHERE ItemId IN ('TXSMIb+yh9UbJ9-im9au7g==', 'XXSMIb+yh9UbJ9-im9au7g==')
Name | Type | References | Description |
ItemID | String |
PayrollRuns.ItemID | The unique identifier of a instance within the collection. |
AssociateOID | String | ||
SectionCategory | String | ||
SectionName | String | ||
AssociateDeductionAmountValue | Double | ||
AssociateDeductionTakenAmountValue | Double | ||
AssociateTaxableAmountValue | Double | ||
ConfigurationTags | String | ||
EmployerPaidAmountValue | Double | ||
EmployerTaxableAmountValue | Double | ||
PayrollAccumulations | String | ||
StatutoryDeductionTypeCodeValue | String | ||
StatutoryDeductionTypeCodeASortName | String | ||
StatutoryJurisdictionAdministrativeLevel1CodeValue | String | ||
StatutoryJurisdictionWorkedInIndicator | Boolean | ||
DepartmentId | String |
Returns all Cost number codes setup for the client.
No filters are supported server side for this table. All criteria will be handled client side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM CostCenters
Name | Type | References | Description |
Code | String | Code for the Cost Center. | |
Description | String | Description for the Cost Center. | |
CompanyCode | String | Payroll Group Code. | |
Active | Boolean | It indicate if the department is still in use. |
Returns deduction input code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String | ||
Description | String |
Returns earning input code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String | ||
LongName | String | ||
Description | String |
Returns legal name generation affix code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String |
Returns highest education level code value.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String |
Returns a list of job applications.
No filters are supported server side for this table. All criteria will be handled client side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM JobApplications
Name | Type | References | Description |
ItemID | String | ||
RequisitionID | String | ||
RequisitionTitle | String | ||
ClientRequisitionID | String | ||
InternalIndicator | Boolean | ||
ExternalIndicator | Boolean | ||
HiringManagerID | String | ||
HiringManagerWorkerID | String | ||
HiringManagerGivenName | String | ||
HiringManagerFamilyName | String | ||
HiringManagerFormattedName | String | ||
ApplicationEffectiveDate | Date | ||
ApplicationShortName | String | ||
ApplicationCode | String | ||
ApplicationPostingChannelID | String | ||
ApplicationPostingChannelCode | String | ||
ApplicationPostingChannelShortName | String | ||
ApplicationSubmittedDate | Date | ||
ApplicantID | String | ||
ApplicantInternalIndicator | Boolean | ||
ApplicantWotcScreeningShortName | String | ||
ApplicantWotcScreeningLongName | String | ||
ApplicantWotcScreeningCode | String | ||
ApplicantBackgroundScreeningLongName | String | ||
ApplicantBackgroundScreeningCode | String | ||
ApplicantCountryCode | String | ||
ApplicantCityName | String | ||
ApplicantCountrySubdivisionType | String | ||
ApplicantCountrySubdivisionShortName | String | ||
ApplicantCountrySubdivisionCode | String | ||
ApplicantAddressLine1 | String | ||
ApplicantPostalCode | String | ||
CommunicationLandlines | String | ||
CommunicationMobiles | String | ||
ApplicantGivenName | String | ||
ApplicantFamilyName | String | ||
ApplicantFormattedName | String | ||
AppliedLocationItemID | String | ||
AppliedLocationCode | String | ||
AppliedLocationShortName | String |
Returns a list of job requisitions.
No filters are supported server side for this table. All criteria will be handled client side within the Cloud.
For example, the following query is processed server side:
SELECT * FROM JobRequisitions
Name | Type | References | Description |
ItemID | String | ||
PostingInstructionsCode | String | ||
PostingInstructionsLongName | String | ||
PostingInstructionsInternalIndicator | Boolean | ||
PostingChannelID | String | ||
PostingChannelCode | String | ||
PostingChannelShortName | String | ||
PostingChannelLongName | String | ||
PostingChannelInternetAddress | String | ||
PostingChannelExternalIndicator | Boolean | ||
PostingChannelDefaultIndicator | Boolean | ||
PostingInstructionsExpireDate | Date | ||
PostingInstructionsResumeRequiredIndicator | Boolean | ||
PostingInstructionsValidityAttestationIndicator | Boolean | ||
PostingInstructionsPostDate | Date | ||
LinksHref | String | ||
LinksRel | String | ||
LinksTitle | String | ||
SupportedLocaleCodes | String | ||
OpeningsNewPositionQuantity | Integer | ||
WorkedInCountry | String | ||
WorkerTypeCode | String | ||
WorkerTypeShortName | String | ||
CompanyName | String | ||
LocationVisibleIndicator | Boolean | ||
CompensationVisibleIndicator | Boolean | ||
OpeningsFilledQuantity | Integer | ||
OrganizationalUnits | String | ||
OpeningsQuantity | Integer | ||
EvergreenIndicator | Boolean | ||
ProjectedStartDate | Date | ||
ExternalIndicator | Boolean | ||
VisibleToJobSeekerIndicator | Boolean | ||
LieDetectorAcknowledgementIndicator | Boolean | ||
HiringManagerID | String | ||
HiringManagerWorkerID | String | ||
HiringManagerGivenName | String | ||
HiringManagerFamilyName | String | ||
HiringManagerFormattedName | String | ||
ClientRequisitionID | String | ||
RequisitionEffectiveDate | Date | ||
RequisitionShortName | String | ||
RequisitionCode | String | ||
JobCode | String | ||
JobShortName | String | ||
JobTitle | String | ||
OccupationalClassificationsCode | String | ||
OccupationalClassificationsShortName | String | ||
RequisitionLocationsID | String | ||
RequisitionLocationsPostalCode | String | ||
RequisitionLocationsCityName | String | ||
RequisitionLocationsCountrySubdivisionLevel1Code | String | ||
RequisitionLocationsAddressLine1 | String | ||
RequisitionLocationsCountryCode | String | ||
RequisitionLocationsCode | String | ||
RequisitionLocationsShortName | String |
Returns marital status codes.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String | ||
Description | String |
Returns onboarding template.
Name | Type | References | Description |
ItemID | String | ||
Code | String | ||
Name | String |
Returns Paid TimeOff Balances.
The Cloud will use 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 Cloud.
SELECT * FROM PaidTimeOffBalances WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
BalanceTypeCode | String | ||
BalanceTypeLabelName | String | ||
TotalQuantityValueNumber | Double | ||
TotalQuantityUnitTimeCode | String | ||
TotalQuantityLabelName | String | ||
TotalTime | String | ||
AccrualBalances | String | ||
PaidTimeOffEntries | String | ||
PaidTimeOffPolicyCode | String | ||
PaidTimeOffPolicyLabelName | String | ||
AsOfDate | Date | ||
PositionRefPositionID | String | ||
PositionRefSchemeName | String | ||
PositionRefSchemeAgencyName | String | ||
PositionReftitle | String |
Returns PaidTimeOff Requests.
The Cloud will use 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 Cloud.
SELECT * FROM PaidTimeOffRequestEntries WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
RequestID | String | ||
timeOffEntryID | String | ||
paidTimeOffID | String | ||
paidTimeOffPolicyCode | String | ||
paidTimeOffPolicyLabelName | String | ||
EntryStatusCode | String | ||
EntryStatusLabelName | String | ||
EarningTypeCode | String | ||
EarningTypeName | String | ||
StartDate | Date | ||
EndDate | Date | ||
startTime | String | ||
TotalQuantityvalueNumber | String | ||
TotalQuantityunitTimeCode | String | ||
TotalQuantitylabelName | String | ||
Meta | String |
Returns PaidTimeOff Requests.
The Cloud will use 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 Cloud.
SELECT * FROM PaidTimeOffRequests WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
RequestID | String | ||
RequestStatusCode | String | ||
RequestStatusLabelName | String | ||
TotalQuantityvalueNumber | String | ||
TotalQuantityunitTimeCode | String | ||
TotalQuantitylabelName | String | ||
TotalTime | String | ||
paidTimeOffEntries | String | ||
RequestURI | String | ||
RequestDesc | String | ||
RequestStartDate | Date | ||
MetadataEntitlementCodes | String | ||
MetaMultiPeriodRequestIndicator | Boolean | ||
Actions | String | ||
RequestorComment | String | ||
ApprovalDueDate | Date | ||
PositionRefPositionID | String | ||
PositionRefSchemeName | String | ||
PositionRefSchemeAgencyName | String | ||
PositionReftitle | String |
Returns payroll group.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM PayrollGroup WHERE Category = 'US'
Name | Type | References | Description |
Code | String | ||
Name | String | ||
Category | String |
Personal emergency contacts.
The Cloud uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM PersonalContacts WHERE AssociateOID = 'G3349PZGBADQY8H7'The rest of the filter is executed client-side within the Cloud.
Name | Type | References | Description |
PersonName | String | ||
AddressLine1 | String | ||
AddressLine2 | String | ||
AddressLine3 | String | ||
AddressCityName | String | ||
AddressCountrySubdivisionLevel1SubdivisionType | String | ||
AddressCountrySubdivisionLevel1Code | String | ||
AddressCountrySubdivisionLevel1ShortName | String | ||
AddressCountrySubdivisionLevel1LongName | String | ||
AddressCountryCode | String | ||
AddressPostalCode | String | ||
CommunicationLandlines | String | ||
CommunicationMobiles | String | ||
CommunicationEmails | String | ||
ContactTypeCode | String | ||
ContactTypeCodeShortName | String | ||
RelationshipTypeCode | String | ||
RelationshipTypeCodeShortName | String | ||
PrecedenceCode | String | ||
PrecedenceCodeShortName | String | ||
ItemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Returns work assignement worker type code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String | ||
LongName | String | ||
Description | String |
Returns reimbursement input code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String | ||
Description | String |
View the Team Time Cards.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM TeamTimeCards WHERE ManagerOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
PersonLegalName | String | ||
PersonLegalFamilyName1 | String | ||
PersonLegalFormattedName | String | ||
ProcessingStatusCodeValue | String | ||
ProcessingStatusCodeShortName | String | ||
periodCodeValue | String | Supported values: current, next, previous, etc. | |
periodCodeShortName | String | ||
periodCodeLongName | String | ||
TimePeriodStartDate | Date | ||
TimePeriodEndDate | Date | ||
TimePeriodPeriodStatus | String | ||
PositionID | String | ||
PeriodTotals | String | ||
DailyTotals | String | ||
TotalPeriodTimeDuration | String | ||
HomeLaborAllocations | String | ||
ExceptionsIndicator | Boolean | ||
ManagerOID | String |
Workers.AssociateOID |
View the Team Time Cards daily totals aggregate.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM TeamTimeCardsDailyTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
EntryDate | Date | ||
PayCodeCodeValue | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String | ||
HomeLaborAllocations | String | ||
DayEntries | String | ||
ManagerOID | String |
Workers.AssociateOID |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
periodCodeValue | String | Supported values: current, next, previous, etc. | |
TimePeriodStartDate | String | ||
TimePeriodEndDate | String |
View the Team Time Cards period totals aggregate.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM TeamTimeCardsHomeLaborAllocations WHERE ManagerOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
AllocationCode | String | ||
AllocationTypeCodeValue | String | ||
AllocationTypeCodeShortName | String | ||
ManagerOID | String |
Workers.AssociateOID |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
periodCodeValue | String | Supported values: current, next, previous, etc. | |
TimePeriodStartDate | String |
View the Team Time Cards period totals aggregate.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The ManagerOID is required to make a request and the rest of the filter is executed client side within the Cloud.
SELECT * FROM TeamTimeCardsPeriodTotals WHERE ManagerOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
payCodecodeValue | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String | ||
ManagerOID | String |
Workers.AssociateOID |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
periodCodeValue | String | Supported values: current, next, previous, etc. | |
TimePeriodStartDate | String |
View the worker Time Cards.
The Cloud will use 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 Cloud.
SELECT * FROM TimeCards WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
PersonLegalName | String | ||
PersonLegalFamilyName1 | String | ||
PersonLegalFormattedName | String | ||
ProcessingStatusCodeValue | String | ||
ProcessingStatusCodeShortName | String | ||
periodCodeValue | String | Supported values: current, next, previous, etc. | |
periodCodeShortName | String | ||
periodCodeLongName | String | ||
TimePeriodStartDate | Date | ||
TimePeriodEndDate | Date | ||
TimePeriodPeriodStatus | String | ||
PositionID | String | ||
ExceptionCounts | String | ||
PeriodTotals | String | ||
DailyTotals | String | ||
TotalPeriodTimeDuration | String | ||
HomeLaborAllocations | String | ||
Actions | String |
View the worker Time Cards daily totals aggregate.
The Cloud will use 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 Cloud.
SELECT * FROM TimeCardsDailyTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
EntryDate | Date | ||
PayCodeCodeValue | String | ||
PayCodeShortName | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
periodCodeValue | String | Supported values: current, next, previous, etc. | |
TimePeriodStartDate | String |
View the worker Time Cards period totals aggregate.
The Cloud will use 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 Cloud.
SELECT * FROM TimeCardsPeriodTotals WHERE AssociateOID = 'G3349PZGBADQY8H7'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String | ||
TimeCardID | String | ||
payCodecodeValue | String | ||
payCodeshortName | String | ||
RateBaseMultiplierValue | String | ||
RateAmountValue | Double | ||
RateCurrencyCode | String | ||
TimeDuration | String |
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description | |
periodCodeValue | String | Supported values: current, next, previous, etc. | |
TimePeriodStartDate | String |
Returns wage law coverage code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String |
Work assignment CustomGroup amount.
Name | Type | References | Description |
AmountValue | Integer | ||
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CurrencyCode | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup code.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CodeValue | String | ||
ItemID | String | ||
LongName | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
ShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup date.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
DateValue | Date | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup date time.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
DateTimeValue | Datetime | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup indicator.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
IndicatorValue | Boolean | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup links.
Name | Type | References | Description |
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup number.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NumberValue | Integer | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup percent.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
PercentValue | Integer | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup string.
Name | Type | References | Description |
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
StringValue | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment CustomGroup telephone.
Name | Type | References | Description |
Access | String | ||
AreaDialing | String | ||
CategoryCodeCodeValue | String | ||
CategoryCodeLongName | String | ||
CategoryCodeShortName | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment history.
Name | Type | References | Description |
PrimaryIndicator | Boolean | ||
OfferExtensionDate | Date | ||
OfferAcceptanceDate | Date | ||
HireDate | Date | ||
SeniorityDate | Date | ||
ExpectedStartDate | Date | ||
ActualStartDate | Date | ||
TerminationDate | Date | ||
AssignmentStatusCode | String | ||
AssignmentStatusCodeValue | String | ||
AssignmentStatusLongName | String | ||
AssignmentStatusreasonCodeValue | String | ||
AssignmentStatusreasonCodeShortName | String | ||
AssignmentStatusreasonCodeLongName | String | ||
AssignmentStatusEffectiveDate | Date | ||
WorkerTypeCodeValue | String | ||
WorkerTypeShortName | String | ||
WorkerTypeLongName | String | ||
AssignmentTermCodeValue | String | ||
AssignmentTermCodeShortName | String | ||
AssignmentTermCodeLongName | String | ||
WorkLevelCodeValue | String | ||
WorkLevelCodeShortName | String | ||
WorkLevelCodeLongName | String | ||
NationalityContextCodeValue | String | ||
NationalityContextCodeShortName | String | ||
NationalityContextCodeLongName | String | ||
VipIndicator | Boolean | ||
VipTypeCodeValue | String | ||
VipTypeCodeShortName | String | ||
VipTypeCodeLongName | String | ||
ExecutiveIndicator | Boolean | ||
ExecutiveTypeCodeValue | String | ||
ExecutiveTypeCodeShortName | String | ||
ExecutiveTypeCodeLongName | String | ||
OfficerIndicator | Boolean | ||
OfficerTypeCodeValue | String | ||
OfficerTypeCodeShortName | String | ||
OfficerTypeCodeLongName | String | ||
ManagementPositionIndicator | Boolean | ||
LegalEntityID | String | ||
HighlyCompensatedIndicator | Boolean | ||
HighlyCompensatedTypeCodeValue | String | ||
HighlyCompensatedTypeCodeShortName | String | ||
HighlyCompensatedTypeCodeLongName | String | ||
StockOwnerIndicator | Boolean | ||
StockOwnerPercentage | Double | ||
JobCodeValue | String | ||
JobCodeShortName | String | ||
JobCodeLongName | String | ||
JobTitle | String | ||
WageLawCoverageCodeValue | String | ||
WageLawCoverageCodeShortName | String | ||
WageLawCoverageCodeLongName | String | ||
WageLawCoverageLawNameCodeValue | String | ||
WageLawCoverageLawNameCodeShortName | String | ||
WageLawCoverageLawNameCodeLongName | String | ||
PositionID | String | ||
PositionTitle | String | ||
LaborUnionCodeValue | String | ||
LaborUnionshortName | String | ||
LaborUnionlongName | String | ||
LaborUnionSeniorityDate | Date | ||
BargainingUnitCodeValue | String | ||
BargainingUnitshortName | String | ||
BargainingUnitlongName | String | ||
BargainingUnitSeniorityDate | Date | ||
WorkShiftCodeValue | String | ||
WorkShiftCodeshortName | String | ||
WorkShiftCodelongName | String | ||
WorkArrangementCodeValue | String | ||
WorkArrangementCodeshortName | String | ||
WorkArrangementCodelongName | String | ||
StandardHoursQuality | String | ||
StandardHoursCodeValue | Integer | ||
StandardHoursCodeshortName | String | ||
StandardHoursCodelongName | String | ||
FullTimeEquivalenceRatio | Integer | ||
HomeWorkLocationCodeValue | String | ||
HomeWorkLocationCodeshortName | String | ||
HomeWorkLocationCodelongName | String | ||
HomeWorkLocationAddressScriptCodeValue | String | ||
HomeWorkLocationAddressScriptCodeshortName | String | ||
HomeWorkLocationAddressScriptCodelongName | String | ||
HomeWorkLocationAddresslineFour | String | ||
HomeWorkLocationAddresslineFive | String | ||
HomeWorkLocationAddressbuildingNumber | String | ||
HomeWorkLocationAddressbuildingName | String | ||
HomeWorkLocationAddressblockName | String | ||
HomeWorkLocationAddressstreetName | String | ||
HomeWorkLocationAddressstreetTypeCodeValue | String | ||
HomeWorkLocationAddressstreetTypeCodeshortName | String | ||
HomeWorkLocationAddressstreetTypeCodelongName | String | ||
HomeWorkLocationAddressunit | String | ||
HomeWorkLocationAddressfloor | String | ||
HomeWorkLocationAddressstairCase | String | ||
HomeWorkLocationAddressdoor | String | ||
HomeWorkLocationAddresspostOfficeBox | String | ||
HomeWorkLocationAddressdeliveryPoint | String | ||
HomeWorkLocationAddressplotID | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2Value | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2shortName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2longName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel2subdivisionType | String | ||
HomeWorkLocationAddressnameCodeValue | String | ||
HomeWorkLocationAddressnameCodeshortName | String | ||
HomeWorkLocationAddressnameCodelongName | String | ||
HomeWorkLocationAddressattentionOfName | String | ||
HomeWorkLocationAddresscareOfName | String | ||
HomeWorkLocationAddresslineOne | String | ||
HomeWorkLocationAddresslineTwo | String | ||
HomeWorkLocationAddresslineThree | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1Value | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1shortName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1longName | String | ||
HomeWorkLocationAddresscountrySubdivisionLevel1subdivisionType | String | ||
HomeWorkLocationAddresscountryCode | String | ||
HomeWorkLocationAddresspostalCode | String | ||
HomeWorkLocationAddressgeoCoordinateLatitude | Double | ||
HomeWorkLocationAddressgeoCoordinateLongitude | Double | ||
RemunerationBasisCodeValue | String | ||
RemunerationBasisCodeshortName | String | ||
RemunerationBasisCodelongName | String | ||
PayCycleCodeValue | String | ||
PayCycleCodeshortName | String | ||
PayCycleCodelongName | String | ||
StandardPayPeriodHourshoursQuantity | Integer | ||
StandardPayPeriodHoursCodeValue | String | ||
StandardPayPeriodHoursCodeshortName | String | ||
StandardPayPeriodHoursCodelongName | String | ||
BaseRemunerationhourlyRateAmountcodeValue | String | ||
BaseRemunerationhourlyRateAmountshortName | String | ||
BaseRemunerationhourlyRateAmountlongName | String | ||
BaseRemunerationhourlyRateAmountValue | String | ||
BaseRemunerationhourlyRateAmountCurrencyCode | String | ||
BaseRemunerationdailyRateAmountcodeValue | String | ||
BaseRemunerationdailyRateAmountshortName | String | ||
BaseRemunerationdailyRateAmountlongName | String | ||
BaseRemunerationdailyRateAmountValue | String | ||
BaseRemunerationdailyRateAmountCurrencyCode | String | ||
BaseRemunerationweeklyRateAmountcodeValue | String | ||
BaseRemunerationweeklyRateAmountshortName | String | ||
BaseRemunerationweeklyRateAmountlongName | String | ||
BaseRemunerationweeklyRateAmountValue | String | ||
BaseRemunerationweeklyRateAmountCurrencyCode | String | ||
BaseRemunerationbiweeklyRateAmountcodeValue | String | ||
BaseRemunerationbiweeklyRateAmountshortName | String | ||
BaseRemunerationbiweeklyRateAmountlongName | String | ||
BaseRemunerationbiweeklyRateAmountValue | String | ||
BaseRemunerationbiweeklyRateAmountCurrencyCode | String | ||
BaseRemunerationsemiMonthlyRateAmountcodeValue | String | ||
BaseRemunerationsemiMonthlyRateAmountshortName | String | ||
BaseRemunerationsemiMonthlyRateAmountlongName | String | ||
BaseRemunerationsemiMonthlyRateAmountValue | String | ||
BaseRemunerationsemiMonthlyRateAmountCurrencyCode | String | ||
BaseRemunerationmonthlyRateAmountcodeValue | String | ||
BaseRemunerationmonthlyRateAmountshortName | String | ||
BaseRemunerationmonthlyRateAmountlongName | String | ||
BaseRemunerationmonthlyRateAmountValue | String | ||
BaseRemunerationmonthlyRateAmountCurrencyCode | String | ||
BaseRemunerationannualRateAmountcodeValue | String | ||
BaseRemunerationannualRateAmountshortName | String | ||
BaseRemunerationannualRateAmountlongName | String | ||
BaseRemunerationannualRateAmountValue | String | ||
BaseRemunerationannualRateAmountCurrencyCode | String | ||
BaseRemunerationpayPeriodRateAmountcodeValue | String | ||
BaseRemunerationpayPeriodRateAmountshortName | String | ||
BaseRemunerationpayPeriodRateAmountlongName | String | ||
BaseRemunerationpayPeriodRateAmountValue | String | ||
BaseRemunerationpayPeriodRateAmountCurrencyCode | String | ||
BaseRemunerationcommissionRatePercentagecodeValue | String | ||
BaseRemunerationcommissionRatePercentageshortName | String | ||
BaseRemunerationcommissionRatePercentagelongName | String | ||
BaseRemunerationcommissionRatePercentageValue | String | ||
BaseRemunerationcommissionRatePercentagebaseUnitCodeValue | String | ||
BaseRemunerationcommissionRatePercentageCurrencyCodeshortName | String | ||
BaseRemunerationcommissionRatePercentageCurrencyCodelongName | String | ||
BaseRemunerationeffectiveDate | Date | ||
PayrollProcessingStatusCodecodeValue | String | ||
PayrollProcessingStatusCodeshortName | String | ||
PayrollProcessingStatusCodelongName | String | ||
PayrollProcessingStatusCodeEffectiveDate | Date | ||
PayrollGroupCode | String | ||
PayrollFileNumber | String | ||
PayrollRegionCode | String | ||
PayScaleCodecodeValue | String | ||
PayScaleCodeshortName | String | ||
PayScaleCodelongName | String | ||
PayGradeCodecodeValue | String | ||
PayGradeCodeshortName | String | ||
PayGradeCodelongName | String | ||
PayGradePayRangeminimumRateamountValue | String | ||
PayGradePayRangeminimumRatecurrencyCode | String | ||
PayGradePayRangeminimumRateUnitCodeValue | String | ||
PayGradePayRangeminimumRateUnitshortName | String | ||
PayGradePayRangeminimumRateUnitlongName | String | ||
PayGradePayRangeminimumRateBaseUnitCodeValue | String | ||
PayGradePayRangeminimumRateBaseUnitshortName | String | ||
PayGradePayRangeminimumRateBaseUnitlongName | String | ||
PayGradePayRangeminimumRatebaseMultiplierValue | Integer | ||
PayGradePayRangemedianRateamountValue | String | ||
PayGradePayRangemedianRatecurrencyCode | String | ||
PayGradePayRangemedianRateUnitCodeValue | String | ||
PayGradePayRangemedianRateUnitshortName | String | ||
PayGradePayRangemedianRateBaseUnitCodeValue | String | ||
PayGradePayRangemedianRateBaseUnitshortName | String | ||
PayGradePayRangemedianRateBaseUnitlongName | String | ||
PayGradePayRangemedianRatebaseMultiplierValue | Integer | ||
PayGradePayRangemaximumRateamountValue | String | ||
PayGradePayRangemaximumRatecurrencyCode | String | ||
PayGradePayRangemaximumRateUnitCodeValue | String | ||
PayGradePayRangemaximumRateUnitshortName | String | ||
PayGradePayRangemaximumRateUnitlongName | String | ||
PayGradePayRangemaximumRateBaseUnitCodeValue | String | ||
PayGradePayRangemaximumRateBaseUnitshortName | String | ||
PayGradePayRangemaximumRateBaseUnitlongName | String | ||
PayGradePayRangemaximumRatebaseMultiplierValue | Integer | ||
CompaRatio | Double | ||
PayGradeStepCodeValue | String | ||
PayGradeStepshortName | String | ||
PayGradeSteplongName | String | ||
PayGradeStepPayRateamountValue | String | ||
PayGradeStepPayRatecurrencyCode | String | ||
PayGradeStepPayRateUnitCodeValue | String | ||
PayGradeStepPayRateUnitshortName | String | ||
PayGradeStepPayRateUnitlongName | String | ||
PayGradeStepPayRateBaseUnitCodeValue | String | ||
PayGradeStepPayRateBaseUnitshortName | String | ||
PayGradeStepPayRateBaseUnitlongName | String | ||
PayGradeStepPayRatebaseMultiplierValue | Integer | ||
NextPayGradeStepDate | Date | ||
MinimumPayGradeStepDuration | String | ||
GeographicPayDifferentialCodeValue | String | ||
GeographicPayDifferentialshortName | String | ||
GeographicPayDifferentiallongName | String | ||
GeographicPayDifferentialPercentage | Double | ||
ItemID | String | ||
EffectiveDate | Date | ||
FromDate | Date | ||
ThruDate | Date | ||
HistoryEventID | String | ||
HistoryEventNameCodeValue | String | ||
HistoryEventNameshortName | String | ||
HistoryEventNamelongName | String | ||
HistoryReasonCodeValue | String | ||
HistoryReasonshortName | String | ||
HistoryReasonlongName | String | ||
HistoryEventActorId | String | ||
HistoryEventActorCodeValue | String | ||
HistoryEventActorshortName | String | ||
HistoryEventActorlongName | String | ||
HistoryEventActorassociateOID | String | ||
HistoryEventActorpersonOID | String | ||
HistoryEventActorformattedName | String | ||
HistoryEventActordeviceID | String | ||
HistoryEventActorlatitude | Double | ||
HistoryEventActorlongitude | Double | ||
HistoryEventActordeviceUserAgentID | String | ||
WorkAssignmentID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment additionsla remunerations history.
Name | Type | References | Description |
TypeCodeValue | String | ||
TypeCodeCodeshortName | String | ||
TypeCodeCodelongName | String | ||
IntervalCodeCodeValue | String | ||
IntervalCodeCodeCodeshortName | String | ||
IntervalCodeCodeCodelongName | String | ||
NameCodeCodeValue | String | ||
NameCodeCodeCodeshortName | String | ||
NameCodeCodeCodelongName | String | ||
RateAmountValue | Integer | ||
RateCurrencyCode | String | ||
RateUnitCode | String | ||
RateshortName | String | ||
RateLongName | String | ||
RateBaseUnitCode | String | ||
RateBaseshortName | String | ||
RateBaseLongName | String | ||
BaseMultiplierValue | Integer | ||
ItemID | String | ||
EffectiveDate | Date | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment organization units history.
Name | Type | References | Description |
NameCodeValue | String | ||
NameCodeshortName | String | ||
NameCodelongName | String | ||
TypeCodeValue | String | ||
TypeCodeshortName | String | ||
TypeCodelongName | String | ||
itemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment Assigned locations history.
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
AddressScriptCode | String | ||
AddressShortName | String | ||
AddressLongName | String | ||
AddressLineFour | String | ||
AddressLineFive | String | ||
AddressBuildingNumber | String | ||
AddressBuildingName | String | ||
AddressBlockName | String | ||
AddressStreetName | String | ||
AddressStreetTypeCode | String | ||
AddressStreetTypeShortName | String | ||
AddressStreetTypeLongName | String | ||
AddressUnit | Integer | ||
AddressFloor | String | ||
AddressStairCase | String | ||
AddressDoor | String | ||
AddressPostOfficeBox | String | ||
AddressDeliveryPoint | String | ||
AddressPlotID | String | ||
AddressCountrySubdivisionLevel2 | String | ||
AddressCountrySubdivisionLevel2ShortName | String | ||
AddressCountrySubdivisionLevel2LongName | String | ||
AddressCountrySubdivisionLevel2Type | String | ||
AddressCountrySubdivisionLevel1 | String | ||
AddressCountrySubdivisionShortName | String | ||
AddressCountrySubdivisionLongName | String | ||
AddressCountrySubdivisionType | String | ||
AddressNameCode | String | ||
AddressNameShortName | String | ||
AddressNameLongName | String | ||
AddressAttentionOfName | String | ||
AddressCareOfName | String | ||
AddressLineOne | String | ||
AddressLineTwo | String | ||
AddressLineThree | String | ||
AddressCityName | String | ||
AddressCountryCode | String | ||
AddressPostalCode | String | ||
AddressLatitude | Double | ||
AddressLongitude | Double | ||
NameCode | String | ||
NameShortName | String | ||
NameLongName | String |
Work assignment communication history mail.
Name | Type | References | Description |
EmailUri | String | ||
ItemID | String | ||
NameCodeCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Fax History.
Name | Type | References | Description |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication message History.
Name | Type | References | Description |
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Internet address History.
Name | Type | References | Description |
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication landline history.
Name | Type | References | Description |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication mobile History.
Name | Type | References | Description |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication Pager History.
Name | Type | References | Description |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment communication social network history.
Name | Type | References | Description |
ItemID | String | ||
NameCode.codeValue | String | ||
NameCode.longName | String | ||
NameCode.shortName | String | ||
Uri | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment Home organization history.
Name | Type | References | Description |
NameCodeValue | String | ||
NameCodeshortName | String | ||
NameCodelongName | String | ||
TypeCodeValue | String | ||
TypeCodeshortName | String | ||
TypeCodelongName | String | ||
itemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment industry classification history.
Name | Type | References | Description |
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
classificationCodeValue | String | ||
classificationCodeshortName | String | ||
classificationCodelongName | String | ||
itemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment occupational classification history.
Name | Type | References | Description |
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
classificationCodeValue | String | ||
classificationCodeshortName | String | ||
classificationCodelongName | String | ||
itemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Work assignment Report.
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerIDValue | String |
Workers.WorkerID | |
WorkerIDschemeCode | String | ||
WorkerIDShortName | String | ||
WorkerIDLongName | String | ||
WorkerGivenName | String | ||
WorkerMiddleName | String | ||
WorkerFamilyName1 | String | ||
WorkerFamilyName2 | String | ||
WorkerFormattedName | String | ||
RelationshipCode | String | ||
RelationshipShortName | String | ||
RelationshipLongName | String | ||
PositionID | String | ||
PositionTitle | String | ||
ItemID | String |
Work assignment group history.
Name | Type | References | Description |
nameCodeValue | String | ||
nameCodeshortName | String | ||
nameCodelongName | String | ||
GroupCodeValue | String | ||
GroupCodeshortName | String | ||
GroupCodelongName | String | ||
itemID | String | ||
AssociateOID | String |
Workers.AssociateOID |
Returns a list of demographics for each worker in the organization.
The Cloud uses the ADP API to process WHERE clause conditions built with the AssociateOID column and '=' operator.
For example, the following queries are processed server-side:
SELECT * FROM WorkerDemographics WHERE AssociateOID = 'G3349PZGBADQY8H7'The rest of the filter is executed client-side within the Cloud.
Name | Type | References | Description |
AssociateOID [KEY] | String |
Workers.AssociateOID | Associate OID of Worker Demographics |
WorkerID | String |
Workers.WorkerID | WorkerID of Worker Demographicsof Worker Demographics |
GivenName | String | GivenName of Worker Demographics | |
FamilyName | String | FamilyName of Worker Demographics | |
AddressCode | String | AddressCode of Worker Demographics | |
AddressShortName | String | AddressShortName of Worker Demographics | |
AddressLineOne | String | AddressLineOne of Worker Demographics | |
CityName | String | CityName of Worker Demographics | |
CountrySubdivisionLevelCode | String | CountrySubdivisionLevelCode of Worker Demographics | |
CountrySubdivisionType | String | CountrySubdivisionType of Worker Demographics | |
CountrySubdivisionShortName | String | CountrySubdivisionShortName of Worker Demographics | |
AddressCountryCode | String | AddressCountryCode of Worker Demographics | |
AddressPostalCode | String | AddressPostalCode of Worker Demographics | |
CommunicationLandlines | String | CommunicationLandlines of Worker Demographics | |
CommunicationMobiles | String | CommunicationMobiles of Worker Demographics | |
CommunicationFaxes | String | CommunicationFaxes of Worker Demographics | |
CommunicationPagers | String | CommunicationPagers of Worker Demographics | |
CommunicationEmails | String | CommunicationEmails of Worker Demographics | |
GenderCode | String | GenderCode of Worker Demographics | |
GenderCodeShortName | String | GenderCodeShortName of Worker Demographics | |
MaritalStatusCode | String | MaritalStatusCode of Worker Demographics | |
MaritalStatusShortName | String | MaritalStatusShortName of Worker Demographics | |
DisabledIndicatior | Boolean | DisabledIndicatior of Worker Demographics | |
BirthName | String | BirthName of Worker Demographics | |
OtherPersonalAddresses | String | OtherPersonalAddresses of Worker Demographics | |
RaceCodeIdentificationMethodCode | String | RaceCodeIdentificationMethodCode of Worker Demographics | |
RaceCodeIdentificationMethodShortName | String | RaceCodeIdentificationMethodShortName of Worker Demographics | |
RaceCodeShortName | String | RaceCodeShortName of Worker Demographics | |
RaceCode | String | RaceCode of Worker Demographics | |
HireDate | Date | HireDate of Worker Demographics | |
WorkerStatusCode | String | WorkerStatusCode of Worker Demographics | |
BusinessCommunicationLandlines | String | BusinessCommunicationLandlines of Worker Demographics | |
BusinessCommunicationMobiles | String | BusinessCommunicationMobiles of Worker Demographics | |
BusinessCommunicationFaxes | String | BusinessCommunicationFaxes of Worker Demographics | |
BusinessCommunicationEmails | String | BusinessCommunicationEmails of Worker Demographics | |
BusinessCommunicationPagers | String | BusinessCommunicationPagers of Worker Demographics | |
WorkAssignments | String | WorkAssignments of Worker Demographics |
Returns workers business communication emails.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationEmails WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers business communication faxes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers business communication landlines.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers business communication mobiles.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers business communication pagers.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersBusinessCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersBusinessCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersBusinessCommunicationPagers WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers person birth name preferred salutations.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
SalutationCode | String | ||
SalutationLongName | String | ||
SalutationShortName | String | ||
SequenceNumber | Integer | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
Returns workers person birth name title affix codes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
Returns workers person birth name title prefix codes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonBirthNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
PrefixCode | String | ||
PrefixCodeLongName | String | ||
PrefixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
Returns workers person government IDs.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonGovernmentIDs WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonGovernmentIDs WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonGovernmentIDs WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
CountryCode | String | ||
ExpirationDate | Date | ||
IdValue | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
StatusCode | String | ||
StatusCodeEffectiveDate | Date | ||
StatusCodeLongName | String | ||
StatusCodeShortName | String | ||
AsOfDate | Date |
Returns workers person legal name preferred salutations.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNamePreferredSalutations WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
SalutationCode | String | ||
SalutationCodeLongName | String | ||
SalutationCodeShortName | String | ||
SequenceNumber | Integer | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
Returns workers person legal name title affix codes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNameTitleAffixCodes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
Returns workers person legal name title prefix codes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonLegalNameTitlePrefixCodes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
AffixCode | String | ||
AffixCodeLongName | String | ||
AffixCodeShortName | String | ||
SequenceNumber | Integer | ||
AsOfDate | Date |
Returns workers person military classification codes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPersonMilitaryClassificationCodes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
CodeValue | String | ||
LongName | String | ||
ShortName | String | ||
AsOfDate | Date |
Returns workers photo links.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotoLinks WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPhotoLinks WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPhotoLinks WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
CanonicalUri | String | ||
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AsOfDate | Date |
Returns workers photos.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersPhotos WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersPhotos WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersPhotos WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
ItemID | String | ||
Links | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignment ReportsTo.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentReportsTo WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentReportsTo WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
WorkAssignmentsAssociateOID | String | ||
WorkAssignmentsWorkerID | String | ||
ItemID | String | ||
PositionID | String | ||
PositionTitle | String | ||
ReportsToRelationshipCode | String | ||
ReportsToRelationshipCodeLongName | String | ||
ReportsToRelationshipCodeShortName | String | ||
ReportsToWorkerNameFamilyName1 | String | ||
ReportsToWorkerNameFamilyName2 | String | ||
ReportsToWorkerNameFormattedName | String | ||
ReportsToWorkerNameGivenName | String | ||
ReportsToWorkerNameMiddleName | String | ||
WorkerIDSchemeCode | String | ||
WorkerIDSchemeCodeLongName | String | ||
WorkerIDSchemeCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignments assigned organizational units.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedOrganizationalUnits WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
TypeCode | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocations WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
AddressAttentionOfName | String | ||
AddressBlockName | String | ||
AddressBuildingName | String | ||
AddressBuildingNumber | String | ||
AddressCareOfName | String | ||
AddressCityName | String | ||
AddressCountryCode | String | ||
AddressCountrySubdivisionLevel1CodeValue | String | ||
AddressCountrySubdivisionLevel1LongName | String | ||
AddressCountrySubdivisionLevel1ShortName | String | ||
AddressCountrySubdivisionLevel1SubdivisionType | String | ||
AddressCountrySubdivisionLevel2CodeValue | String | ||
AddressCountrySubdivisionLevel2LongName | String | ||
AddressCountrySubdivisionLevel2ShortName | String | ||
AddressCountrySubdivisionLevel2SubdivisionType | String | ||
AddressDeliveryPoint | String | ||
AddressDoor | String | ||
AddressFloor | String | ||
AddressGeoCoordinateLatitude | Integer | ||
AddressGeoCoordinateLongitude | Integer | ||
AddressLineFive | String | ||
AddressLineFour | String | ||
AddressLineOne | String | ||
AddressLineThree | String | ||
AddressLineTwo | String | ||
AddressNameCode | String | ||
AddressNameCodeLongName | String | ||
AddressNameCodeShortName | String | ||
AddressPlotID | String | ||
AddressPostalCode | String | ||
AddressPostOfficeBox | String | ||
AddressScriptCodeValue | String | ||
AddressScriptCodeLongName | String | ||
AddressScriptCodeShortName | String | ||
AddressStairCase | String | ||
AddressStreetName | String | ||
AddressStreetTypeCode | String | ||
AddressStreetTypeCodeLongName | String | ||
AddressStreetTypeCodeShortName | String | ||
addressUnit | String | ||
CommunicationEmails | String | ||
CommunicationFaxes | String | ||
CommunicationLandlines | String | ||
CommunicationMobiles | String | ||
CommunicationPagers | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations communication emails.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationEmails WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations communication faxes.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationFaxes WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations communication landlines.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations communication mobiles.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments assigned work locations communication pagers.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsAssignedWorkLocationsCommunicationPagers WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments home organizational units.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeOrganizationalUnits WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
ItemID | String | ||
NameCodeValue | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
TypeCodeValue | String | ||
TypeCodeLongName | String | ||
TypeCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignments home work location communication emails.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationEmails WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
EmailUri | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments home work location communication instant messages.
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments home work location communication landlines.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationLandlines WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments home work location communication mobiles.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationMobiles WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments home work location communication pagers.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsHomeWorkLocationCommunicationPagers WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
Access | String | ||
AreaDialing | String | ||
CountryDialing | String | ||
DialNumber | String | ||
Extension | String | ||
FormattedNumber | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
NotificationIndicator | Boolean | ||
AsOfDate | Date |
Returns workers work assignments industry classifications.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsIndustryClassifications WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
ClassificationCode | String | ||
ClassificationCodeLongName | String | ||
ClassificationCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
Returns workers work assignments links.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsLinks WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsLinks WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsLinks WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
CanonicalUri | String | ||
EncType | String | ||
Href | String | ||
MediaType | String | ||
Method | String | ||
PayLoadArguments | String | ||
Rel | String | ||
Schema | String | ||
TargetSchema | String | ||
Title | String | ||
AsOfDate | Date |
Returns workers work assignments occupational classifications.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsOccupationalClassifications WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
ClassificationCode | String | ||
ClassificationCodeLongName | String | ||
ClassificationCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
Work assignments worker groups.
The Cloud will use the ADP API to process WHERE clause conditions built with the following column and operator. The rest of the filter is executed client side within the Cloud.
For example, the following queries are processed server side:
SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AssociateOID = 'G3349PZGBADQY8H7' SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE WorkerID = 'DRH9M9NPW' SELECT * FROM WorkersWorkAssignmentsWorkerGroups WHERE AsOfDate = '2020-01-01'
Name | Type | References | Description |
AssociateOID | String |
Workers.AssociateOID | |
WorkerID | String |
Workers.WorkerID | |
GroupCode | String | ||
GroupCodeLongName | String | ||
GroupCodeShortName | String | ||
ItemID | String | ||
NameCode | String | ||
NameCodeLongName | String | ||
NameCodeShortName | String | ||
AsOfDate | Date |
Returns work assignement worker type code.
Name | Type | References | Description |
CodeValue | String | ||
ShortName | String |
View the Work Schedules.
Name | Type | References | Description |
AssociateOID | String | ||
ScheduleID | String | ||
WorkerName | String | ||
WorkerFamilyName1 | String | ||
WorkerFormattedName | String | ||
workAssignmentID | String | ||
schedulePeriodStartDate | Date | ||
schedulePeriodEndDate | Date | ||
scheduleDays | String |
View the schedule days entries in Work Schedules.
Name | Type | References | Description |
AssociateOID | String | ||
ScheduleID | String | ||
WorkerFormattedName | String | ||
workAssignmentID | String | ||
ScheduleEntryID | String | ||
DaySequenceNumber | String | ||
ScheduleDayDate | Date | ||
Actions | String | ||
categoryTypeCode | String | ||
ShiftTypeCode | String | ||
EarningAllocations | String | ||
EntryComments | String | ||
PayCodeValue | String | ||
PayCodeShortName | String | ||
EntryStatusCode | String | ||
StateDateTimePeriod | Datetime | ||
EndDateTimePeriod | Datetime | ||
StartDatePeriod | Date | ||
EndDatePeriod | Date | ||
TotalTimeValue | String | ||
TotalTimeNameCode | String | ||
TotalTimeNameCodeShortName | String | ||
ScheduledHoursQuantity | String |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with ADP.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from ADP, along with an indication of whether the procedure succeeded or failed.
Name | Description |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for ADP:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Name | Type | Description |
CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Name | Type | Description |
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Name | Type | Description |
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Workers table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Workers'
Name | Type | Description |
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
IsReadOnly | Boolean | Whether the column is read-only. |
IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
Name | Type | Description |
CatalogName | String | The database containing the stored procedure. |
SchemaName | String | The schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure. |
Description | String | A description of the stored procedure. |
ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName='SelectEntries' AND Direction=1 OR Direction=2
Name | Type | Description |
CatalogName | String | The name of the database containing the stored procedure. |
SchemaName | String | The name of the schema containing the stored procedure. |
ProcedureName | String | The name of the stored procedure containing the parameter. |
ColumnName | String | The name of the stored procedure parameter. |
Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
DataTypeName | String | The name of the data type. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
IsNullable | Boolean | Whether the parameter can contain null. |
IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
IsArray | Boolean | Whether the parameter is an array. |
Description | String | The description of the parameter. |
Ordinal | Int32 | The index of the parameter. |
Describes the primary and foreign keys.
The following query retrieves the primary key for the Workers table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Workers'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
Name | Type | Description |
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
KeySeq | String | The sequence number of the primary key. |
KeyName | String | The name of the primary key. |
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Name | Type | Description |
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:adp:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Name | Type | Description |
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG, COUNT, MAX, MIN, SUM, DISTINCT |
COUNT | Whether COUNT function is supported. | YES, NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE |
OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
OUTER_JOINS | Whether outer joins are supported. | YES, NO |
SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
STRING_FUNCTIONS | Supported string functions. | LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES, NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES, NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES, NO |
DATASYNCVERSION | The CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
DATASYNCCATEGORY | The CData Data Sync category of this driver. | Source, Destination, Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE, FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES, NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES, NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE, FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE, FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Name | Type | Description |
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Name | Type | Description |
Id | String | The database-generated Id returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
Property | Description |
UseUAT | Whether the connection should be made to an ADP UAT account. |
MaskSensitiveData | To mask the sensitive data in the resultset. |
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
Property | Description |
SSLClientCert | The certificate provided by ADP during Registration. |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Property | Description |
RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
Property | Description |
UseUAT | Whether the connection should be made to an ADP UAT account. |
MaskSensitiveData | To mask the sensitive data in the resultset. |
Whether the connection should be made to an ADP UAT account.
bool
false
To connect to a ADP UAT account, set UseUAT = true.
To mask the sensitive data in the resultset.
bool
true
To mask the sensitive data in the resultset.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
Property | Description |
OAuthClientId | The client Id assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
The client Id assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
The client secret assigned when you register your application with an OAuth authorization server.
string
""
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
Property | Description |
SSLClientCert | The certificate provided by ADP during Registration. |
SSLClientCertType | The type of key store containing the TLS/SSL client certificate. |
SSLClientCertPassword | The password for the TLS/SSL client certificate. |
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
The certificate provided by ADP during Registration.
string
""
The certificate provided by ADP during Registration. The Cloud requires a PXF or PFXBLOB type.
The type of key store containing the TLS/SSL client certificate.
string
"USER"
This property can take one of the following values:
USER - default | For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note that this store type is not available in Java. |
MACHINE | For Windows, this specifies that the certificate store is a machine store. Note that this store type is not available in Java. |
PFXFILE | The certificate store is the name of a PFX (PKCS12) file containing certificates. |
PFXBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format. |
JKSFILE | The certificate store is the name of a Java key store (JKS) file containing certificates. Note that this store type is only available in Java. |
JKSBLOB | The certificate store is a string (base-64-encoded) representing a certificate store in JKS format. Note that this store type is only available in Java. |
PEMKEY_FILE | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
PEMKEY_BLOB | The certificate store is a string (base64-encoded) that contains a private key and an optional certificate. |
PUBLIC_KEY_FILE | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
PUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate. |
SSHPUBLIC_KEY_FILE | The certificate store is the name of a file that contains an SSH-style public key. |
SSHPUBLIC_KEY_BLOB | The certificate store is a string (base-64-encoded) that contains an SSH-style public key. |
P7BFILE | The certificate store is the name of a PKCS7 file containing certificates. |
PPKFILE | The certificate store is the name of a file that contains a PuTTY Private Key (PPK). |
XMLFILE | The certificate store is the name of a file that contains a certificate in XML format. |
XMLBLOB | The certificate store is a string that contains a certificate in XML format. |
The password for the TLS/SSL client certificate.
string
""
If the certificate store is of a type that requires a password, this property is used to specify that password to open the certificate store.
The certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
Verbosity | The verbosity level that determines the amount of detail included in the log file. |
The verbosity level that determines the amount of detail included in the log file.
string
"1"
The verbosity level determines the amount of detail that the Cloud reports to the Logfile. Verbosity levels from 1 to 5 are supported. These are detailed in the Logging page.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
string
""
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
Property | Description |
RowScanDepth | The maximum number of rows to scan for the custom fields columns available in the table. |
IncludeCustomFields | A boolean indicating if you would like to include custom fields in the column listing. |
MaxRows | Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UsePayrollEndpoint | Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API. |
The maximum number of rows to scan for the custom fields columns available in the table.
string
"100"
Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly.
A boolean indicating if you would like to include custom fields in the column listing.
bool
true
Setting this to true will cause custom fields to be included in the column listing, but may cause poor performance when listing metadata.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
int
-1
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
This property indicates whether or not to include pseudo columns as columns to the table.
string
""
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
The value in seconds until the timeout error is thrown, canceling the operation.
int
60
If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout expires and the operation is not yet complete, the Cloud throws an exception.
Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API.
bool
false
Set this to true may affect the performance of above views.