Projects (versions 1 and 2)



The page is an archive of the original Projects call released September 2011. It has been replaced by version 6


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. 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=2
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=2" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/?version=2
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=2" -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=2</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>A</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <BillingBy>A</BillingBy>
                    <FixedCost>0</FixedCost>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=2</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <PreventEntries>F</PreventEntries>
                    <TimeBillableByDefault>T</TimeBillableByDefault>
                    <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=2</GetCustomTemplateURI>
                        </CustomField>
                        <CustomField>
                            ...
                        </CustomField>
                    </CustomFields>
                </Project>
                <Project>
                    ...
                </Project>
            </Projects>
            <PrevPageURI>https://api.dovico.com/Projects/?prev=1300&version=2</PrevPageURI>
            <NextPageURI>https://api.dovico.com/Projects/?next=1374&version=2</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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F) with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F) with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.


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 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=2"
                    },
                    "Description":"",
                    "Status":"A",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "BillingBy":"A",
                    "FixedCost":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=2"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "PreventEntries":"F",
                    "TimeBillableByDefault":"T",
                    "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=2"
                        },
                        {
                            ...
                        }
                    ]
                },
                {
                    ...
                }
            ],
        "PrevPageURI":"https:\/\/api.dovico.com\/Projects\/?prev=1300&version=2",
        "NextPageURI":"https:\/\/api.dovico.com\/Projects\/?next=1374&version=2"
        }
 

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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F), with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F), with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.

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 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=2
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=2" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/?version=2
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=2" -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=2</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>A</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <BillingBy>A</BillingBy>
                    <FixedCost>0</FixedCost>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=2</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <PreventEntries>F</PreventEntries>
                    <TimeBillableByDefault>T</TimeBillableByDefault>
                    <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=2</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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F) with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F) with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'


To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.


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 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=2"
                    },
                    "Description":"",
                    "Status":"A",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "BillingBy":"A",
                    "FixedCost":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=2"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "PreventEntries":"F",
                    "TimeBillableByDefault":"T",
                    "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=2"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 
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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F) with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F) with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.


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 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=2
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/Statistics/?version=2" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/Statistics/?version=2
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/Statistics/?version=2" -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=2</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=2</GetItemURI>
                </Currency>
            </ClientCost>
            <BillableHours>
                <Billable>139.75</Billable>
                <NonBillable>0</NonBillable>
                <Percent>100</Percent>
            </BillableHours>
            <HoursWithETC>
                <Actual>139.75</Actual>
                <Budget>100</Budget>
                <Remaining>-39.75</Remaining>
            </HoursWithETC>
        </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)
HoursWithETC (node containing the Hours with ETC 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 HoursWithETC
Actual (double - US English format)
Budget (double - US English format)
Remaining (double - US English format)


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=2"
                }
            },
            "ClientCost":
            {
                "Actual":"8200.49",
                "Budget":"15625",
                "Percent":"52.48",
                "Currency":
                {
                    "ID":"280",
                    "Symbol":"USD $",
                    "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=2"
                }
            },
            "BillableHours":
            {
                "Billable":"139.75",
                "NonBillable":"0",
                "Percent":"100"
            },
            "HoursWithETC":
            {
                "Actual":"139.75",
                "Budget":"100",
                "Remaining":"-39.75"
            }
        }
 


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)
HoursWithETC (object containing the Hours with ETC 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 HoursWithETC
Actual (double - US English format)
Budget (double - US English format)
Remaining (double - US English format)


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=2
        Method: GET
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/ExpenseTotals/?version=2" -H "Authorization: WRAP access_token=""client=36bb7f2f29474d88bf35c4a89cdcfb34.593&user_token=e7d1e55015ee4ecebe5298cb439344fd.593"""
 
 
Example JSON request:
 
        URI: https://api.dovico.com/Projects/{ProjectID}/ExpenseTotals/?version=2
        Method: GET
        Accept: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/ExpenseTotals/?version=2" -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=2</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=2"
            }
        }

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=2
        Method: POST
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=2" --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)
Status (optional - string indicating the project's status. Available values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (optional - string indicating the project's Billing method. Available values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (optional - 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')
PreventEntries (optional - string 'T' or 'F')
TimeBillableByDefault (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 encoded XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
CustomFields (optional - zero or more CustomField nodes)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Cost records are needed for the project, please use API version 3.

² If this is a Fixed Cost project (BillingBy is F), then the BudgetRateDate value is applied to the Fixed Cost item. If multiple Fixed Cost records are needed for the project, please use API version 3.

NOTE: - If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;


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=2
        Method: POST
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/?version=2" --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 for Projects
*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)
Status (optional - string indicating the project's status. Available values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (optional - string indicating the project's Billing method. Available values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (optional - 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')
PreventEntries (optional - string 'T' or 'F')
TimeBillableByDefault (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, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
CustomFields (optional - an array of zero or more CustomField objects)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Cost records are needed for the project, please use API version 3.

² If this is a Fixed Cost project (BillingBy is F), then the BudgetRateDate value is applied to the Fixed Cost item. If multiple Fixed Cost records are needed for the project, please use API version 3.


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=2</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>A</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <BillingBy>A</BillingBy>
                    <FixedCost>0</FixedCost>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=2</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <PreventEntries>F</PreventEntries>
                    <TimeBillableByDefault>T</TimeBillableByDefault>
                    <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=2</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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F) with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F) with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.



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 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=2"
                    },
                    "Description":"",
                    "Status":"A",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "BillingBy":"A",
                    "FixedCost":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=2"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "PreventEntries":"F",
                    "TimeBillableByDefault":"T",
                    "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=2"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }

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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F), with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F), with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.



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 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=2
        Method: PUT
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=2" --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)
Status (optional - string indicating the project's status. Available values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (optional - string indicating the project's Billing method. Available values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (optional - 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')
PreventEntries (optional - string 'T' or 'F')
TimeBillableByDefault (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 encoded XML. If specified, only one element is permitted but the element can contain child elements. Do not include a root INT element.)
DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - zero or more CustomField nodes)

NOTE: - If XML is provided for the Integrate field, the XML needs to be encoded. For example, < characters need to be replaced with &lt;
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.

¹ This is now depreciated. Please use API version 3.
- If this is a Fixed Cost project (BillingBy is F) and there is only one Fixed Cost item associated with the project then the FixedCost value specified will be updated without issue.
- If this is a Fixed Cost project (BillingBy is F) but there is more than one Fixed Cost item associated with the project an error will be returned if this value is specified. To update Fixed Cost amounts in the case, please use API version 3.

² - If this is a Fixed Cost project (BillingBy is F) and there is only on Fixed Cost item associated with the project then the BudgetRateDate value specified will be updated without issue.
- If this is a Fixed Cost project (BillingBy is F) but there is more than one Fixed Cost item associated with the project an error will be returned if this value is specified. To update Fixed Cost Budget Rate Dates in the case, please use API version 3.


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=2
        Method: PUT
        Accept: application/json
        Content-Type: application/json
 
        Sample request syntax using Win32 cURL:
        curl -k "https://api.dovico.com/Projects/1300/?version=2" --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 ProjectClientID (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)
Status (optional - string indicating the project's status. Available values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (optional - string indicating the project's Billing method. Available values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (optional - 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')
PreventEntries (optional - string 'T' or 'F')
TimeBillableByDefault (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, only one element is permitted but the element can contain child elements. Do not include a root INT element.)

DeleteIntegrateElement (optional - string containing the name of the element to be removed from the Integrate field)
CustomFields (optional - an array of zero or more CustomField objects)
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.

¹ This is now depreciated. Please use API version 3.
- If this is a Fixed Cost project (BillingBy is F) and there is only one Fixed Cost item associated with the project then the FixedCost value specified will be updated without issue.
- If this is a Fixed Cost project (BillingBy is F) but there is more than one Fixed Cost item associated with the project an error will be returned if this value is specified. To update Fixed Cost amounts in the case, please use API version 3.

² - If this is a Fixed Cost project (BillingBy is F) and there is only on Fixed Cost item associated with the project then the BudgetRateDate value specified will be updated without issue.
- If this is a Fixed Cost project (BillingBy is F) but there is more than one Fixed Cost item associated with the project an error will be returned if this value is specified. To update Fixed Cost Budget Rate Dates in the case, please use API version 3.


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=2</GetItemURI>
                    </Leader>
                    <Description></Description>
                    <Status>A</Status>
                    <ProjectGroup>
                        <ID>0</ID>
                        <Name>[None]</Name>
                        <GetItemURI>N/A</GetItemURI>
                    </ProjectGroup>
                    <StartDate>2011-01-01</StartDate>
                    <EndDate>2012-01-01</EndDate>
                    <BillingBy>A</BillingBy>
                    <FixedCost>0</FixedCost>
                    <Currency>
                        <ID>280</ID>
                        <Symbol>USD $</Symbol>
                        <GetItemURI>https://api.dovico.com/Currencies/280/?version=2</GetItemURI>
                    </Currency>
                    <BudgetRateDate>2011-01-01</BudgetRateDate>
                    <HideTasks>F</HideTasks>
                    <PreventEntries>F</PreventEntries>
                    <TimeBillableByDefault>T</TimeBillableByDefault>
                    <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=2</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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F) with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F) with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.


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 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=2"
                    },
                    "Description":"",
                    "Status":"A",
                    "ProjectGroup":
                    {
                        "ID":"0",
                        "Name":"[None]",
                        "GetItemURI":"N\/A"
                    },
                    "StartDate":"2011-01-01",
                    "EndDate":"2012-01-01",
                    "BillingBy":"A",
                    "FixedCost":"0",
                    "Currency":
                    {
                        "ID":"280",
                        "Symbol":"USD $",
                        "GetItemURI":"https:\/\/api.dovico.com\/Currencies\/280\/?version=2"
                    },
                    "BudgetRateDate":"2011-01-01",
                    "HideTasks":"F",
                    "PreventEntries":"F",
                    "TimeBillableByDefault":"T",
                    "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=2"
                        },
                        {
                            ...
                        }
                    ]
                }
            ]
        }
 

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 (string - Possible values are: E (estimate), Q (quotation), A (active), R (rejected), T (terminated), or F (finished))
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)
BillingBy (string - Possible values are: E (estimated hours), A (actual hours), or F (fixed cost))
¹ FixedCost (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')
PreventEntries (string - 'T' or 'F')
TimeBillableByDefault (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)

¹ This is now depreciated. Please use API version 3.
If multiple Fixed Costs were defined for a project, this returns the sum of all Fixed Cost amounts for the project. To receive the individual Fixed Cost values specify version 3 in the version query string.

² - BudgetRateDate will be the project's BudgetRateDate for non-Fixed Cost projects (BillingBy will be either E or A)
- For Fixed Cost projects (BillingBy will be F), with only one Fixed Cost defined, BudgetRateDate will be the BudgetRateDate of the Fixed Cost item
- For Fixed Cost projects (BillingBy will be F), with more than one Fixed Cost defined, BudgetRateDate will return 'N/A'

To receive the individual BudgetRateDate values of each Fixed Cost item specify version 3 in the version query string.





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 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)