The CData Sync App provides a straightforward way to continuously pipeline your ADP data to any database, data lake, or data warehouse, making it easily available for Analytics, Reporting, AI, and Machine Learning.
The ADP connector can be used from the CData Sync application to pull data from ADP and move it to any of the supported destinations.
The Sync App leverages the following ADP APIs to enable access to ADP Workforce Now data:
For required properties, see the Settings tab.
For connection properties that are not typically required, see the Advanced tab.
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.
This section details a selection of advanced features of the ADP Sync App.
The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.
Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.
Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.
The Sync App offloads as much of the SELECT statement processing as possible to ADP and then processes the rest of the query in memory (client-side).
See Query Processing for more information.
See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.
By default, the Sync App 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 Sync App 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 Sync App models the data exposed by the ADP APIs as relational Tables.
Views describes the available read-only views.
The Sync App 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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App.
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 Sync App.
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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 Sync App 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 Sync App.
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 |
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 |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
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. |
Other | These hidden properties are used only in specific use cases. |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
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.
To connect to a ADP UAT account, set UseUAT = true.
To mask the sensitive data in the resultset.
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.
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.
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.
The certificate provided by ADP during Registration. The Sync App requires a PXF or PFXBLOB type.
The type of key store containing the TLS/SSL client certificate.
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.
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.
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 Firewall properties you can configure in the connection string for this provider.
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
The protocol used by a proxy-based firewall.
This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.
Type | Default Port | Description |
TUNNEL | 80 | When this is set, the Sync App opens a connection to ADP and traffic flows back and forth through the proxy. |
SOCKS4 | 1080 | When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted. |
SOCKS5 | 1080 | When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes. |
To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.
The name or IP address of a proxy-based firewall.
This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.
Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.
The TCP port for a proxy-based firewall.
This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.
The user name to use to authenticate with a proxy-based firewall.
The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.
A password used to authenticate to a proxy-based firewall.
This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.
This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.
Property | Description |
ProxyAutoDetect | This indicates whether to use the system proxy settings or not. |
ProxyServer | The hostname or IP address of a proxy to route HTTP traffic through. |
ProxyPort | The TCP port the ProxyServer proxy is running on. |
ProxyAuthScheme | The authentication type to use to authenticate to the ProxyServer proxy. |
ProxyUser | A user name to be used to authenticate to the ProxyServer proxy. |
ProxyPassword | A password to be used to authenticate to the ProxyServer proxy. |
ProxySSLType | The SSL type to use when connecting to the ProxyServer proxy. |
ProxyExceptions | A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer . |
This indicates whether to use the system proxy settings or not.
This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.
The hostname or IP address of a proxy to route HTTP traffic through.
The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.
If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.
By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.
The TCP port the ProxyServer proxy is running on.
The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.
The authentication type to use to authenticate to the ProxyServer proxy.
This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.
Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
The authentication type can be one of the following:
If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.
A user name to be used to authenticate to the ProxyServer proxy.
The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.
You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:
user@domain domain\user
A password to be used to authenticate to the ProxyServer proxy.
This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.
If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.
If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.
For SOCKS 5 authentication or tunneling, see FirewallType.
By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.
The SSL type to use when connecting to the ProxyServer proxy.
This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:
AUTO | Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option. |
ALWAYS | The connection is always SSL enabled. |
NEVER | The connection is not SSL enabled. |
TUNNEL | The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy. |
A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.
Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
Property | Description |
LogModules | Core modules to be included in the log file. |
Core modules to be included in the log file.
Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.
See the Logging page for an overview.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC. |
A path to the directory that contains the schema files defining tables, views, and stored procedures.
The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
If left unspecified, the default location is "%APPDATA%\\CData\\ADP Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:
Platform | %APPDATA% |
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
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. |
Other | These hidden properties are used only in specific use cases. |
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. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
The maximum number of rows to scan for the custom fields columns available in the table.
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.
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.
Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
These hidden properties are used only in specific use cases.
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
This property indicates whether or not to include pseudo columns as columns to the table.
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.
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 Sync App throws an exception.
Set this to true to retreive results for AssociatePaymentsAllocationsEarningSections, AssociatePaymentsAllocationsStatutoryDeductions, AssociatePaymentsAllocationsNonStatutoryDeductions, AssociatePaymentsSummaryEarningsSections, AssociatePaymentsSummaryStatutoryDeductions, AssociatePaymentsSummaryPayrollAccumulations views using Payroll API.
Set this to true may affect the performance of above views.
A filepath pointing to the JSON configuration file containing your custom views.
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.
This User Defined View configuration file is formatted as follows:
For example:
{ "MyView": { "query": "SELECT * FROM Workers WHERE MyColumn = 'value'" }, "MyView2": { "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)" } }Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.jsonNote that the specified path is not embedded in quotation marks.