Projects



Important note about API versions

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


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

This call has been updated to reflect the 6th version of the API
The original Project calls can be found using the following links
version 1 and 2
version 3
version 5

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


GET Projects/

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

Security Check:
The user must have Software Access set to All and have Read access to the Projects view. Data will also be restricted based on limited access settings.
Example XML request:
 
        URI: https://api.dovico.com/Projects/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Projects>
                <Project>
                    <ID>1300</ID>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Name>Development Project: A-211</Name>
                    <Leader>
                        <ID>1154</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/1154/?version=6</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>1</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <ProjectObjective>0</ProjectObjective>
                    <BillingBy>3</BillingBy>
                    <BillingByProjectRate>0</BillingByProjectRate>
                    <FixedCosts>
                        <FixedCost>
                            <ID>110</ID>
                            <Amount>34</Amount>
                            <StartDate>2011-01-01</StartDate>
                            <EndDate>2012-01-01</EndDate>
                            <BudgetRateDate>2011-01-01</BudgetRateDate>
                            <Description></Description>
                            <Billed>F</Billed>
                        </FixedCost>
                        <FixedCost>
                            ...
                        </FixedCost>
                    </FixedCosts>
                    <BudgetedHoursType>0</BudgetedHoursType>
                    <BudgetedHoursProjectHours>0</BudgetedHoursProjectHours>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <ExpensesBillableByDefault>T</ExpensesBillableByDefault>
                    <Linked>F</Linked>
                    <MSPConfig></MSPConfig>
                    <RSProject>F</RSProject>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
                <Project>
                    ...
                </Project>
            </Projects>
            <PrevPageURI>https://api.dovico.com/Projects/?prev=1300&version=6</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Projects/?next=1374&version=6</NextPageURI>
        </Result>


Fields for Result
Projects (will return zero or more Project 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 Project
ID (long)
Client (node containing information about the Client this project is assigned to)
Name (string)
Leader (node containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (node containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty node if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this node will contain one or more FixedCost nodes)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (node containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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

Example JSON response:
 
        {
        "Projects":
            [
                {
                    "ID":"1300",
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Name":"Development Project: A-211",
                    "Leader":
                    {
                        "ID":"1154",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/1154\/?version=6"
                    },
                    "Description":"",
                    "Status":"1",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "ProjectObjective":"0",
                    "BillingBy":"3",
                    "BillingByProjectRate":"0",
                    "FixedCosts":
                    [
                        {
                            "ID":"110",
                            "Amount":"34",
                            "StartDate":"2011-01-01",
                            "EndDate":"2012-01-01",
                            "BudgetRateDate":"2011-01-01",
                            "Description":"",
                            "Billed":"F"
                        },
                        {
                            ...
                        }
                    ],
                    "BudgetedHoursType":"0",
                    "BudgetedHoursProjectHours":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "ExpensesBillableByDefault":"T",
                    "Linked":"F",
                    "MSPConfig":"",
                    "RSProject":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Projects\/?prev=1300&version=6",
        "NextPageURI":"https:\/\/api.dovico.com\/Projects\/?next=1374&version=6"
        }


Fields
Projects (will return zero or more Project 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 Project
ID (long)
Client (object containing information about the Client this project is assigned to)
Name (string)
Leader (object containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (object containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty array if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this array will contain one or more FixedCost objects)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (object containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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





Get a Project


GET Projects/{sProjectID}/

Returns the Project requested.

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

Example XML request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Projects>
                <Project>
                    <ID>1300</ID>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Name>Development Project: A-211</Name>
                    <Leader>
                        <ID>1154</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/1154/?version=6</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>1</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <ProjectObjective>0</ProjectObjective>
                    <BillingBy>3</BillingBy>
                    <BillingByProjectRate>0</BillingByProjectRate>
                    <FixedCosts>
                        <FixedCost>
                            <ID>110</ID>
                            <Amount>34</Amount>
                            <StartDate>2011-01-01</StartDate>
                            <EndDate>2012-01-01</EndDate>
                            <BudgetRateDate>2011-01-01</BudgetRateDate>
                            <Description></Description>
                            <Billed>F</Billed>
                        </FixedCost>
                        <FixedCost>
                            ...
                        </FixedCost>
                    </FixedCosts>
                    <BudgetedHoursType>0</BudgetedHoursType>
                    <BudgetedHoursProjectHours>0</BudgetedHoursProjectHours>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <ExpensesBillableByDefault>T</ExpensesBillableByDefault>
                    <Linked>F</Linked>
                    <MSPConfig></MSPConfig>
                    <RSProject>F</RSProject>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
            </Projects>
        </Result>
Fields for Result
Projects (will return zero Project nodes if the requested item does not exist. Will return one Project node if the requested item does exist)



Fields for Project
ID (long)
Client (node containing information about the Client this project is assigned to)
Name (string)
Leader (node containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (node containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty node if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this node will contain one or more FixedCost nodes)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (node containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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

Example JSON response:
 
        {
        "Projects":
            [
                {
                    "ID":"1300",
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Name":"Development Project: A-211",
                    "Leader":
                    {
                        "ID":"1154",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/1154\/?version=6"
                    },
                    "Description":"",
                    "Status":"1",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "ProjectObjective":"0",
                    "BillingBy":"3",
                    "BillingByProjectRate":"0",
                    "FixedCosts":
                    [
                        {
                            "ID":"110",
                            "Amount":"34",
                            "StartDate":"2011-01-01",
                            "EndDate":"2012-01-01",
                            "BudgetRateDate":"2011-01-01",
                            "Description":"",
                            "Billed":"F"
                        },
                        {
                            ...
                        }
                    ],
                    "BudgetedHoursType":"0",
                    "BudgetedHoursProjectHours":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "ExpensesBillableByDefault":"T",
                    "Linked":"F",
                    "MSPConfig":"",
                    "RSProject":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

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



Fields for Project
ID (long)
Client (object containing information about the Client this project is assigned to)
Name (string)
Leader (object containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (object containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty array if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this array will contain one or more FixedCost objects)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (object containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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




Get Project Statistics


GET Projects/{sProjectID}/Statistics/

Returns the statistics for Project requested.

Security Check:
The user must have Software Access set to All and have Read access to the Projects view. Data will also be restricted based on limited access settings.
Example XML request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/Statistics/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/Statistics/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/Statistics/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/Statistics/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Hours>
                <Actual>139.75</Actual>
                <Budget>100</Budget>
                <Percent>139.75</Percent>
            </Hours>
            <CompanyCost>
                <Actual>2792.82</Actual>
                <Budget>5000</Budget>
                <Percent>55.86</Percent>
                <Currency>
                    <ID>280</ID>
                    <Symbol>USD $</Symbol>
                    <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                </Currency>
            </CompanyCost>
            <ClientCost>
                <Actual>8200.49</Actual>
                <Budget>15625</Budget>
                <Percent>52.48</Percent>
                <Currency>
                    <ID>280</ID>
                    <Symbol>USD $</Symbol>
                    <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                </Currency>
            </ClientCost>
            <BillableHours>
                <Billable>139.75</Billable>
                <NonBillable>0</NonBillable>
                <Percent>100</Percent>
            </BillableHours>
        </Result>
Fields for Result
Hours (node containing the Hour information)
CompanyCost (node containing the Company Cost information)
ClientCost (node containing the Client Cost information)
BillableHours (node containing the Billable Hours information)


Fields for Hours
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)


Fields for CompanyCost
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)
Currency (node containing information about the Currency used for the current item)

NOTE: The Actual, Budget, Percent, and Currency fields will be 'N/A' if the logged in user does not have Company Cost security access


Fields for ClientCost
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)
Currency (node containing information about the Currency used for the current item)

NOTE: The Actual, Budget, Percent, and Currency fields will be 'N/A' if the logged in user does not have Client Cost security access


Fields for BillableHours
Billable (double - US English format)
NonBillable (double - US English format)
Percent (double - US English format - 'N/A' if total is 0)


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

Example JSON response:
 
        {
            "Hours":
            {
                "Actual":"139.75",
                "Budget":"100",
                "Percent":"139.75"
            },
            "CompanyCost":
            {
                "Actual":"2792.82",
                "Budget":"5000",
                "Percent":"55.86",
                "Currency":
                {
                    "ID":"280",
                    "Symbol":"USD $",
                    "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                }
            },
            "ClientCost":
            {
                "Actual":"8200.49",
                "Budget":"15625",
                "Percent":"52.48",
                "Currency":
                {
                    "ID":"280",
                    "Symbol":"USD $",
                    "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                }
            },
            "BillableHours":
            {
                "Billable":"139.75",
                "NonBillable":"0",
                "Percent":"100"
            }
        }
Fields
Hours (object containing the Hour information)
CompanyCost (object containing the Company Cost information)
ClientCost (object containing the Client Cost information)
BillableHours (object containing the Billable Hours information)


Fields for Hours
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)


Fields for CompanyCost
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)
Currency (object containing information about the Currency used for the current item)

NOTE: The Actual, Budget, Percent, and Currency fields will be 'N/A' if the logged in user does not have Company Cost security access


Fields for ClientCost
Actual (double - US English format)
Budget (double - US English format)
Percent (double - US English format - 'N/A' if Budget is 0)
Currency (object containing information about the Currency used for the current item)

NOTE: The Actual, Budget, Percent, and Currency fields will be 'N/A' if the logged in user does not have Client Cost security access


Fields for BillableHours
Billable (double - US English format)
NonBillable (double - US English format)
Percent (double - US English format - 'N/A' if total is 0)


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






Get Project Expense Totals


GET Projects/{sProjectID}/ExpenseTotals/

Returns the expense totals for Project requested.

Security Check:
The user must have Software Access set to All and have Read access to the 'Approved Expenses' view in order to receive the actual expense data. Must have Read access to the 'Budgeted Expenses' view in order to receive the budget expense data. Data will also be restricted based on limited access settings.

Example XML request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/ExpenseTotals/?version=6
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/ExpenseTotals/?version=6" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/ExpenseTotals/?version=6
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/ExpenseTotals/?version=6" -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <ActualClientCost>978.58</ActualClientCost>
            <ActualCompanyCost>658.41</ActualCompanyCost>
            <Budget>5000</Budget>
            <Currency>
                <ID>280</ID>
                <Symbol>USD $</Symbol>
                <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
            </Currency>
        </Result>

Fields for Result
ActualClientCost (double - US English format)
ActualCompanyCost (double - US English format)
Budget (double - US English format)
Currency (node containing information about the Currency used for the calculations)

NOTE: - The ActualClientCost will be 'N/A' if the logged in user does not have Client Cost security access or does not have Read access to the Approved Expenses view
- The ActualCompanyCost will be 'N/A' if the logged in user does not have Company Cost security access or does not have Read access to the Approved Expenses view
- The Budget will be 'N/A' if the logged in user does not have Read access to the Budgeted Expenses view


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


Example JSON response:
 
        {
            "ActualClientCost":"978.58",
            "ActualCompanyCost":"658.41",
            "Budget":"5000",
            "Currency":
            {
                "ID":"280",
                "Symbol":"USD $",
                "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
            }
        }

Fields
ActualClientCost (double - US English format)
ActualCompanyCost (double - US English format)
Budget (double - US English format)
Currency (object containing information about the Currency used for the calculations)

NOTE: - The ActualClientCost will be 'N/A' if the logged in user does not have Client Cost security access or does not have Read access to the Approved Expenses view
- The ActualCompanyCost will be 'N/A' if the logged in user does not have Company Cost security access or does not have Read access to the Approved Expenses view
- The Budget will be 'N/A' if the logged in user does not have Read access to the Budgeted Expenses view

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




Insert


POST Projects/

Creates the Projects specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Projects/?version=6
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=6" --request POST -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Projects><Project><Name>Development Project: A-211</Name></Project></Projects>"
Fields for Projects
*Project (required - at least one Project node is required but more than one can be provided)


Fields for Project
ClientID (optional - long - must be a valid client id)
*Name (required - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - zero or more CustomField nodes)


Fields for FixedCost
*ID (required - long - specify -1 in this case)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


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

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


Fields for Project
ClientID (optional - long - must be a valid client id)
*Name (required - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
CustomFields (optional - an array of zero or more CustomField objects)


Fields for FixedCost
*ID (required - long - specify -1 in this case)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


Fields for Value
Value (optional - string, date, or double depending on the Custom Template's type)
Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Projects>
                <Project>
                    <ID>1300</ID>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Name>Development Project: A-211</Name>
                    <Leader>
                        <ID>1154</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/1154/?version=6</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>1</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <ProjectObjective>0</ProjectObjective>
                    <BillingBy>3</BillingBy>
                    <BillingByProjectRate>0</BillingByProjectRate>
                    <FixedCosts>
                        <FixedCost>
                            <ID>110</ID>
                            <Amount>34</Amount>
                            <StartDate>2011-01-01</StartDate>
                            <EndDate>2012-01-01</EndDate>
                            <BudgetRateDate>2011-01-01</BudgetRateDate>
                            <Description></Description>
                            <Billed>F</Billed>
                        </FixedCost>
                        <FixedCost>
                            ...
                        </FixedCost>
                    </FixedCosts>
                    <BudgetedHoursType>0</BudgetedHoursType>
                    <BudgetedHoursProjectHours>0</BudgetedHoursProjectHours>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <ExpensesBillableByDefault>T</ExpensesBillableByDefault>
                    <Linked>F</Linked>
                    <MSPConfig></MSPConfig>
                    <RSProject>F</RSProject>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
            </Projects>
        </Result>
Fields for Result
Projects (will return zero Project nodes if the requested item does not exist. Will return one Project node if the requested item does exist)



Fields for Project
ID (long)
Client (node containing information about the Client this project is assigned to)
Name (string)
Leader (node containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (node containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty node if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this node will contain one or more FixedCost nodes)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (node containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


Fields for CustomField's Values node
Value (string, date, or double - based on the custom template's type)
Example JSON response:
 
        {
        "Projects":
            [
                {
                    "ID":"1300",
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Name":"Development Project: A-211",
                    "Leader":
                    {
                        "ID":"1154",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/1154\/?version=6"
                    },
                    "Description":"",
                    "Status":"1",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "ProjectObjective":"0",
                    "BillingBy":"3",
                    "BillingByProjectRate":"0",
                    "FixedCosts":
                    [
                        {
                            "ID":"110",
                            "Amount":"34",
                            "StartDate":"2011-01-01",
                            "EndDate":"2012-01-01",
                            "BudgetRateDate":"2011-01-01",
                            "Description":"",
                            "Billed":"F"
                        },
                        {
                            ...
                        }
                    ],
                    "BudgetedHoursType":"0",
                    "BudgetedHoursProjectHours":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "ExpensesBillableByDefault":"T",
                    "Linked":"F",
                    "MSPConfig":"",
                    "RSProject":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

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


Fields for Project
ID (long)
Client (object containing information about the Client this project is assigned to)
Name (string)
Leader (object containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (object containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty array if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this array will contain one or more FixedCost objects)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (object containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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





Update (bulk)


PUT Projects/

Updates the Projects specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Projects/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Projects><Project><ID>1300</ID><Name>Development Project: A-211</Name></Project></Projects>"

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


Fields for Project
*ID (required - long - the ID of the project record to update)
ClientID (optional - long - must be a valid client id)
Name (optional - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

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 FixedCost
*ID (required - long - must be a valid FixedCost id or -1 if this is a new FixedCost item)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


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

Example JSON request:
 
        URI: https://api.dovico.com/Projects/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "[{""ID"":""1300"",""Name"":""Development Project: A-211""}]"

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


Fields for Project
*ID (required - long - the ID of the project record to update)
ClientID (optional - long - must be a valid client id)
Name (optional - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

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 FixedCost
*ID (required - long - must be a valid FixedCost id or -1 if this is a new FixedCost item)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


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

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Projects>
                <Project>
                    <ID>1300</ID>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Name>Development Project: A-211</Name>
                    <Leader>
                        <ID>1154</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/1154/?version=6</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>1</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <ProjectObjective>0</ProjectObjective>
                    <BillingBy>3</BillingBy>
                    <BillingByProjectRate>0</BillingByProjectRate>
                    <FixedCosts>
                        <FixedCost>
                            <ID>110</ID>
                            <Amount>34</Amount>
                            <StartDate>2011-01-01</StartDate>
                            <EndDate>2012-01-01</EndDate>
                            <BudgetRateDate>2011-01-01</BudgetRateDate>
                            <Description></Description>
                            <Billed>F</Billed>
                        </FixedCost>
                        <FixedCost>
                            ...
                        </FixedCost>
                    </FixedCosts>
                    <BudgetedHoursType>0</BudgetedHoursType>
                    <BudgetedHoursProjectHours>0</BudgetedHoursProjectHours>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <ExpensesBillableByDefault>T</ExpensesBillableByDefault>
                    <Linked>F</Linked>
                    <MSPConfig></MSPConfig>
                    <RSProject>F</RSProject>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
            </Projects>
        </Result>
Fields for Result
Projects (will return zero Project nodes if the requested item does not exist. Will return one Project node if the requested item does exist)



Fields for Project
ID (long)
Client (node containing information about the Client this project is assigned to)
Name (string)
Leader (node containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (node containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty node if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this node will contain one or more FixedCost nodes)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (node containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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

Example JSON response:
 
        {
        "Projects":
            [
                {
                    "ID":"1300",
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Name":"Development Project: A-211",
                    "Leader":
                    {
                        "ID":"1154",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/1154\/?version=6"
                    },
                    "Description":"",
                    "Status":"1",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "ProjectObjective":"0",
                    "BillingBy":"3",
                    "BillingByProjectRate":"0",
                    "FixedCosts":
                    [
                        {
                            "ID":"110",
                            "Amount":"34",
                            "StartDate":"2011-01-01",
                            "EndDate":"2012-01-01",
                            "BudgetRateDate":"2011-01-01",
                            "Description":"",
                            "Billed":"F"
                        },
                        {
                            ...
                        }
                    ],
                    "BudgetedHoursType":"0",
                    "BudgetedHoursProjectHours":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "ExpensesBillableByDefault":"T",
                    "Linked":"F",
                    "MSPConfig":"",
                    "RSProject":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

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



Fields for Project
ID (long)
Client (object containing information about the Client this project is assigned to)
Name (string)
Leader (object containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (object containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty array if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this array will contain one or more FixedCost objects)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (object containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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






Update


PUT Projects/{sProjectID}/

Updates the Project specified.

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

Example XML request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/?version=6
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=6" --request PUT -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: text/xml" --data "<Project><Name>Development Project: A-211</Name></Project>"

Fields for Project
ClientID (optional - long - must be a valid client id)
Name (optional - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

NOTE: All fields are optional but at least one must be specified

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


Fields for FixedCost
*ID (required - long - must be a valid FixedCost id or -1 if this is a new FixedCost item)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


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

Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/?version=6
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=6" --request PUT -H "Accept: application/json" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593""" -H "Content-Type: application/json" --data "{""Name"":""Development Project: A-211""}"


Fields for Project
ClientID (optional - long - must be a valid client id)
Name (optional - string with a maximum length of 250 characters)
LeaderID (optional - long - must be a valid employee id)
Description (optional - string with a maximum length of 250 characters)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
ProjectObjective (optional - integer - Available values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (optional - integer indicating the project's Billing method. Available values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
*BillingByProjectRate (required if BillingBy is 2 (project hourly) - double in US English format)
*FixedCosts (required if BillingBy is 3 (fixed project amount) - one or more FixedCost nodes)
BudgetedHoursType (optional - integer indicating how the project's budget should be calculated. Available values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
*BudgetedHoursProjectHours (required if BudgetedHoursType is 2 (project budgeted hours) - double in US English format)
CurrencyID (optional - long - must be an enabled currency)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
HideTasks (optional - string 'T' or 'F')
ExpensesBillableByDefault (optional - string 'T' or 'F')
Linked (optional - string 'T' or 'F')
MSPConfig (optional - string with a maximum length of 1000 characters)
Archive (optional - string 'T' or 'F')
Integrate (optional - string of XML. If specified, do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)

NOTE: All fields are optional but at least one must be specified

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


Fields for FixedCost
*ID (required - long - must be a valid FixedCost id or -1 if this is a new FixedCost item)
*Amount (required - double in US English format)
StartDate (optional - date string in the format yyyy-MM-dd. StartDate must be on or before EndDate)
EndDate (optional - date string in the format yyyy-MM-dd. EndDate must be on or after StartDate)
BudgetRateDate (optional - date string in the format yyyy-MM-dd)
Description (optional - string with a maximum length of 250 characters)
Billed (optional - string 'T' or 'F')


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


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

Example XML response:
 
        <Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <Projects>
                <Project>
                    <ID>1300</ID>
                    <Client>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </Client>
                    <Name>Development Project: A-211</Name>
                    <Leader>
                        <ID>1154</ID>
                        <Name>Smith, John</Name>
                        <GetItemURI>https://api.dovico.com/Employees/1154/?version=6</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>1</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <ProjectObjective>0</ProjectObjective>
                    <BillingBy>3</BillingBy>
                    <BillingByProjectRate>0</BillingByProjectRate>
                    <FixedCosts>
                        <FixedCost>
                            <ID>110</ID>
                            <Amount>34</Amount>
                            <StartDate>2011-01-01</StartDate>
                            <EndDate>2012-01-01</EndDate>
                            <BudgetRateDate>2011-01-01</BudgetRateDate>
                            <Description></Description>
                            <Billed>F</Billed>
                        </FixedCost>
                        <FixedCost>
                            ...
                        </FixedCost>
                    </FixedCosts>
                    <BudgetedHoursType>0</BudgetedHoursType>
                    <BudgetedHoursProjectHours>0</BudgetedHoursProjectHours>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=6</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <ExpensesBillableByDefault>T</ExpensesBillableByDefault>
                    <Linked>F</Linked>
                    <MSPConfig></MSPConfig>
                    <RSProject>F</RSProject>
                    <Archive>F</Archive>
                    <Integrate></Integrate>
                    <CustomFields>
                        <CustomField>
                            <ID>1631</ID>
                            <TemplateID>148</TemplateID>
                            <Name>Date of Birth</Name>
                            <Values>
                                <Value>1967-12-31</Value>
                            </Values>
                            <GetCustomTemplateURI>https://api.dovico.com/CustomFieldTemplates/148/?version=6</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
            </Projects>
        </Result>
Fields for Result
Projects (will return zero Project nodes if the requested item does not exist. Will return one Project node if the requested item does exist)



Fields for Project
ID (long)
Client (node containing information about the Client this project is assigned to)
Name (string)
Leader (node containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (node containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty node if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this node will contain one or more FixedCost nodes)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (node containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField nodes)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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


Example JSON response:
 
        {
        "Projects":
            [
                {
                    "ID":"1300",
                    "Client":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "Name":"Development Project: A-211",
                    "Leader":
                    {
                        "ID":"1154",
                        "Name":"Smith, John",
                        "GetItemURI":"https:\/\/api.dovico.com\/Employees\/1154\/?version=6"
                    },
                    "Description":"",
                    "Status":"1",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "ProjectObjective":"0",
                    "BillingBy":"3",
                    "BillingByProjectRate":"0",
                    "FixedCosts":
                    [
                        {
                            "ID":"110",
                            "Amount":"34",
                            "StartDate":"2011-01-01",
                            "EndDate":"2012-01-01",
                            "BudgetRateDate":"2011-01-01",
                            "Description":"",
                            "Billed":"F"
                        },
                        {
                            ...
                        }
                    ],
                    "BudgetedHoursType":"0",
                    "BudgetedHoursProjectHours":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=6"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "ExpensesBillableByDefault":"T",
                    "Linked":"F",
                    "MSPConfig":"",
                    "RSProject":"F",
                    "Archive":"F",
                    "Integrate":"",
                    "CustomFields":
                    [
                        {
                            "ID":"1631",
                            "TemplateID":"148",
                            "Name":"Date of Birth",
                            "Values":
                            [
                                "1967-12-31"
                            ],
                            "GetCustomTemplateURI":"https:\/\/api.dovico.com\/CustomFieldTemplates\/148\/?version=6"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }


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



Fields for Project
ID (long)
Client (object containing information about the Client this project is assigned to)
Name (string)
Leader (object containing information about the Employee this project is lead by - The Project's Manager or Team Lead)
Description (string)
Status (integer - Possible values are: 0 (budget), 1 (active), or 2 (completed))
ProjectGroup (object containing information about the Project Group associated with this project)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
ProjectObjective (integer - Possible values are: 0 (track time only), 1 (track time for costing), 2 (track time for billing), or 3 (track time for costing and billing))
BillingBy (integer - Possible values are: 0 (employee hourly), 1 (task hourly), 2 (project hourly), or 3 (fixed project amount))
BillingByProjectRate (double - US English format)
FixedCosts (will be an empty array if BillingBy is not 3 (fixed project amount). If BillingBy is 3, this array will contain one or more FixedCost objects)
BudgetedHoursType (integer - Possible values are: 0 (no budget), 1 (budgeted hours per task), or 2 (project budgeted hours))
BudgetedHoursProjectHours (double - US English format)
Currency (object containing information about the Currency specified for the current item)
BudgetRateDate (string - in the format yyyy-MM-dd)
HideTasks (string - 'T' or 'F')
ExpensesBillableByDefault (string - 'T' or 'F')
Linked (string - 'T' or 'F')
MSPConfig (string)
RSProject (string - 'T' or 'F')
Archive (string - 'T' or 'F')
Integrate (string of XML)
CustomFields (will return zero or more CustomField objects)


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 Leader
ID (long)
Name (string)
GetItemURI (string - URI to pull information about the employee)

NOTE: The ID will be 0 and the URI 'N/A' if the project has no leader/manager set


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

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


Fields for FixedCost
ID (long)
Amount (double - US English format)
StartDate (string - in the format yyyy-MM-dd)
EndDate (string - in the format yyyy-MM-dd)
BudgetRateDate (string - in the format yyyy-MM-dd)
Description (string)
Billed (string - 'T' or 'F')


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


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


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