Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field #

Field

Type

Description

Required

Comments

1

FullName

String

Full Name

Yes

Min Length: 2

Max Length: 50

2

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

3

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

4

City

String

City 

Yes

Min Length: 2

Max Length: 20

5

State

String

State

Yes

The state's two letter abbreviation (i.e., AZ)

6

PostalCode

String

Postal Code 

Yes

Length = 5 numerals

7

CountryCode

String

3 Letter Country Code

Yes

Should be USA

8

FundingSourceType

Int

Type of Funding Source (1, 2, 3)

Yes

See “Admin Guide: Static Data Reference File for Imports” in the Help Center

9

Phone

String

Phone Number

Yes

10-digit phone number; exclude dashes and parentheses

10

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

11

ProviderId

String

Provider Id for Funding Source

Optional

Must use existing Id in DCI

12

Email

String

Email Address 

Yes

Email format: test@dcisoftware.com

13

TimeZone

String

Time Zone

Yes

See “Admin Guide: Static Data Reference File for Imports” in the Help Center

14

CostCenterId

Integer

Unique Cost Center Id

Yes

Use existing Id in DCI

15

SleepShiftStart

Time

Sleep shift Start Time

Optional

Format: hh:mm

16

SleepShiftEnd

Time

Sleep shift End Time

Optional

Format: hh:mm

17

ProfileReference

String

Third-party reference number for the Profile

Optional

Min Length: 1

Max Length: 200

18

EnableEDI

Bit

EDI is enabled or not

Yes

Enumeration:

●       0 - No

●       1 - Yes

*This column is contingent on the instance-level setting.

19

EnableEDITransmission

Bit

EDI Transmission is enabled or not

Conditional -

If (EnableEDI = Yes), the EnableEDITransmission is mandatory field, otherwise the field can be left blank

Enumeration:

●       0 - No

●       1 - Yes

*This column is contingent on the instance-level setting.

20

EDISenderID

Integer

EDI Sender ID

Conditional -

 If (EnableEDI = Yes), the EDISenderID is mandatory field, otherwise the field can be left blank

Min Length: 1

Max Length: 200

*This column is contingent on the instance-level setting.

21

EDIReceiverID

Integer

EDI Receiver ID

Conditional -

If (EnableEDI = Yes), the EDIReceiverID is mandatory field, otherwise the field can be left blank

Unique Id of the Receiver

*This column is contingent on the instance-level setting.

22

ExcludeFromAutoApproval

Bit

The field will define whether the Funding source entries be excluded from the Auto Approval scheduler

Yes

Enumeration:

●       0 - No

●       1 - Yes

23

AllowOfflineMobileApp

Bit

This field will define whether an employee is allowed to use the application in offline mode or not.

Yes

Enumeration:

●       0 - No

●       1 - Yes

24

RequireReasonCodeForManualEntries

Bit

The field will define whether the Reason Code will be required for Manual entries or not

Yes

Enumeration:

●       0 - No

●       1 - Yes

25

AllowSignatureEVVVerification

Bit

This field Checks whether Signature verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Signature Verification method is disabled


●       1 - Signature Verification method is enabled

26

AllowClientPasswordEVVVerification

Bit

This field Checks whether Password verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Password Verification method is disabled


●       1 - Password Verification method is enabled

27

AllowClientPinEVVVerification

Bit

This field Checks whether Pin verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Pin Verification method is disabled


●       1 - Pin

 Verification method is enabled

28

AllowPictureEVVVerification

Bit

This field Checks whether Picture verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Picture Verification method is disabled


●       1 - Picture

Verification method is enabled

29

PerformPictureFacialRecognition

Bit

This field Checks whether Facial Recognition is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Facial recognition is disabled


●       1 - Facial recognition is enabled

30

PictureFacialMinPercentage

Integer

This field the column stores the Min percentage value for facial recognition

Optional

Allows Integer value


FYI: Allows integer value from range 0 - 100

31

AllowFOBEVV VerificationAllowFOBEVVVerification

Bit

This field Checks whether FOB Verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - FOB Verification method is disabled


●       1 - FOB Verification method is enabled


32

AllowVoiceRecordingEVVVerification

Bit

This field Checks whether Voice Verification method is enabled/ disabled corresponding to the Funding Source

Optional

Enumeration:

●       0 - Voice Verification method is disabled


●       1 - Voice Verification method is enabled

33

RequireReasonCodeForLateEntries

Bit

This field Checks whether reason code is required for late entries or not

Optional

Enumeration:

●       0 - Reason Code is not required for late entries


●       1 - Reason Code isrequired for late entries

34

AllowMobilePortalSignOffVerification

Bit

The field will define whether the EVV verification method of Client Sign Off is enabled or not

Optional

Allows 0 or 1 value.



0 = Disables Client Sign off Verification method


1 = Enables Client Sign off Verification method

35

AllowApproveUnverifiedPicture

Bit

The field will define whether unverified pictures can be approved or not

Optional

Allows 0 or 1 value.



0 = Disables Approve Unverified Picture


1 = Enables Approve Unverified Picture

36

AllowApproveUnverifiedSignature

Bit

The field will define whether unverified signatures can be approved or not

Optional

Allows 0 or 1 value.



0 = Disables Approve Unverified signature


1 = Enables Approve Unverified signature

37

AllowApproveUnverifiedVoiceRecording

Bit

The field will define whether unverified recordings can be approved or not

Optional

Allows 0 or 1 value.



0 = Disables Approve Unverified recording


1 = Enables Approve Unverified recording

38

ScheduleCompareLogic

 

Bit

(Instance Level Setting)

Select Default (Visit Start Time is compared to Schedule Start and Visit End Time is compared to Schedule End) or Duration (Visit Duration compared to Schedule Duration)

Yes, if instance level setting is enabled

0 = Default

1 = Duration

39

AllowedDeviation


String

(Instance Level Setting)

The number of minutes a visit can deviate from the compared schedule entry and still be considered a match

Required if Duration is selected for Schedule Compare Logic

Min = 1

Max = 20

40

AutoDownwardBillableAmountAdjustment





...

Field #

Field

Type

Description

Required

Comments

1

Name

String

Name

Yes

Min Length: 6

Max Length: 200

2

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

3

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

4

City

String

City

Yes

Min Length: 2

Max Length: 20

5

State

String

State

Yes

State abbreviation of 2 characters i.e., Min Length and Max Length: 2

6

PostalCode

String

Postal Code

Yes

Length = 5 numerals

7

CountryCode

String

3 Letter Country Code

Yes

Should be USA

8

TimeZone

String

Time Zone

Yes

See “Admin Guide: Static Data Reference File for Imports” in the Help Center

9

Phone

String

Phone Number   

Yes

10-digit phone number; exclude dashes and parentheses

10

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

11

Email

String

Email Address

Yes

Email format:

test@dcisoftware.com

12

CostCenterId

Integer

Unique identifier for the Cost Center

Yes

Must use existing Id in DCI

13

ProfileReference

String

Third-party reference number for the Profile

Optional

Max Length: 200

14

EVVRequired

Boolean

EVV Required

Yes

0 - False

1 - True

15


EnableGeofencing

Boolean

Enable Geofencing

Conditional -Required if EVVRequired = 1 True

0 - False

1 - True

16

RequiresMultipleClientPerPunch

Boolean

Requires Multiple Client Per Punch

Yes

0 - False

1 - True

17

MinimumNumberOfAttendees

Integer

Value of the minimum number of Attendees should be defined

Required

The column is selectively mandatory when RequiresMultipleClientPerPunch=1

Update Employee Profile

Field #

Field

Type

Description

Required

Comments

1

ProfileId

Integer

Unique profile Id

Yes

Must be the existing employee profile Id

2

FirstName

String

First Name

Yes

Min Length: 2

Max Length: 50

3

LastName

String

Last Name

Yes

Min Length: 2

Max Length: 50

4

FullName

String

Full Name

Optional

Min Length: 2

Max Length: 200

5

Address

String

Address Line 1

Yes

Min Length: 2

Max Length: 150

6

Address2

String

Address Line 2

Optional

Min Length: 2

Max Length: 150

7

City

String

City

Yes

Min Length: 2

Max Length: 20

8

State

String

State

Yes

The state’s two letter abbreviation (i.e., AZ)

9

PostalCode

String

Postal Code

Yes

Length = 5 numerals

10

Phone

String

Phone Number

Yes

10-digit phone number; exclude dashes and parentheses

11

AltPhone

String

Alternate Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

12

MobilePhone

String

Cell Phone Number

Optional

10-digit phone number; exclude dashes and parentheses

13

Email

String

Email Address

Yes

Email format: test@dcisoftware.com

14

TimeZone

String

Time Zone

Yes

See “Imports – Static Data Reference File – Admin Guide” in the Help Center

15

CostCenterId

Integer

Unique cost center Id

Yes

Must be the existing cost center Id

16

DOB

Date

Date of Birth

Yes

Format: MM/DD/YYYY

17

ProfileReference

String

Third-party reference number for the profile

Optional

Min Length: 1

Max Length: 200

18

EmployeeType

Integer

Employee Type

Yes

See “Imports – Static Data Reference File – Admin Guide” in the Help Center:

Hourly Non-Exempt: 2

Salary Exempt: 3

Salary Non-Exempt: 4

Contractor: 5

19

EmployeeNumber

String

Third-party employee number

Yes

Min Length: 2

Max Length: 20

20

SSN

String

Social Security Number

Yes

Min and Max Length: 9 (Numerals)

Full non-encrypted social security number

21

ProfessionalId1

String

Third-party professional identifier

Optional

Min Length: 2

Max Length: 20

22

ProfessionalId2

String

Third-party professional identifier

Optional

Min Length: 2

Max Length: 20

23

PayrollId

String

Third-party payroll identifier

Optional

Min Length: 2

Max Length: 20

24

WeeklyHours

Decimal

Weekly Hours available to work

Yes

Min Length: 2

Max Length: 20

25

HolidayScheduleId

Integer

Holiday Schedule identifier

Yes

Must be the existing holiday schedule Id

26

TemplateId

Integer

Certification Template Id

Optional

Must be the existing certification template Id

27

DomesticWorker

Boolean

Domestic Worker

Yes

0 – No

1 - Yes

28

OneDayRestIn7Exemption

Boolean

One Day of Rest in 7 Exemption

Yes

0 – No

1 - Yes

29

PreferredDayOfRest

Integer

Preferred Day Of Rest

Conditional – Required if OneDayRestIn7Exemption = 1 (Yes)

0 – Sunday

1 – Monday

2 – Tuesday

3 – Wednesday

4 – Thursday

5 – Friday

6 - Saturday

30

RetainSSN

Bit

Checks whether the SSN needs to be stored in Encrypted SSN or not

No

0 – No

1 - Yes

31

HireDate

 Date

Hire Date of Employee

No

Format: MM/DD/YYYY

32

Pin

Nvarchar

Login Pin of the Employee

Yes

Min/Max Length: 4

33

ProfileStatus

Integer

Status of the Employee

Yes

1 – Active

2 - Inactive

Update Employee Profile Element

...