Time Entries v5

The page is an archive of the original Time Entries call. It has been replaced by version 6.

The original Project calls can be found using the following links
version 1
version 2 and 3

The API calls listed below enable a person to view, create, and edit Time Entries 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 Time Entries


GET TimeEntries/

Returns a list of all Time Entries using pagination. This call does not include custom field information. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" -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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T0bb4860f-2669-49ab-ae5e-dd8908366c8b</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-05</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1200</StopTime>
                    <TotalHours>4</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/?prev=T0bb4860f-2669-49ab-ae5e-dd8908366c8b&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/?next=T5f486bd5-012c-4fee-8e73-18553e2c6e90&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T0bb4860f-2669-49ab-ae5e-dd8908366c8b",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-05",
                    "StartTime":"0800",
                    "StopTime":"1200",
                    "TotalHours":"4",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?prev=T0bb4860f-2669-49ab-ae5e-dd8908366c8b&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?next=T5f486bd5-012c-4fee-8e73-18553e2c6e90&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)





Date Range Filter (with Get Time Entries)


GET TimeEntries/?daterange={daterange}

Using Date Range Filter: Returns a list of all Time Entries, that are within the requested date range, using pagination.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/?daterange={DateRange}&version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?daterange=2011-06-01%202011-06-30&version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI

*DateRange (required - two date strings in the format yyyy-MM-dd separated by a space and URI Encoded)

Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/?daterange={DateRange}&version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?daterange=2011-06-01%202011-06-30&version=5" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI

*DateRange (required - two date strings in the format yyyy-MM-dd separated by a space and URI Encoded)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TimeEntries>
                <TimeEntry>
                    <ID>T0bb4860f-2669-49ab-ae5e-dd8908366c8b</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-05</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1200</StopTime>
                    <TotalHours>4</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/?prev=T0bb4860f-2669-49ab-ae5e-dd8908366c8b&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/?next=T5f486bd5-012c-4fee-8e73-18553e2c6e90&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T0bb4860f-2669-49ab-ae5e-dd8908366c8b",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-05",
                    "StartTime":"0800",
                    "StopTime":"1200",
                    "TotalHours":"4",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?prev=T0bb4860f-2669-49ab-ae5e-dd8908366c8b&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?next=T5f486bd5-012c-4fee-8e73-18553e2c6e90&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)



Return Currency (with Get Time Entries)


GET TimeEntries/?returncurrency={CurrencyID}

Using Return Currency: For the list of time entries that are returned, each time entry's Charge and Wage value is converted to the requested currency. The ChargeCurrency and WageCurrency values are also returned as the requested currency.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool. Multicurrency must be enabled and the specified currency must also be enabled.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/?returncurrency={CurrencyID}&version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?returncurrency=159&version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
Fields for the URI
  • ReturnCurrency (required - the currency id that the Charge and Wage values are to be converted to)

NOTE: - An error will be returned if multicurrency is off
- An error will also be returned if the specified currency id is not enabled

Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/?returncurrency={CurrencyID}&version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?returncurrency=159&version=5" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""

Fields for the URI
  • ReturnCurrency (required - the Currency ID that the Charge and Wage values are to be converted to)

NOTE: - An error will be returned if multicurrency is off
- An error will also be returned if the specified Currency ID is not enabled

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TimeEntries>
                <TimeEntry>
                    <ID>M1265</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>A</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>110</ID>
                        <Name>Sick Time</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/110/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>100</ID>
                        <Name>Doe, Jane</Name>
                        <GetItemURI>https://api.dovico.com/Employees/100/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-04-11</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1800</StopTime>
                    <TotalHours>10</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>42.05</Charge>
                    <ChargeCurrency>
                        <ID>159</ID>
                        <Symbol>EUR €</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/159/?version=5</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>25.23</Wage>
                    <WageCurrency>
                        <ID>159</ID>
                        <Symbol>EUR €</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/159/?version=5</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>1</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/?prev=M1265&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/?next=M1274&version=5</NextPageURI>
        </Result>

Fields for Result
TimeEntries (will return zero or more TimeEntry 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 TimeEntry
ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet
ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


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


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField
ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"M1265",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"A",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"110",
                        "Name":"Sick Time",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/110\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"100",
                        "Name":"Doe, Jane",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=5"
                    },
                    "Date":"2011-04-11",
                    "StartTime":"0800",
                    "StopTime":"1800",
                    "TotalHours":"10",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"42.05",
                    "ChargeCurrency":
                    {
                        "ID":"159",
                        "Symbol":"EUR €",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/159\/?version=5"
                    },
                    "OTCharge":"1",
                    "Wage":"25.23",
                    "WageCurrency":
                    {
                        "ID":"159",
                        "Symbol":"EUR €",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/159\/?version=5"
                    },
                    "OTWage":"1",
                    "Prorate":"1",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?prev=M1265&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/?next=M1274&version=5"
        }

Fields
TimeEntries (will return zero or more TimeEntry 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 TimeEntry
ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet
ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


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


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField
ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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 a Time Entry


GET TimeEntries/{sTimeEntryID}/

Returns the time entry requested including any custom fields associated with the time entry. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/{TimeEntryID}/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/0bb4860f-2669-49ab-ae5e-dd8908366c8b/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/{TimeEntryID}/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/0bb4860f-2669-49ab-ae5e-dd8908366c8b/?version=5" -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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T0bb4860f-2669-49ab-ae5e-dd8908366c8b</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-05</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1200</StopTime>
                    <TotalHours>4</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
            </TimeEntries>
        </Result>
 

Fields for Result

TimeEntries (will return zero TimeEntry nodes if the requested item does not exist. Will return one TimeEntry node if the requested item does exist)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T0bb4860f-2669-49ab-ae5e-dd8908366c8b",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-05",
                    "StartTime":"0800",
                    "StopTime":"1200",
                    "TotalHours":"4",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 

Fields

TimeEntries (will return zero TimeEntry objects if the requested item does not exist. Will return one TimeEntry object if the requested item does exist)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Status Filter (with Get Time Entries)


GET TimeEntries/Status/{sStatus}/

Using Status Filter; Returns a list of all Time Entries, that have the requested Status, using pagination. This call does not include custom field information. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/Status/{Status}/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Status/A/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI

*Status (required - available status values are: A (approved entries), N (unsubmitted entries), R (rejected entries), and U (under review entries))

Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/Status/{Status}/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Status/A/?version=5" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 

Fields for the URI

*Status (required - available status values are: A (approved entries), N (unsubmitted entries), R (rejected entries), and U (under review entries))

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TimeEntries>
                <TimeEntry>
                    <ID>M1265</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>A</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>110</ID>
                        <Name>Sick Time</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/110/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>100</ID>
                        <Name>Doe, Jane</Name>
                        <GetItemURI>https://api.dovico.com/Employees/100/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-04-11</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1800</StopTime>
                    <TotalHours>10</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>50</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>30</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>1</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/Status/A/?prev=M1265&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/Status/A/?next=M1274&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"M1265",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"A",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"110",
                        "Name":"Sick Time",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/110\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"100",
                        "Name":"Doe, Jane",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=5"
                    },
                    "Date":"2011-04-11",
                    "StartTime":"0800",
                    "StopTime":"1800",
                    "TotalHours":"10",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"50",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTCharge":"1",
                    "Wage":"30",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTWage":"1",
                    "Prorate":"1",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Status\/A\/?prev=M1265&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Status\/A\/?next=M1274&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Employee Filter (with Get Time Entries)


GET TimeEntries/Employee/{sEmployeeID}/

Using Employee Filter; Returns a list of all Time Entries, that have been entered for the requested Employee, using pagination. This call does not include custom field information. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/Employee/{EmployeeID}/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Employee/100/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/Employee/{EmployeeID}/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Employee/100/?version=5" -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">
            <TimeEntries>
                <TimeEntry>
                    <ID>M1265</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>A</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>99</ID>
                        <Name>Leave/Absences</Name>
                        <GetItemURI>https://api.dovico.com/Projects/99/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>110</ID>
                        <Name>Sick Time</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/110/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>100</ID>
                        <Name>Doe, Jane</Name>
                        <GetItemURI>https://api.dovico.com/Employees/100/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-04-11</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1800</StopTime>
                    <TotalHours>10</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>50</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>30</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>1</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/Status/A/?prev=M1265&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/Status/A/?next=M1274&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"M1265",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"A",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"99",
                        "Name":"Leave\/Absences",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/99\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"110",
                        "Name":"Sick Time",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/110\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"100",
                        "Name":"Doe, Jane",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/100\/?version=5"
                    },
                    "Date":"2011-04-11",
                    "StartTime":"0800",
                    "StopTime":"1800",
                    "TotalHours":"10",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"50",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTCharge":"1",
                    "Wage":"30",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTWage":"1",
                    "Prorate":"1",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Status\/A\/?prev=M1265&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Status\/A\/?next=M1274&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Project Filter (with Get Time Entries)


GET TimeEntries/Project/{sProjectID}/

Using Project Filter; Returns a list of all Time Entries, that have been entered for the requested Project, using pagination. This call does not include custom field information. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/Project/{ProjectID}/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Project/144/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/Project/{ProjectID}/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Project/144/?version=5" -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">
            <TimeEntries>
                <TimeEntry>
                    <ID>M1273</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>A</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>144</ID>
                        <Name>QA</Name>
                        <GetItemURI>https://api.dovico.com/Projects/144/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>404</ID>
                        <Name>Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/404/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>174</ID>
                        <Name>Young, Christie</Name>
                        <GetItemURI>https://api.dovico.com/Employees/174/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-08</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1000</StopTime>
                    <TotalHours>2</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>50</Charge>
                    <ChargeCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>30</Wage>
                    <WageCurrency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=5</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>1</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/Project/144/?prev=M1273&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/Project/144/?next=M1323&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"M1273",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"A",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"144",
                        "Name":"QA",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/144\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"404",
                        "Name":"Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/404\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"174",
                        "Name":"Young, Christie",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/174\/?version=5"
                    },
                    "Date":"2011-06-08",
                    "StartTime":"0800",
                    "StopTime":"1000",
                    "TotalHours":"2",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"50",
                    "ChargeCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTCharge":"1",
                    "Wage":"30",
                    "WageCurrency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=5"
                    },
                    "OTWage":"1",
                    "Prorate":"1",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Project\/144\/?prev=M1273&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Project\/144\/?next=M1323&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Sheet Filter (with Get Time Entries)


GET TimeEntries/Sheet/{sSheetID}/

Using Sheet Filter; Returns a list of all Time Entries, that a part of the requested Sheet, using pagination. This call does not include custom field information. Note: The Date Range Filter, Return Currency and $filter query strings can optionally be included with this request.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read permission to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/Sheet/{SheetID}/?version=5
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Sheet/107/?version=5" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/Sheet/{SheetID}/?version=5
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Sheet/107/?version=5" -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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T851b7e2f-36e0-41fe-8187-fa6da55dc8a8</ID>
                    <Sheet>
                        <ID>107</ID>
                        <Status>R</Status>
                        <RejectedReason>Please enter a description</RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-07</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1100</StopTime>
                    <TotalHours>3</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
                <TimeEntry>
                    ...
                </TimeEntry>
            </TimeEntries>
            <PrevPageURI>https://api.dovico.com/TimeEntries/Sheet/107/?prev=T851b7e2f-36e0-41fe-8187-fa6da55dc8a8&version=5</PrevPageURI>
            <NextPageURI>https://api.dovico.com/TimeEntries/Sheet/107/?next=Tc66f187c-b7a8-4be9-a6e5-13b6c92e020a&version=5</NextPageURI>
        </Result>
 

Fields for Result

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T851b7e2f-36e0-41fe-8187-fa6da55dc8a8",
                    "Sheet":
                    {
                        "ID":"107",
                        "Status":"R",
                        "RejectedReason":"Please enter a description"
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-07",
                    "StartTime":"0800",
                    "StopTime":"1100",
                    "TotalHours":"3",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Sheet\/107\/?prev=T851b7e2f-36e0-41fe-8187-fa6da55dc8a8&version=5",
        "NextPageURI":"https:\/\/api.dovico.com\/TimeEntries\/Sheet\/107\/?next=Tc66f187c-b7a8-4be9-a6e5-13b6c92e020a&version=5"
        }
 

Fields

TimeEntries (will return zero or more TimeEntry 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 TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Insert


POST TimeEntries/

Creates the Time Entries specified.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read and Modify permissions to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/?version=5
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<TimeEntries><TimeEntry><ProjectID>1297</ProjectID><TaskID>4917</TaskID><EmployeeID>111</EmployeeID><Date>2011-06-01</Date><StartTime>0800</StartTime><StopTime>0900</StopTime><TotalHours>1</TotalHours></TimeEntry></TimeEntries>"
 
NOTE: An optional query string ('approved=T') can be included in the URI for a POST to allow time to be entered as approved time. This flag can only be set to 'T' if the logged in user is the Administrator Data Access Token. Otherwise, an error will be returned.


Fields for TimeEntries

*TimeEntry (required - at least one TimeEntry node is required but more than one can be provided)


Fields for TimeEntry

*ProjectID (required - long - the ID of the project that the time entry is for)
*TaskID (required - long - the ID of the task that the time entry is for)
*EmployeeID (required - long - the ID of the employee that the time entry is for)
*Date (required - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
CustomFields (optional - zero or more CustomField nodes)

¹ This field is required if the specified Task has the 'Required for time entry' option selected



Fields for CustomField

*ID (required - Guid - FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF 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/TimeEntries/?version=5
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ProjectID"":""1297"",""TaskID"":""4917"",""EmployeeID"":""111"",""Date"":""2011-06-01"",""StartTime"":""0800"",""StopTime"":""0900"",""TotalHours"":""1""}]"
 

NOTE: An optional query string ('approved=T') can be included in the URI for a POST to allow time to be entered as approved time. This flag can only be set to 'T' if the logged in user is the Administrator Data Access Token. Otherwise, an error will be returned.

Fields

*An array containing at least one TimeEntry object (required)


Fields for TimeEntry

*ProjectID (required - long - the ID of the project that the time entry is for)
*TaskID (required - long - the ID of the task that the time entry is for)
*EmployeeID (required - long - the ID of the employee that the time entry is for)
*Date (required - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
CustomFields (optional - an array of zero or more CustomField objects)

¹ This field is required if the specified Task has the 'Required for time entry' option selected

Fields for CustomField

*ID (required - Guid - FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - 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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T39c56492-d85f-4cf5-b45d-91046324de18</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-01</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>0900</StopTime>
                    <TotalHours>1</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
            </TimeEntries>
        </Result>
 

Fields for Result

TimeEntries (will return one TimeEntry node for each TimeEntry POSTed)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T39c56492-d85f-4cf5-b45d-91046324de18",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-01",
                    "StartTime":"0800",
                    "StopTime":"0900",
                    "TotalHours":"1",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 

Fields

TimeEntries (will return one TimeEntry object for each TimeEntry POSTed)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Submit Time Entries for approval


POST TimeEntries/Employee/{sEmployeeID}/Submit/?daterange={DateRange}

Submits the Time Entries specified by the date range query string.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read and Modify permissions to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/Employee/{EmployeeID}/Submit/?daterange={DateRange}&version=5
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Employee/100/Submit/?daterange=2011-06-01%202011-06-30&version=5" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<SubmitTime></SubmitTime>"
 

Fields for the URI

*EmployeeID (required - long - the ID of the employee that the time is to be submitted for)
*DateRange (required - two date strings in the format yyyy-MM-dd separated by a space and URI Encoded)


Fields for SubmitTime

Title (optional - string with a maximum length of 200 characters)

Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/Employee/{EmployeeID}/Submit/?daterange={DateRange}&version=5
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/Employee/100/Submit/?daterange=2011-06-01%202011-06-30&version=5" --request POST -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{}"
 

Fields for the URI

*EmployeeID (required - long - the ID of the employee that the time is to be submitted for)
*DateRange (required - two date strings in the format yyyy-MM-dd separated by a space and URI Encoded)


Fields for SubmitTime

Title (optional - string with a maximum length of 200 characters)

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <TimeEntries>
                <TimeEntry>
                    <ID>T39c56492-d85f-4cf5-b45d-91046324de18</ID>
                    <Sheet>
                        <ID>1200</ID>
                        <Status>U</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-01</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1000</StopTime>
                    <TotalHours>2</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
            </TimeEntries>
        </Result>
 

Fields for Result

TimeEntries (will return one TimeEntry node for each time entry for the employee specified and that were in the date range specified)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T39c56492-d85f-4cf5-b45d-91046324de18",
                    "Sheet":
                    {
                        "ID":"1200",
                        "Status":"U",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-01",
                    "StartTime":"0800",
                    "StopTime":"1000",
                    "TotalHours":"2",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 

Fields

TimeEntries (will return one TimeEntry object for each time entry for the employee specified and that were in the date range specified)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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 TimeEntries/

Updates the Time Entries specified.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read and Modify permissions to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/?version=5
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<TimeEntries><TimeEntry><ID>39c56492-d85f-4cf5-b45d-91046324de18</ID><ProjectID>1297</ProjectID><TaskID>4917</TaskID><EmployeeID>111</EmployeeID><Date>2011-06-01</Date><StartTime>0800</StartTime><StopTime>0900</StopTime><TotalHours>1</TotalHours></TimeEntry></TimeEntries>"

Fields for TimeEntries
  • TimeEntry (required - at least one TimeEntry node is required but more than one can be provided)

NOTE: The list of TimeEntry nodes must be for either approved time entries or unapproved time entries (Unsubmitted, Rejected, or Under Review) but not both types.


Fields for TimeEntry
*ID (required - long/Guid - specify a long if the time entry being manipulated is an approved time entry. specify the guid if the time entry being manipulated is not yet approved.)
ProjectID (optional - long - the ID of the project that the time entry is for)
TaskID (optional - long - the ID of the task that the time entry is for)
EmployeeID (optional - long - the ID of the employee that the time entry is for)
Date (optional - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
CustomFields (optional - zero or more CustomField nodes)

¹ This field is required if the specified Task has the 'Required for time entry' option selected

Fields for CustomField
*ID (required - Guid - FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF 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/TimeEntries/?version=5
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/?version=5" --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"":""39c56492-d85f-4cf5-b45d-91046324de18"",""ProjectID"":""1297"",""TaskID"":""4917"",""EmployeeID"":""111"",""Date"":""2011-06-01"",""StartTime"":""0800"",""StopTime"":""0900"",""TotalHours"":""1""}]"


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

NOTE: The array must be for either approved time entries or unapproved time entries (Unsubmitted, Rejected, or Under Review) but not both types.


Fields for TimeEntry
*ID (required - long/Guid - specify a long if the time entry being manipulated is an approved time entry. specify the guid if the time entry being manipulated is not yet approved.)
ProjectID (optional - long - the ID of the project that the time entry is for)
TaskID (optional - long - the ID of the task that the time entry is for)
EmployeeID (optional - long - the ID of the employee that the time entry is for)
Date (optional - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
CustomFields (optional - an array of zero or more CustomField objects)

¹ This field is required if the specified Task has the 'Required for time entry' option selected

Fields for CustomField
*ID (required - Guid - FFFFFFFF-FFFF-FFFF-FFFF-FFFFFFFFFFFF in this case)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - 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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T39c56492-d85f-4cf5-b45d-91046324de18</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-01</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>0900</StopTime>
                    <TotalHours>1</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
            </TimeEntries>
        </Result>

Fields for Result
TimeEntries (will return one TimeEntry node for each TimeEntry POSTed)



Fields for TimeEntry
ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet
ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


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


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField
ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T39c56492-d85f-4cf5-b45d-91046324de18",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-01",
                    "StartTime":"0800",
                    "StopTime":"0900",
                    "TotalHours":"1",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

Fields
TimeEntries (will return one TimeEntry object for each TimeEntry POSTed)



Fields for TimeEntry
ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet
ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


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


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField
ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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 TimeEntries/{sTimeEntryID}/

Updates the Time Entry specified.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Read and Modify permissions to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/{TimeEntryID}/?version=5
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/39c56492-d85f-4cf5-b45d-91046324de18/?version=5" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<TimeEntry><StartTime>1000</StartTime><StopTime>1200</StopTime><TotalHours>2</TotalHours></TimeEntry>"
 

Fields for TimeEntry

ProjectID (optional - long - the ID of the project that the time entry is for)
TaskID (optional - long - the ID of the task that the time entry is for)
EmployeeID (optional - long - the ID of the employee that the time entry is for)
Date (optional - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
Integrate (optional - string of encoded XML. If specified, only one element is permitted but the element can contain child elements. 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)

¹ This field is required if the specified Task has the 'Required for time entry' option selected

NOTE: - The Integrate value will be ignored if the time entry is not approved
- If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;

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/Guid - specify a long if the time entry being manipulated is an approved time entry. specify the guid if the time entry being manipulated is not yet approved.)
*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/TimeEntries/{TimeEntryID}/?version=5
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/39c56492-d85f-4cf5-b45d-91046324de18/?version=5" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""StartTime"":""1000"",""StopTime"":""1200"",""TotalHours"":""2""}"
 

Fields for TimeEntry

ProjectID (optional - long - the ID of the project that the time entry is for)
TaskID (optional - long - the ID of the task that the time entry is for)
EmployeeID (optional - long - the ID of the employee that the time entry is for)
Date (optional - date string in the format yyyy-MM-dd)
StartTime (optional - string in the format HHmm)
StopTime (optional - string in the format HHmm)
*TotalHours (required - double in US English format)
¹ Description (optional - string with a maximum length of 4000 characters)
Billable (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, only one element is permitted but the element can contain child elements. 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)

¹ This field is required if the specified Task has the 'Required for time entry' option selected

NOTE: The Integrate value will be ignored if the time entry is not approved

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/Guid - specify a long if the time entry being manipulated is an approved time entry. specify the guid if the time entry being manipulated is not yet approved.)
*TemplateID (required - long - the ID of the Custom Template that this Custom Field belongs to)
Values (optional - 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">
            <TimeEntries>
                <TimeEntry>
                    <ID>T39c56492-d85f-4cf5-b45d-91046324de18</ID>
                    <Sheet>
                        <ID>0</ID>
                        <Status>N</Status>
                        <RejectedReason></RejectedReason>
                    </Sheet>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Project>
                        <ID>1297</ID>
                        <Name>Development Project: A-208</Name>
                        <GetItemURI>https://api.dovico.com/Projects/1297/?version=5</GetItemURI>
                    </Project>
                    <Task>
                        <ID>4917</ID>
                        <Name>System Testing</Name>
                        <GetItemURI>https://api.dovico.com/Tasks/4917/?version=5</GetItemURI>
                    </Task>
                    <Employee>
                        <ID>111</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/111/?version=5</GetItemURI>
                    </Employee>
                    <Date>2011-06-01</Date>
                    <StartTime>0800</StartTime>
                    <StopTime>1000</StopTime>
                    <TotalHours>2</TotalHours>
                    <Description></Description>
                    <Billable>T</Billable>
                    <Charge>0</Charge>
                    <ChargeCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </ChargeCurrency>
                    <OTCharge>1</OTCharge>
                    <Wage>0</Wage>
                    <WageCurrency>
                        <ID>0</ID>
                        <Symbol></Symbol>
                        <GetItemURI>N/A</GetItemURI>
                    </WageCurrency>
                    <OTWage>1</OTWage>
                    <Prorate>0</Prorate>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1f7c9131-1982-4ab3-978f-5d8955754446</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=5</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </TimeEntry>
            </TimeEntries>
        </Result>
 

Fields for Result

TimeEntries (will return one TimeEntry node for the TimeEntry that was PUT)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (node containing information about the Sheet this time entry is a part of)
Client (node containing information about the Client this project is assigned to)
Project (node containing information about the Project this time entry is assigned to)
Task (node containing information about the Task this time entry is assigned to)
Employee (node containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (node containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (node containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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:
 
        {
        "TimeEntries":
            [
                {
                    "ID":"T39c56492-d85f-4cf5-b45d-91046324de18",
                    "Sheet":
                    {
                        "ID":"0",
                        "Status":"N",
                        "RejectedReason":""
                    },
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Project":
                    {
                        "ID":"1297",
                        "Name":"Development Project: A-208",
                        "GetItemURI":"https:\/\/api.dovico.com\/Projects\/1297\/?version=5"
                    },
                    "Task":
                    {
                        "ID":"4917",
                        "Name":"System Testing",
                        "GetItemURI":"https:\/\/api.dovico.com\/Tasks\/4917\/?version=5"
                    },
                    "Employee":
                    {
                        "ID":"111",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/111\/?version=5"
                    },
                    "Date":"2011-06-01",
                    "StartTime":"0800",
                    "StopTime":"1000",
                    "TotalHours":"2",
                    "Description":"",
                    "Billable":"T",
                    "Charge":"0",
                    "ChargeCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTCharge":"1",
                    "Wage":"0",
                    "WageCurrency":
                    {
                        "ID":"0",
                        "Symbol":"",
                        "GetItemURI":"N\/A"
                    },
                    "OTWage":"1",
                    "Prorate":"0",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1f7c9131-1982-4ab3-978f-5d8955754446",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=5"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 

Fields

TimeEntries (will return one TimeEntry object for the TimeEntry that was PUT)


Fields for TimeEntry

ID (long or Guid - 1st character of the ID indicates the type of data ('T' for TempTrans/unapproved time which means the ID is a Guid, 'M' for Trans/approved time which means the ID is a long))
Sheet (object containing information about the Sheet this time entry is a part of)
Client (object containing information about the Client this project is assigned to)
Project (object containing information about the Project this time entry is assigned to)
Task (object containing information about the Task this time entry is assigned to)
Employee (object containing information about the Employee this time entry is assigned to)
Date (string - in the format yyyy-MM-dd)
StartTime (string - in the format HHmm)
StopTime (string - in the format HHmm)
TotalHours (double - US English format)
Description (string)
Billable (string - 'T' or 'F')
Charge (double - US English format)
ChargeCurrency (object containing information about the Charge Currency specified for the current item)
OTCharge (the Overtime Charge prorating)
Wage (double - US English format)
WageCurrency (object containing information about the Wage Currency specified for the current item)
OTWage (the Overtime Wage prorating)
Prorate (double - US English format)
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)

NOTE: - The Charge field will be empty if the logged in user does not have Client Cost security access
- The Wage field will be empty if the logged in user does not have Company Cost security access
- The Charge, Wage, and Prorate fields will hold a value of 0 for unapproved time entry records because unapproved time entry records do not have this data associated with them.


Fields for Sheet

ID (long - will be 0 if there is no sheet which is the case with approved time or time that has not yet been submitted)
Status (string - the status of the sheet. possible values are: A (approved), N (not submitted), U (under review), or R (rejected))
RejectedReason (string - empty if the sheet's status is not R. If the sheet's status is R, this will hold the reason why the sheet was rejected)


Fields for Client

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the client)

NOTE: The ID will be 0 and the URI 'N/A' if the project is not assigned to a client


Fields for Project

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the project)


Fields for Task

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the task)


Fields for Employee

ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


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.
- The ID will be 0 and the URI field set to 'N/A' for unapproved time entry records because they do not have this data associated with them.


Fields for CustomField

ID (long/Guid - a long if the time entry is an approved time entry (status is A). A Guid if the time entry is not yet approved.)
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)




Delete


DELETE TimeEntries/{sTimeEntryID}/

Deletes the Time Entry specified.

Security Check:
The user must have Software Access set to 'All' or 'Time and Expense Entry only' and have Delete permissions to the 'Time Calendar' view or Access to the 'Timesheet - Time Entry' tool.
Example XML request:
 
        URI: https://api.dovico.com/TimeEntries/{TimeEntryID}/?version=5
        Method: DELETE
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/39c56492-d85f-4cf5-b45d-91046324de18/?version=5" --request DELETE -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/TimeEntries/{TimeEntryID}/?version=5
        Method: DELETE
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/TimeEntries/39c56492-d85f-4cf5-b45d-91046324de18/?version=5" --request DELETE -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
[Nothing is returned]
 
Example JSON response:
[Nothing is returned]