Employees



Important note about API versions

If you are using Dovico Timesheet version 13 or below, you should use API version 5. If using version 14, use API version 6.


This call has been updated to reflect the 6th version of the API.

The original Employees call can be found using this link.
The v5 call can be found using this link

The API calls listed below enable a person to view, create, and edit Employees that they have been given security access to within DOVICO Timesheet or DOVICO Planning and Timesheet.

Examples are provided using cURL.cURL is a 3rd party tool used for transferring data with URL syntax.



Get all Employees


GET Employees/

Returns a list of all Employees using pagination. Note: The $filter query string can optionally be included with this request.

Security Check:
The user must have Software Access set to All and have Read access to the Employees view. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <EmployeeGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </EmployeeGroup>
                    <SecurityGroup>
                        <ID>96</ID>
                        <Name>Administrator</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </SecurityGroup>
                    <SoftwareAccess>B</SoftwareAccess>
                    <Wage>10</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </WageCurrency>
                    <WageChangedDate>2000-01-01</WageChangedDate>
                    <Charge>14</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </ChargeCurrency>
                    <ChargeChangedDate>2000-01-01</ChargeChangedDate>
                    <StartDate>2000-01-01</StartDate>
                    <EndDate>2020-01-01</EndDate>
                    <Email>SamSmith@SmithCo.com</Email>
                    <WorkDays>.MTWTF.</WorkDays>
                    <Hours>7.5</Hours>
                    <AltApproval>F</AltApproval>
                    <NotificationTime>F</NotificationTime>
                    <NotificationExpense>F</NotificationExpense>
                    <NotificationRejected>F</NotificationRejected>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Employee>
                <Employee>
                    ...
                </Employee>
            </Employees>
            <PrevPageURI>https://api.dovico.com/Employees/?prev=100&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Employees/?next=174&version=6</NextPageURI>
        </Result>


Fields for Result
Employees (will return zero or more Employee nodes)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (node containing information about the Employee Group associated with this employee)
SecurityGroup (node containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)


Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "EmployeeGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "SecurityGroup":
                    {
                        "ID":"96",
                        "Name":"Administrator",
                        "GetItemURI":"N\/A"
                    },
                    "SoftwareAccess":"B",
                    "Wage":"10",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "WageChangedDate":"2000-01-01",
                    "Charge":"14",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "ChargeChangedDate":"2000-01-01",
                    "StartDate":"2000-01-01",
                    "EndDate":"2020-01-01",
                    "Email":"SamSmith@SmithCo.com",
                    "WorkDays":".MTWTF.",
                    "Hours":"7.5",
                    "AltApproval":"F",
                    "NotificationTime":"F",
                    "NotificationExpense":"F",
                    "NotificationRejected":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Employees\/?prev=100&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/Employees\/?next=174&version=6"
        }

Fields
Employees (will return zero or more Employee objects)
PrevPageURI (string. Will be 'N/A' if there is no previous page of data)
NextPageURI (string. Will be 'N/A' if there is no next page of data)


Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (object containing information about the Employee Group associated with this employee)
SecurityGroup (object containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)





Get an Employee


GET Employees/{sEmployeeID}/

Returns the Employee requested.

Security Check:
The user must have Software Access set to All and have Read access to the Employees view. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Employees/{EmployeeID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/100/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Employees/{EmployeeID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/100/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <EmployeeGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </EmployeeGroup>
                    <SecurityGroup>
                        <ID>96</ID>
                        <Name>Administrator</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </SecurityGroup>
                    <SoftwareAccess>B</SoftwareAccess>
                    <Wage>10</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </WageCurrency>
                    <WageChangedDate>2000-01-01</WageChangedDate>
                    <Charge>14</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </ChargeCurrency>
                    <ChargeChangedDate>2000-01-01</ChargeChangedDate>
                    <StartDate>2000-01-01</StartDate>
                    <EndDate>2020-01-01</EndDate>
                    <Email>SamSmith@SmithCo.com</Email>
                    <WorkDays>.MTWTF.</WorkDays>
                    <Hours>7.5</Hours>
                    <AltApproval>F</AltApproval>
                    <NotificationTime>F</NotificationTime>
                    <NotificationExpense>F</NotificationExpense>
                    <NotificationRejected>F</NotificationRejected>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Employee>
            </Employees>
        </Result>

Fields for Result
Employees (will return zero Employee nodes if the requested item does not exist. Will return one Employee node if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (node containing information about the Employee Group associated with this employee)
SecurityGroup (node containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)

Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "EmployeeGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "SecurityGroup":
                    {
                        "ID":"96",
                        "Name":"Administrator",
                        "GetItemURI":"N\/A"
                    },
                    "SoftwareAccess":"B",
                    "Wage":"10",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "WageChangedDate":"2000-01-01",
                    "Charge":"14",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "ChargeChangedDate":"2000-01-01",
                    "StartDate":"2000-01-01",
                    "EndDate":"2020-01-01",
                    "Email":"SamSmith@SmithCo.com",
                    "WorkDays":".MTWTF.",
                    "Hours":"7.5",
                    "AltApproval":"F",
                    "NotificationTime":"F",
                    "NotificationExpense":"F",
                    "NotificationRejected":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Employees (will return zero Employee objects if the requested item does not exist. Will return one Employee object if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (object containing information about the Employee Group associated with this employee)
SecurityGroup (object containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)





Get the logged in Employee's basic information


GET Employees/Me/

Returns the logged in Employee's basic information.

Security Check:
The user must have at least 'Time and Expense Entry only' Software Access.

Example XML request:
 
        URI: https://api.dovico.com/Employees/Me/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Employees/Me/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <GetItemURI>https://api.dovico.com/Employees/100/?version=6</GetItemURI>
                </Employee>
            </Employees>
        </Result>

Fields for Result
Employees (will return one Employee node for the logged in employee)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
GetItemURI (string - URI to pull detailed information about the logged in employee)

NOTE: The GetItemURI field will be set to 'N/A' if the logged in user is the system account.


Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=6"
                }
            ]
        }



Fields
Employees (will return one Employee object for the logged in employee)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
GetItemURI (string - URI to pull detailed information about the logged in employee)

NOTE: The GetItemURI field will be set to 'N/A' if the logged in user is the system account.





Get the logged in Employee's regional setting information


GET Employees/Me/RegionalSettings/

Returns the logged in Employee's regional setting information.

Security Check:
The user must have at least 'Time and Expense Entry only' Software Access.

Example XML request:
 
        URI: https://api.dovico.com/Employees/Me/RegionalSettings/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/RegionalSettings/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Employees/Me/RegionalSettings/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/RegionalSettings/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <LanguageCultureName>en-US</LanguageCultureName>
            <Currency>
                <DecimalDigits>2</DecimalDigits>
                <DecimalSeperator>.</DecimalSeperator>
                <GroupSeperator>,</GroupSeperator>
                <GroupSizes>
                    <Value>3</Value>
                </GroupSizes>
                <NegativeSign>-</NegativeSign>
                <Symbol>$</Symbol>
                <Pattern>$n</Pattern>
            </Currency>
            <Number>
                <DecimalDigits>2</DecimalDigits>
                <DecimalSeperator>.</DecimalSeperator>
                <GroupSeperator>,</GroupSeperator>
                <GroupSizes>
                    <Value>3</Value>
                </GroupSizes>
                <NegativeSign>-</NegativeSign>
            </Number>
            <Date>
                <DateSeperator>/</DateSeperator>
                <ShortDatePattern>M/d/yyyy</ShortDatePattern>
                <TwoDigitYearMin>1930</TwoDigitYearMin>
                <TwoDigitYearMax>2029</TwoDigitYearMax>
                <FirstDayOfWeek>0</FirstDayOfWeek>
                <DayNames>
                    <Value>Sunday</Value>
                    <Value>Monday</Value>
                    <Value>Tuesday</Value>
                    <Value>Wednesday</Value>
                    <Value>Thursday</Value>
                    <Value>Friday</Value>
                    <Value>Saturday</Value>
                </DayNames>
                <AbbreviatedDayNames>
                    <Value>Sun</Value>
                    <Value>Mon</Value>
                    <Value>Tue</Value>
                    <Value>Wed</Value>
                    <Value>Thu</Value>
                    <Value>Fri</Value>
                    <Value>Sat</Value>
                </AbbreviatedDayNames>
                <MonthNames>
                    <Value>January</Value>
                    <Value>February</Value>
                    <Value>March</Value>
                    <Value>April</Value>
                    <Value>May</Value>
                    <Value>June</Value>
                    <Value>July</Value>
                    <Value>August</Value>
                    <Value>September</Value>
                    <Value>October</Value>
                    <Value>November</Value>
                    <Value>December</Value>
                </MonthNames>
                <AbbreviatedMonthNames>
                    <Value>Jan</Value>
                    <Value>Feb</Value>
                    <Value>Mar</Value>
                    <Value>Apr</Value>
                    <Value>May</Value>
                    <Value>Jun</Value>
                    <Value>Jul</Value>
                    <Value>Aug</Value>
                    <Value>Sep</Value>
                    <Value>Oct</Value>
                    <Value>Nov</Value>
                    <Value>Dec</Value>
                </AbbreviatedMonthNames>
            </Date>
            <Time>
                <Seperator>:</Seperator>
                <ShortTimePattern>h:mm tt</ShortTimePattern>
            </Date>
        </Result>


Fields for Result
LanguageCultureName (string - a list of culture names can be found here: http://msdn.microsoft.com/en-us/goglobal/bb896001.aspx)
Currency (node containing currency format information for the selected culture's)
Number (node containing number format information for the selected culture's)
Date (node containing date format information for the selected culture's)
Time (node containing time format information for the selected culture's)



Fields for Currency
DecimalDigits (integer)
DecimalSeperator (string)
GroupSeperator (string)
GroupSizes (array of integers)
NegativeSign (string)
Symbol (string)
Pattern (string)


NOTE: The symbol value should only be used for display when multicurrency is off


Fields for Number
DecimalDigits (integer)
DecimalSeperator (string)
GroupSeperator (string)
GroupSizes (array of integers)
NegativeSign (string)


Fields for Date
DateSeperator (string)
ShortDatePattern (string)
TwoDigitYearMin (string)
TwoDigitYearMax (string)
FirstDayOfWeek (integer)
DayNames (array of day names)
AbbreviatedDayNames (array of day name abbreviations)
MonthNames (array of month names)
AbbreviatedMonthNames (array of month name abbreviations)


Fields for Time
Seperator (string)
ShortTimePattern (string)


Example JSON response:
 
        {
            "LanguageCultureName":"en-US",
            "Currency":
            {
                "DecimalDigits":"2",
                "DecimalSeperator":".",
                "GroupSeperator":",",
                "GroupSizes":
                [
                    "3"
                ],
                "NegativeSign":"-",
                "Symbol":"$",
                "Pattern":"$n"
            },
            "Number":
            {
                "DecimalDigits":"2",
                "DecimalSeperator":".",
                "GroupSeperator":",",
                "GroupSizes":
                [
                    "3"
                ],
                "NegativeSign":"-"
            },
            "Date":
            {
                "DateSeperator":"\/",
                "ShortDatePattern":"M\/d\/yyyy",
                "TwoDigitYearMin":"1930",
                "TwoDigitYearMax":"2029",
                "FirstDayOfWeek":"0",
                "DayNames":
                [
                    "Sunday",
                    "Monday",
                    "Tuesday",
                    "Wednesday",
                    "Thursday",
                    "Friday",
                    "Saturday"
                ],
                "AbbreviatedDayNames":
                [
                    "Sun",
                    "Mon",
                    "Tue",
                    "Wed",
                    "Thu",
                    "Fri",
                    "Sat",
                ],
                "MonthNames":
                [
                    "January",
                    "February",
                    "March",
                    "April",
                    "May",
                    "June",
                    "July",
                    "August",
                    "September",
                    "October",
                    "November",
                    "December",
                ],
                "AbbreviatedMonthNames":
                [
                    "Jan",
                    "Feb",
                    "Mar",
                    "Apr",
                    "May",
                    "Jun",
                    "Jul",
                    "Aug",
                    "Sep",
                    "Oct",
                    "Nov",
                    "Dec",
                ]
            },
            "Time":
            {
                "ShortTimePattern"h:mm tt"
                "Seperator":",
            }
        }

Fields
LanguageCultureName (string - a list of culture names can be found here: http://msdn.microsoft.com/en-us/goglobal/bb896001.aspx)
Currency (object containing currency format information for the selected culture's)
Number (object containing number format information for the selected culture's)
Date (object containing date format information for the selected culture's)
Time (object containing time format information for the selected culture's)



Fields for Currency
DecimalDigits (integer)
DecimalSeperator (string)
GroupSeperator (string)
GroupSizes (array of integers)
NegativeSign (string)
Symbol (string)
Pattern (string)


NOTE: The symbol value should only be used for display when multicurrency is off


Fields for Number
DecimalDigits (integer)
DecimalSeperator (string)
GroupSeperator (string)
GroupSizes (array of integers)
NegativeSign (string)


Fields for Date
DateSeperator (string)
ShortDatePattern (string)
TwoDigitYearMin (string)
TwoDigitYearMax (string)
FirstDayOfWeek (integer)
DayNames (array of day names)
AbbreviatedDayNames (array of day name abbreviations)
MonthNames (array of month names)
AbbreviatedMonthNames (array of month name abbreviations)


Fields for Time
Seperator (string)
ShortTimePattern (string)




Get the logged in Employee's Timesheet options


GET Employees/Me/Options/

Returns the logged in Employee's Timesheet options.

Security Check:
The user must have at least 'Time and Expense Entry only' Software Access.

Example XML request:
 
        URI: https://api.dovico.com/Employees/Me/Options/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/Options/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Employees/Me/Options/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/Me/Options/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ShowStartEndTimes>F</ShowStartEndTimes>
            <ShowTimeIn24HourFormat>T</ShowTimeIn24HourFormat>
            <RegionalSetting>
                <LanguageCultureName>en-US</LanguageCultureName>
                <GetItemURI>https://api.dovico.com/Employees/Me/RegionalSettings/?version=6</GetItemURI>
            </RegionalSetting>
            <ShowProjectDescription>F</ShowProjectDescription>
            <ShowTaskDescription>F</ShowTaskDescription>
            <ShowTimeDescription>T</ShowTimeDescription>
            <ShowBillable>F</ShowBillable>
            <ShowClientOvertime>T</ShowClientOvertime>
            <ShowCompanyOvertime>T</ShowCompanyOvertime>
            <MyWeekStartsOn>0</MyWeekStartsOn>
            <MyDayStartsAt>0800</MyDayStartsAt>
            <WhenSubmitting>
                <WarnIfDayIsBelow>7.5</WarnIfDayIsBelow>
                <WarnIfDayIsAbove>10</WarnIfDayIsAbove>
            </WhenSubmitting>
        </Result>

Fields for Result
ShowStartEndTimes (string - 'T' or 'F')
ShowTimeIn24HourFormat (string - 'T' or 'F')
RegionalSetting (node containing regional setting information for the logged in employee)
ShowProjectDescription (string - 'T' or 'F')
ShowTaskDescription (string - 'T' or 'F')
ShowTimeDescription (string - 'T' or 'F')
ShowBillable (string - 'T' or 'F')
ShowClientOvertime (string - 'T' or 'F')
ShowCompanyOvertime (string - 'T' or 'F')
MyWeekStartsOn (integer representing the day of the week: 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, and 6 - Saturday)
MyDayStartsAt (string - in the format HHmm)
WhenSubmitting (node containing the minimum and maximum working hours per day)



Fields for RegionalSetting
LanguageCultureName (string - a list of culture names can be found here: http://msdn.microsoft.com/en-us/goglobal/bb896001.aspx)
GetItemURI (string - URI to pull information about the reginal setting)


Fields for WhenSubmitting
WarnIfDayIsBelow (double - US English format)
WarnIfDayIsAbove (double - US English format)

NOTE: - WarnIfDayIsBelow will be 'N/A' if the 'Is Below' option is off
- WarnIfDayIsAbove will be 'N/A' if the 'Is Above' option is off


Example JSON response:
 
        {
            "ShowStartEndTimes":"F",
            "ShowTimeIn24HourFormat":"T",
            "RegionalSetting":
            {
                "LanguageCultureName":"en-US",
                "GetItemURI":"https:\/\/api.dovico.com\/Employees\/Me\/RegionalSettings\/?version=6"
            },
            "ShowProjectDescription":"F",
            "ShowTaskDescription":"F",
            "ShowTimeDescription":"T",
            "ShowBillable":"F",
            "ShowClientOvertime":"T",
            "ShowCompanyOvertime":"T",
            "MyWeekStartsOn":"0",
            "MyDayStartsAt":"0800",
            "WhenSubmitting":
            {
                "WarnIfDayIsBelow":"7.5",
                "WarnIfDayIsAbove":"10"
            }
        }

Fields
ShowStartEndTimes (string - 'T' or 'F')
ShowTimeIn24HourFormat (string - 'T' or 'F')
RegionalSetting (object containing regional setting information for the logged in employee)
ShowProjectDescription (string - 'T' or 'F')
ShowTaskDescription (string - 'T' or 'F')
ShowTimeDescription (string - 'T' or 'F')
ShowBillable (string - 'T' or 'F')
ShowClientOvertime (string - 'T' or 'F')
ShowCompanyOvertime (string - 'T' or 'F')
MyWeekStartsOn (integer representing the day of the week: 0 - Sunday, 1 - Monday, 2 - Tuesday, 3 - Wednesday, 4 - Thursday, 5 - Friday, and 6 - Saturday)
MyDayStartsAt (string - in the format HHmm)
WhenSubmitting (object containing the minimum and maximum working hours per day)



Fields for RegionalSetting
LanguageCultureName (string - a list of culture names can be found here: http://msdn.microsoft.com/en-us/goglobal/bb896001.aspx)
GetItemURI (string - URI to pull information about the reginal setting)


Fields for WhenSubmitting
WarnIfDayIsBelow (double - US English format)
WarnIfDayIsAbove (double - US English format)

NOTE: - WarnIfDayIsBelow will be 'N/A' if the 'Is Below' option is off
- WarnIfDayIsAbove will be 'N/A' if the 'Is Above' option is off





Insert


POST Employees/

Creates the Employees specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Employees view.

Example XML request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Employees><Employee><LastName>Smith</LastName><FirstName>Sam</FirstName></Employee></Employees>"

Fields for Employees
*Employee (required - at least one Employee node is required but more than one can be provided)


Fields for Employee
*LastName (required - string with a maximum length of 100 characters)
*FirstName (required - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
UserID (optional - string with a maximum length of 100 characters)
Password (optional - string with a maximum length of 100 characters)
*Email (required - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - zero or more CustomField nodes)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.


Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""LastName"":""Smith"",""FirstName"":""Sam""}]"
Fields
*An array containing at least one Employee object (required)


Fields for Employee
*LastName (required - string with a maximum length of 100 characters)
*FirstName (required - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
UserID (optional - string with a maximum length of 100 characters)
Password (optional - string with a maximum length of 100 characters)
*Email (required - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - an array of zero or more CustomField objects)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.


Fields for CustomField
*ID (required - long - specify -1 in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <EmployeeGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </EmployeeGroup>
                    <SecurityGroup>
                        <ID>96</ID>
                        <Name>Administrator</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </SecurityGroup>
                    <SoftwareAccess>B</SoftwareAccess>
                    <Wage>10</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </WageCurrency>
                    <WageChangedDate>2000-01-01</WageChangedDate>
                    <Charge>14</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </ChargeCurrency>
                    <ChargeChangedDate>2000-01-01</ChargeChangedDate>
                    <StartDate>2000-01-01</StartDate>
                    <EndDate>2020-01-01</EndDate>
                    <Email>SamSmith@SmithCo.com</Email>
                    <WorkDays>.MTWTF.</WorkDays>
                    <Hours>7.5</Hours>
                    <AltApproval>F</AltApproval>
                    <NotificationTime>F</NotificationTime>
                    <NotificationExpense>F</NotificationExpense>
                    <NotificationRejected>F</NotificationRejected>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Employee>
            </Employees>
        </Result>

Fields for Result
Employees (will return zero Employee nodes if the requested item does not exist. Will return one Employee node if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (node containing information about the Employee Group associated with this employee)
SecurityGroup (node containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)


Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "EmployeeGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "SecurityGroup":
                    {
                        "ID":"96",
                        "Name":"Administrator",
                        "GetItemURI":"N\/A"
                    },
                    "SoftwareAccess":"B",
                    "Wage":"10",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "WageChangedDate":"2000-01-01",
                    "Charge":"14",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "ChargeChangedDate":"2000-01-01",
                    "StartDate":"2000-01-01",
                    "EndDate":"2020-01-01",
                    "Email":"SamSmith@SmithCo.com",
                    "WorkDays":".MTWTF.",
                    "Hours":"7.5",
                    "AltApproval":"F",
                    "NotificationTime":"F",
                    "NotificationExpense":"F",
                    "NotificationRejected":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Employees (will return zero Employee objects if the requested item does not exist. Will return one Employee object if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (object containing information about the Employee Group associated with this employee)
SecurityGroup (object containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)




Update (bulk)


PUT Employees/

Updates the Employees specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Employees view.

Example XML request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Employees><Employee><ID>100</ID><Email>SamSmith@SmithCo.com</Email></Employee></Employees>"
Fields for Employees
*Employee (required - at least one Employee node is required but more than one can be provided)


Fields for Employee
*ID (required - long - the ID of the employee record to update)
LastName (optional - string with a maximum length of 100 characters)
FirstName (optional - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
Email (optional - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Employees/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ID"":""100"",""Email"":""SamSmith@SmithCo.com""}]"

Fields
*An array containing at least one Employee object (required)


Fields for Employee
*ID (required - long - the ID of the employee record to update)
LastName (optional - string with a maximum length of 100 characters)
FirstName (optional - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
Email (optional - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)


Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <EmployeeGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </EmployeeGroup>
                    <SecurityGroup>
                        <ID>96</ID>
                        <Name>Administrator</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </SecurityGroup>
                    <SoftwareAccess>B</SoftwareAccess>
                    <Wage>10</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </WageCurrency>
                    <WageChangedDate>2000-01-01</WageChangedDate>
                    <Charge>14</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </ChargeCurrency>
                    <ChargeChangedDate>2000-01-01</ChargeChangedDate>
                    <StartDate>2000-01-01</StartDate>
                    <EndDate>2020-01-01</EndDate>
                    <Email>SamSmith@SmithCo.com</Email>
                    <WorkDays>.MTWTF.</WorkDays>
                    <Hours>7.5</Hours>
                    <AltApproval>F</AltApproval>
                    <NotificationTime>F</NotificationTime>
                    <NotificationExpense>F</NotificationExpense>
                    <NotificationRejected>F</NotificationRejected>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Employee>
            </Employees>
        </Result>

Fields for Result
Employees (will return zero Employee nodes if the requested item does not exist. Will return one Employee node if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (node containing information about the Employee Group associated with this employee)
SecurityGroup (node containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)


Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "EmployeeGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "SecurityGroup":
                    {
                        "ID":"96",
                        "Name":"Administrator",
                        "GetItemURI":"N\/A"
                    },
                    "SoftwareAccess":"B",
                    "Wage":"10",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "WageChangedDate":"2000-01-01",
                    "Charge":"14",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "ChargeChangedDate":"2000-01-01",
                    "StartDate":"2000-01-01",
                    "EndDate":"2020-01-01",
                    "Email":"SamSmith@SmithCo.com",
                    "WorkDays":".MTWTF.",
                    "Hours":"7.5",
                    "AltApproval":"F",
                    "NotificationTime":"F",
                    "NotificationExpense":"F",
                    "NotificationRejected":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


Fields
Employees (will return zero Employee objects if the requested item does not exist. Will return one Employee object if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (object containing information about the Employee Group associated with this employee)
SecurityGroup (object containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)





Update


PUT Employees/{sEmployeeID}/

Updates the Employee specified.

Security Check:
The user must have Software Access set to All and have Read and Modify access to the Employees view.

Example XML request:
 
        URI: https://api.dovico.com/Employees/{EmployeeID}/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/100/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Employee><Email>SamSmith@SmithCo.com</Email></Employee>"
Fields for Employee
LastName (optional - string with a maximum length of 100 characters)
FirstName (optional - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
Email (optional - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.

All fields are optional but at least one must be specified

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - zero or more Value nodes)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example JSON request:
 
        URI: https://api.dovico.com/Employees/{EmployeeID}/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Employees/100/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""Email"":""SamSmith@SmithCo.com""}"

Fields for Employee
LastName (optional - string with a maximum length of 100 characters)
FirstName (optional - string with a maximum length of 100 characters)
EmployeeGroupID (optional - long - must be a valid employee group id)
SecurityGroupID (optional - long - must be a valid security group id)
SoftwareAccess (optional - string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (optional - double in US English format)
WageCurrencyID (optional - long - must be an enabled currency)
WageChangedDate (optional - date string in the format yyyy-MM-dd)
Charge (optional - double in US English format)
ChargeCurrencyID (optional - long - must be an enabled currency)
ChargeChangedDate (optional - date string in the format yyyy-MM-dd)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
Email (optional - string with a maximum length of 250 characters)
WorkDays (optional - string with a maximum length of 7 characters)
Hours (optional - double in US English format)
AltApproval (optional - string 'T' or 'F')
NotificationTime (optional - string 'T' or 'F')
NotificationExpense (optional - string 'T' or 'F')
NotificationRejected (optional - string 'T' or 'F')
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)


NOTE: - The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Company Cost security access. Otherwise an error will be returned.
- The Wage, WageCurrencyID, and WageChangedDate fields can only be set if the logged in user has Client Cost security access. Otherwise an error will be returned.
- The SecurityGroupID and SoftwareAccess fields can only be specified when using a Consumer Secret or a trusted 3rd party developer key. Otherwise, an error will be returned.

All fields are optional but at least one must be specified

WARNING: The Integrate field is used by several of DOVICO Software's integration solutions. If this field contains a value, do not overwrite the value with a new value unless you intend for this record to no longer work with the solution(s) it was integrated with.


Fields for CustomField
*ID (required - long)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - an array of zero or more Value objects)



Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Employees>
                <Employee>
                    <ID>100</ID>
                    <LastName>Smith</LastName>
                    <FirstName>Sam</FirstName>
                    <EmployeeGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </EmployeeGroup>
                    <SecurityGroup>
                        <ID>96</ID>
                        <Name>Administrator</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </SecurityGroup>
                    <SoftwareAccess>B</SoftwareAccess>
                    <Wage>10</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </WageCurrency>
                    <WageChangedDate>2000-01-01</WageChangedDate>
                    <Charge>14</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </ChargeCurrency>
                    <ChargeChangedDate>2000-01-01</ChargeChangedDate>
                    <StartDate>2000-01-01</StartDate>
                    <EndDate>2020-01-01</EndDate>
                    <Email>SamSmith@SmithCo.com</Email>
                    <WorkDays>.MTWTF.</WorkDays>
                    <Hours>7.5</Hours>
                    <AltApproval>F</AltApproval>
                    <NotificationTime>F</NotificationTime>
                    <NotificationExpense>F</NotificationExpense>
                    <NotificationRejected>F</NotificationRejected>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Employee>
            </Employees>
        </Result>
Fields for Result
Employees (will return zero Employee nodes if the requested item does not exist. Will return one Employee node if the requested item does exist)



Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (node containing information about the Employee Group associated with this employee)
SecurityGroup (node containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value nodes)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)


Example JSON response:
 
        {
        "Employees":
            [
                {
                    "ID":"100",
                    "LastName":"Smith",
                    "FirstName":"Sam",
                    "EmployeeGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "SecurityGroup":
                    {
                        "ID":"96",
                        "Name":"Administrator",
                        "GetItemURI":"N\/A"
                    },
                    "SoftwareAccess":"B",
                    "Wage":"10",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "WageChangedDate":"2000-01-01",
                    "Charge":"14",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "ChargeChangedDate":"2000-01-01",
                    "StartDate":"2000-01-01",
                    "EndDate":"2020-01-01",
                    "Email":"SamSmith@SmithCo.com",
                    "WorkDays":".MTWTF.",
                    "Hours":"7.5",
                    "AltApproval":"F",
                    "NotificationTime":"F",
                    "NotificationExpense":"F",
                    "NotificationRejected":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

Fields
Employees (will return zero Employee objects if the requested item does not exist. Will return one Employee object if the requested item does exist)


Fields for Employee
ID (long)
LastName (string)
FirstName (string)
EmployeeGroup (object containing information about the Employee Group associated with this employee)
SecurityGroup (object containing information about the Security Group associated with this employee)
SoftwareAccess (string - 'N' for None...the employee cannot log into the software, 'T' for Time and Expense Entry only...the employee has access to only time and expense entry views, or 'B' for Both...the employee has access to administrative and time/expense entry views)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
WageChangedDate (string - in the format yyyy-MM-dd)
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
ChargeChangedDate (string - in the format yyyy-MM-dd)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
Email (string)
WorkDays (string)
Hours (double - US English format)
AltApproval (string - 'T' or 'F')
NotificationTime (string - 'T' or 'F')
NotificationExpense (string - 'T' or 'F')
NotificationRejected (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Wage and WageChangedDate fields will be empty if the logged in user does not have Company Cost security access.
- The Charge and ChargeChangedDate fields will be empty if the logged in user does not have Client Cost security access.


Fields for EmployeeGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Employee Group)

NOTE: The ID will be 0 if the employee has no employee group specified. The URI will be 'N/A'.


Fields for SecurityGroup
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the Security Group. The URI will be 'N/A'.)


Fields for WageCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Company Cost security access.


Fields for ChargeCurrency
ID (long)
Symbol (string)
GetItemURI (string - URI to pull information about the current currency item)

NOTE: The ID field will be empty and the URI field set to 'N/A' if the logged in user does not have Client Cost security access.


Fields for CustomField
ID (long)
TemplateID (long)
Name (string)
Values (will return one or more Value objects)
GetCustomTemplateURI (string - URI to pull information about this custom template)


Fields for CustomField's Values object
Value (string, date, or double - based on the custom template's type)