API – Timewax Docs

API#

The API is available at https://api.timewax.com.

The API is realized as an http(s) service which by a POST request sends data to the xml Timewax server. Based on this request XML data is returned. Each service has its own URL and request and response definition. All services are authorized based on a token. The token is obtained using the Timewax credentials. This token is valid for 60 minutes and during that period it can be used for various services.

Requests are subject to rate limiting. For the limits and best practices to handle requests, read this support article.

Token#

authentication/token/get#

Service
https://api.timewax.com/authentication/token/get/

Purpose
Obtain a token for the authentication of api services

Request
The following xml structure must be provided:

<request>
    <client></client>
    <username></username>
    <password></password>
</request>

Parameter	Description	Required
client	Client environment. The client environment name can be found on the start page in the top right menu. Click on settings and you will see the User name – Client name.	yes
username	API ID. This ID can be found in Masters > Resources > Resource – Data Security	yes
password	The password of the user	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <token></token>
    <validUntil></validUntil>
</response>

Parameter	Description
valid	Indication that service was executed successfully
token	The obtained token
validUntil	The token is valid until

The following xml structure is received after an incorrect execution:

<response>
    <valid>no</valid>
    <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Client#

company/add#

Service
https://api.timewax.com/company/add/

Purpose
Add new clients

Request
The following xml structure must be provided:

<request>
    <token></token>
    <company>
        <code></code>
        <name></name>
        <contactPerson></contactPerson>
        <industry></industry>
        <type></type>
        <officeAttn></officeAttn>
        <officeAddress></officeAddress>
        <officePostcode></officePostcode>
        <officeCity></officeCity>
        <officeCountry></officeCountry>
        <telephone></telephone>
        <VATNumber></VATNumber>
        <website></website>
        <notes></notes>
    </company>
</request>

Parameter	Description	Required
token	Token for this request	yes
company/code	Code of the client	yes
company/name	Name of the client	yes
company/contactPerson	Account manager of the client (name or code of the resource)	no
company/industry	Industry (field list value)	no
company/type	Type (field list value)	no
company/officeAttn	Attention of	no
company/officeAddress	Address	no
company/officePostcode	Postal code	no
company/officeCity	City	no
company/officeCountry	Country	no
company/telephone	Telephone number	no
company/VATNumber	VAT number	no
company/website	URL website	no
company/notes	Remarks	no

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response>
    <valid>no</valid>
    <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

company/get#

Service
https://api.timewax.com/company/get/

Purpose
Retrieve all the data of a client

Request
The following xml structure must be provided:

<request>
    <token></token>
    <company></company>
</request>

Parameter	Description	Required
token	Token for this request	yes
company	Code or name of the client	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <company>
        <code></code>
        <name></name>
        <contactPerson></contactPerson>
        <industry></industry>
        <type></type>
        <officeAttn></officeAttn>
        <officeAddress></officeAddress>
        <officePostcode></officePostcode>
        <officeCity></officeCity>
        <officeRegion></officeRegion>
        <officeCountry></officeCountry>
        <telephone></telephone>
        <vatNumber></vatNumber>
        <website></website>
        <notes></notes>
        <isActive></isActive>
    </company>
</response>

Parameter	Description
token	Token for this request
company/code	Code
company/Name	Name
company/contactPerson	Internal contact (resource) for the client
company/industry	Industry (field list value)
company/type	Type (field list value)
company/officeAttn	For the attention of
company/officeAddress	Address
company/officePostcode	Postal code
company/officeCity	City
company/officeCountry	Country
company/telephone	Telephone
company/VATNumber	VAT number
company/website	URL website
company/notes	Remarks
company/isActive	Yes or No. If the client is active or not

The following xml structure is received after an incorrect execution:

<response> 
    <valid>no</valid>
    <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

company/edit#

Service
https://api.timewax.com/company/edit/

Purpose
Update existing clients

Request
The following xml structure must be provided:

<request>
    <token></token>
    <company></company>
    <item>
        <code></code>
        <name></name>
        <active></active>
        <contactPerson></contactPerson>
        <industry></industry>
        <type></type>
        <officeAttn></officeAttn>
        <officeAddress></officeAddress>
        <officePostcode></officePostcode>
        <officeCity></officeCity>
        <officeCountry></officeCountry>
        <telephone></telephone>
        <VATNumber></VATNumber>
        <website></website>
        <notes></notes>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
company	Code or name of the client	yes
code	Code of the client	no
name	Name of the client	no
active	Yes or no. Marks if this company is active or not	no
contactPerson	Account manager of the client (name or code of the resource)	no
industry	Industry of the client (field list value)	no
type	Type of the client (field list value)	no
officeAttn	Attention of	no
officeAddress	Address	no
officePostcode	Postal code	no
officeCity	City	no
officeCountry	Country	no
telephone	Telephone number	no
VATNumber	VAT number	no
website	URL of company website	no
notes	Remarks	no

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

company/list#

Service

https://api.timewax.com/company/list/

Purpose
Retrieve a list with clients

Request
The following xml structure must be provided:

<request>
   <token></token>
</request>

Parameter	Description	Required
token	Token for this request	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <companies>
        <company>
            <code></code>
            <name></name>
            <isActive></isActive>
        </company>
    </companies>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
company/code	Code of the client
company/name	Name of the client
company/isActive	Yes or No. If the client is active or not

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

Project#

project/add#

Service
https://api.timewax.com/project/add/

Purpose
Create a new project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project>
        <code></code>
        <name></name>
        <useInvoicing></useInvoicing>
        <chargeable></chargeable>
        <approveTime></approveTime>
        <blockEntries></blockEntries>
        <isTemplate></isTemplate>
        <isActive></isActive>
        <startDate></startDate>
        <endDate></endDate>
        <notes></notes>
        <company></company>
        <organisationalUnit></organisationalUnit>
        <projectManager></projectManager>
        <backupProjectManager></backupProjectManager>
        <currency></currency>
        <parentProject></parentProject>
        <status></status>
        <color></color>
        <externalLinkFiles></externalLinkFiles>
        <emailContactPerson></emailContactPerson>
    </project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project/code	Code of the project	yes
project/name	Name of the project	yes
project/useInvoicing	Yes or No. Is this an invoiceable project?	no
project/chargeable	Yes or No. Is this project chargeable?	no
project/approveTime	Yes or No. Do submitted hours need to be approved?	no
project/blockEntries	Yes or No. Block bookings for planning and time sheets?	no
project/isTemplate	Yes or No. Can this project be used as a template for new projects?	no
project/isActive	Yes or No. Is the project active?	no
project/startDate	Start date of the project. Format yyyymmdd or yyyy-mm-dd	no
project/endDate	End date of the project. Format yyyymmdd or yyyy-mm-dd	no
project/notes	Remarks	no
project/company	Code or name of the client	yes
project/organisationalUnit	Code or name of the department	yes
project/projectManager	Code or name of the project manager	yes
project/backupProjectManager	Code or name of the backup project manager	no
project/currency	Project currency	yes
project/parentProject	Code or name of the parent project	no
project/status	Project status (field lists)	no
project/color	Project color (hexadecimal value)	no
project/externalLinkFiles	URL to an online file	no
project/emailContactPerson	Email of the (external) contact person	no

The following xml structure is received after an successful execution:

<response>
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response>
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/add_based_on_template#

Service
https://api.timewax.com/project/add_based_on_template/

Purpose
Create a new project based on a template

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project>
        <template></template>
        <code></code>
        <name></name>
        <company></company>
        <parentProject></parentProject>
        <organisationalUnit></organisationalUnit>
        <projectManager></projectManager>
        <generateProjectPlanning></generateProjectPlanning>
        <generateResourceRequests></generateResourceRequests>
        <startDate></startDate>
    </project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project/template	Code or name of the template project	yes
project/code	Code of the project	yes
project/name	Name of the project	yes
project/company	Code or name of the client	yes
project/parentProject	Code or name of the the parent project	no
project/organisationalUnit	Code or name of the department	yes
project/projectManager	Code or name of the project manager (resource)	yes
project/generateProjectPlanning	Yes or No. Copies the project planning from the template	no
project/generateResourceRequests	Yes or No. Adds request bookings based on the project planning	no
project/startDate	Start date of the project. Format yyyymmdd or yyyy-mm-dd

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/get#

Service
https://api.timewax.com/project/get/

Purpose
Retrieve all the data of a project

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Project code or name	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <project>
        <code></code>
        <name></name>
        <useInvoicing></useInvoicing>
        <chargeable></chargeable>
        <approveTime></approveTime>
        <orgUnitManagerIsApprover></orgUnitManagerIsApprover>
        <blockEntries></blockEntries>
        <isTemplate></isTemplate>
        <isActive></isActive>
        <startDate></startDate>
        <endDate></endDate>
        <notes></notes>
        <company></company>
        <companyCode></companyCode>
        <organisationalUnit></organisationalUnit>
        <organisationalUnitCode></organisationalUnitCode>
        <projectManager></projectManager>
        <backupProjectManager></backupProjectManager>
        <projectManagerCode></projectManagerCode>
        <currency></currency>
        <currencyCode></currencyCode>
        <parentProject></parentProject>
        <parentProjectCode></parentProjectCode>
        <status></status>
        <color></color>
        <externalLinkFiles></externalLinkFiles>
        <emailContactPerson></emailContactPerson>
        <portfolios>
            <code></code>
            <name></name>
        </portfolios>
    </project>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project/code	Code of the project
project/name	Name of the project
project/useInvoicing	Yes or No. Invoiceable project or not
project/chargeable	Yes or No. Chargeable project or not
project/approveTime	Yes or No. If hours need to be approved or not
project/orgUnitManagerIsApprover	Yes or No. If the department manager approves time sheets
project/blockEntries	Yes or No. Blocks new planning bookings and time sheets for this project
project/isTemplate	Yes or No. Determines if this project is a template
project/isActive	Yes or No. Determines if the project is active or not
project/startDate	Start date of the project. Format yyyymmdd or yyyy-mm-dd
project/endDate	End date of the project. Format yyyymmdd or yyyy-mm-dd
project/notes	Remarks about the project
project/company	The name of the client
project/companyCode	The code of the client
project/organisationalUnit	The name of the department
project/organisationalUnitCode	The code of the department
project/projectManager	The name of the project manager
project/backupProjectManager	The name of the backup project manager
project/projectManagerCode	The code of the project manager
project/currency	The name of the project currency
project/currencyCode	The code of the project currency
project/parentProject	The name of the parent project
project/parentProjectCode	The code of the parent project
project/status	Status of the project (field list value)
project/color	Color in hexadecimal value
project/externalLinkFiles	URL
project/emailContactPerson	Email of the external contact person of the project
portfolios/code	Code of the portfolio
portfolios/name	Name of the portfolio

The following xml structure is received after an incorrect execution:

<response>
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully.
error	Reason why the service has executed unsuccessfully.

project/list_changed#

Service
https://api.timewax.com/project/list_changed/

Purpose
Retrieve a list of all projects with changes in a specified date range

Request
The following xml structure must be provided:

<request>
    <token></token>
    <dateFrom></dateFrom>
    <dateTo></dateTo>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Add or modification date from. Format yyyymmdd or yyyy-mm-dd	yes
dateTo	Add or modification date to. Format yyyymmdd or yyyy-mm-dd	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <project>
        <code></code>
        <name></name>
    </project>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project/code	Code of the project
project/name	Name of the project

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/list_inactive#

Service
https://api.timewax.com/project/list_inactive/

Purpose
Retrieve a list with all inactive projects

Request
The following xml structure must be provided:

<request>
   <token></token>
</request>

Parameter	Description	Required
token	Token for this request	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <project>
        <code></code>
        <name></name>
    </project>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project/code	Code of the project
project/name	Name of the project

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/list#

Service

https://api.timewax.com/project/list/

Purpose
Retrieve a list with all projects

Request
The following xml structure must be provided:

<request>
   <token></token>
   <isParent></isParent>
   <isActive></isActive>
   <portfolio></portfolio>
</request>

Parameter	Description	Required
token	Token for this request	yes
isParent	Yes or No, selects only projects which are parent projects	no
isActive	Yes or No, selects only active projects	no
portfolio	Code or name of the portfolio	no

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <project>
        <code></code>
        <name></name>
    </project>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project/code	Code of the project
project/name	Name of the project

The following xml structure is received after an incorrect execution:

<response>
    <valid>no</valid>
    <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/edit#

Service
https://api.timewax.com/project/edit/

Purpose
Update an existing project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <item>
        <code></code>
        <name></name>
        <useInvoicing></useInvoicing>
        <approveTime></approveTime>
        <blockEntries></blockEntries>
        <isTemplate></isTemplate>
        <isActive></isActive>
        <startDate></startDate>
        <endDate></endDate>
        <notes></notes>
        <company></company>
        <organisationalUnit></organisationalUnit>
        <projectManager></projectManager>
        <currency></currency>
        <parentProject></parentProject>
        <status></status>
        <color></color>
        <externalLinkFiles></externalLinkFiles>
        <emailContactPerson></emailContactPerson>
    </item>
</request>

project/useInvoicingyes or no. Is it possible to invoice from this project?no

Parameter	Description	Required
token	Token for this request	yes
project	Code of the project to update	yes
project/code	Code of the project	yes
project/name	Name of the project	yes
project/approveTime	Yes or No. Do submitted hours need to be approved?	no
project/blockEntries	Yes or No. Blocks planning bookings and time sheets on the project	no
project/isTemplate	Yes or No. Can this project be used as a template for new projects?	no
project/isActive	Yes or No. Is the project active?	no
project/startDate	Start date of the project. Format yyyymmdd or yyyy-mm-dd	no
project/endDate	End date of the project. Format yyyymmdd or yyyy-mm-dd	no
project/notes	Remarks	no
project/company	Code or name of the client	yes
project/organisationalUnit	Code or name of the department	yes
project/projectManager	Code or name of the project manager (resource)	yes
project/currency	Project currency	yes
project/parentProject	Code or name of the parent project	no
project/status	Status (field list value)	no
project/color	Color in hexadecimal value	no
project/externalLinkFiles	URL	no
project/emailContactPerson	Email of the external contact person	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/remove#

Service
https://api.timewax.com/project/remove/

Purpose
Delete a project

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project/code	Code of the project	yes

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was not executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/activity/add#

Service
https://api.timewax.com/project/breakdown/add/

Purpose
Add new activities to a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <breakdowns>
        <breakdown>
            <code></code>
            <name></name>
            <parentBreakdown></parentBreakdown>
            <status></status>
            <plannedHours></plannedHours>
            <plannedRate></plannedRate>
            <rateIsCommercialRate></rateIsCommercialRate>
            <useNumbersInProgress></useNumbersInProgress>
            <budgetNumbers></budgetNumbers>
            <teamManager></teamManager>
            <isMilestone></isMilestone>
            <color></color>
            <blockPosting></blockPosting>
            <useResourceEntries></useResourceEntries>
            <useProjectPlanning></useProjectPlanning>
            <chargeable></chargeable>
            <typeMandatoryTimesheets></typeMandatoryTimesheets>
            <descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
            <invoiceType></invoiceType>
            <invoiceDate></invoiceDate>
            <invoiceAmount></invoiceAmount>
            <notes></notes>
            <requestOrganisationalUnit></requestOrganisationalUnit>
            <requestPosition></requestPosition>
            <requestSkillLevel1></requestSkillLevel1>
            <requestSkillLevel2></requestSkillLevel2>
            <requestSkillLevel3></requestSkillLevel3>
        </breakdown>
    </breakdowns>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
code	Code of the activity	yes
name	Name of the activity	yes
parentBreakdown	Code or name of the parent activity	no
status	Status (field list value)	no
plannedHours	Budget hours	no
plannedRate	Commercial budget rate	no
rateIsCommercialRate	Yes or No, determines if the budget rate is the fixed commercial rate	no
useNumbersInProgress	Yes or No, determines if progress must be reported in numbers	no
budgetNumbers	Target when NumbersInProgress = yes	no
teamManager	Name of the tesource	no
isMilestone	Yes or No	no
color	Color of the activity (hexadecimal value)	no
blockPosting	Yes or No, determines that the activity is blocked for transactions	no
useResourceEntries	Yes or No, determines if it possible to schedule resources on the activity	no
useProjectPlanning	Yes or No, determines if it possible to use this activity in the Gantt Chart	no
chargeable	Yes or No, determines if the activity is marked as chargeable	no
typeMandatoryTimesheets	Yes or No, determines if a type is mandatory in time sheets	no
descriptionMandatoryTimesheets	Yes or No, determines if a description is mandatory in time sheets	no
invoiceType	Type for invoicing, possible values: not_invoiceable, fixed_price, time_material	no
invoiceDate	Invoice date for the activity, when invoiceType = fixed_price	no
invoiceAmount	Amount to be invoiced, when invoiceType = fixed_price	no
notes	Comments on the activity	no
requestOrganisationalUnit	The department that is applied to resource request information in bookings	no
requestPosition	The position that is applied to resource request information in bookings	no
requestSkillLevel1	The first skill and level that is applied to resource request information in bookings	no
requestSkillLevel2	The second skill and level that is applied to resource request information in bookings	no
requestSkillLevel3	The third skill and level that is applied to resource request information in bookings	no

The following xml structure is received after an successful execution:

<response> 
    <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

project/activity/get#

Service
https://api.timewax.com/project/breakdown/get/

Purpose
Retrieve all data of an activity

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
   <breakdown></breakdown>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
breakdown	Code or name of the activity	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <breakdown>
        <id></id>
        <breakdownId></breakdownId>
        <code></code>
        <name></name>
        <parentBreakdown></parentBreakdown>
        <isMilestone></isMilestone>
        <blockPosting></blockPosting>
        <useResourceEntries></useResourceEntries>
        <useProjectPlanning></useProjectPlanning>
        <chargeable></chargeable>
        <typeMandatoryTimesheets></typeMandatoryTimesheets>
        <descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
        <invoiceType></invoiceType>
        <invoiceDate></invoiceDate>
        <invoiceAmount></invoiceAmount>
        <status></status>
        <teamManager></teamManager>
        <budgetHours></budgetHours>
        <budgetRate></budgetRate>
        <teamManager></teamManager>
        <rateIsCommercialRate></rateIsCommercialRate>
        <useNumbersInProgress></useNumbersInProgress>
        <budgetNumbers></budgetNumbers>
        <notes></notes>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
        <externalId></externalId>
        <rates>
            <rate>
                <resourceCode></resourceCode>
                <resourceName></resourceName>
                <commercialRate></commercialRate>
                <costRate></costRate>
            </rate>
        </rates>
    </breakdown>
</response>

Parameter	Description
token	Token for this request
id	ID of the activity
breakdownId	Internal system ID of the activity
code	Code of the activity
name	Name of the activity
parentBreakdown	Name of the parent activity
isMilestone	Yes or no
blockPosting	Yes or no, determines that the activity is blocked for transactions
invoiceType	Type for invoicing, possible values: not_invoiceable, fixed_price, time_material
invoiceDate	Invoice date for the activity, when invoiceType = fixed_price
invoiceAmount	Amount to be invoiced, when invoiceType = fixed_price
invoiceStatus	Status of the invoice, possible values: none, open, proposed or invoiced
status	Status value
teamManager	Name of the resource
budgetHours	Budget hours
budgetRate	Commercial budget rate
rateIsCommercialRate	Yes or No, determines if the budget rate is the fixed commercial rate
useNumbersInProgress	Yes or No, determines if progress must be reported in numbers
budgetNumbers	Target when NumbersInProgress = Yes
useResourceEntries	Yes or No, determines if it possible to schedule resources on the activity
useProjectPlanning	Yes or No, determines if it possible to use this activity in the Gantt Chart
chargeable	Yes or No, determines if the activity is marked as chargeable
typeMandatoryTimesheets	Yes or No, determines if a type is mandatory in time sheets
descriptionMandatoryTimesheets	Yes or No, determines if a description is mandatory in time sheets
notes	Comments on the activity
requestOrganisationalUnit	The department that is applied to resource request information in bookings
requestPosition	The position that is applied to resource request information in bookings
requestSkillLevel1	The first skill and level that is applied to resource request information in bookings
requestSkillLevel2	The second skill and level that is applied to resource request information in bookings
requestSkillLevel3	The third skill and level that is applied to resource request information in bookings
resourceCode	Code of the resource that is authorized to the activity
resourceName	Name of the resource that is authorized to the activity
commercialRate	The commercial rate applied for the resource on this activity
costRate	The cost price rate applied for the resource on this activity

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/activity/list#

Service
https://api.timewax.com/project/breakdown/list/

Purpose
Retrieve a list with all activities of a project

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <breakdown>
        <id></id>
        <breakdownId></breakdownId>
        <code></code>
        <name></name>
        <parentBreakdown></parentBreakdown>
        <isMilestone></isMilestone>
        <blockPosting></blockPosting>
        <useResourceEntries></useResourceEntries>
        <useProjectPlanning></useProjectPlanning>
        <chargeable></chargeable>
        <typeMandatoryTimesheets></typeMandatoryTimesheets>
        <descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
        <invoiceType></invoiceType>
        <invoiceDate></invoiceDate>
        <invoiceAmount></invoiceAmount>
        <invoiceStatus></invoiceStatus>
        <status></status>
        <teamManager></teamManager>
        <budgetHours></budgetHours>
        <budgetRate></budgetRate>
        <teamManager></teamManager>
        <rateIsCommercialRate></rateIsCommercialRate>
        <useNumbersInProgress></useNumbersInProgress>
        <budgetNumbers></budgetNumbers>
        <notes></notes>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
        <externalId></externalId>
        <rates>
            <rate>
                <resourceCode></resourceCode>
                <resourceName></resourceName>
                <commercialRate></commercialRate>
                <costRate></costRate>
            </rate>
        </rates>
    </breakdown>
</response>

Parameter	Description
token	Token for this request
id	ID of the activity
breakdownId	Internal system ID of the activity
code	Code of the activity
name	Name of the activity
parentBreakdown	Name of the parent activity
isMilestone	Yes or No
blockPosting	Yes or No, determines that the activity is blocked for transactions
invoiceType	Type for invoicing, possible values: not_invoiceable, fixed_price, time_material
invoiceDate	Invoice date for the activity when invoiceType = fixed_price
invoiceAmount	Amount to be invoiced when invoiceType = fixed_price
invoiceStatus	Status of the invoice, possible values: none, open, proposed or invoiced
status	Status (field list value)
teamManager	Name of the resource
budgetHours	Budget hours
budgetRate	Commercial budget rate
rateIsCommercialRate	Yes or No, determines if the budget rate is the fixed commercial rate
useNumbersInProgress	Yes or No, determines if progress must be reported in numbers
budgetNumbers	Target when NumbersInProgress = Yes
useResourceEntries	Yes or No, determines if it possible to schedule resources on the activity
useProjectPlanning	Yes or No, determines if it possible to use this activity in the Gantt Chart
chargeable	Yes or No, determines if the activity is marked as chargeable
typeMandatoryTimesheets	Yes or No, determines if a type is mandatory in time sheets
descriptionMandatoryTimesheets	Yes or No, determines if a description is mandatory in time sheets
notes	Comments on the activity
requestOrganisationalUnit	The department that is applied to resource request information in bookings
requestPosition	The position that is applied to resource request information in bookings
requestSkillLevel1	The first skill and level that is applied to resource request information in bookings
requestSkillLevel2	The second skill and level that is applied to resource request information in bookings
requestSkillLevel3	The third skill and level that is applied to resource request information in bookings
resourceCode	Code of the resource that is authorized to the activity
resourceName	Name of the resource that is authorized to the activity
commercialRate	The commercial rate applied for the resource on this activity
costRate	The cost price rate applied for the resource on this activity

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

project/activity/edit#

Service
https://api.timewax.com/project/breakdown/edit/

Goal
Edit existing activities.

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <breakdown></breakdown>
    <item>
        <code></code>
        <name></name>
        <parentBreakdown></parentBreakdown>
        <status></status>
        <plannedHours></plannedHours>
        <plannedRate></plannedRate>
        <rateIsCommercialRate></rateIsCommercialRate>
        <useNumbersInProgress></useNumbersInProgress>
        <budgetNumbers></budgetNumbers>
        <teamManager></teamManager>
        <isMilestone></isMilestone>
        <color></color>
        <blockPosting></blockPosting>
        <useResourceEntries></useResourceEntries>
        <useProjectPlanning></useProjectPlanning>
        <invoiceType></invoiceType>
        <invoiceDate></invoiceDate>
        <invoiceAmount></invoiceAmount>
        <notes></notes>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
breakdown	Code or name of the activity	yes
code	Code of the activity	no
name	Name of the activity	no
parentBreakdown	Code or name of the parent activity	no
status	Status (field list value)	no
plannedHours	Budget hours	no
plannedRate	Budget rate	no
rateIsCommercialRate	Yes or No, determines if the budget rate is the fixed commercial rate	no
useNumbersInProgress	Yes or No, determines if progress must be reported in numbers	no
budgetNumbers	Yes or no, determines if progress must be reported in numbers	no
teamManager	Code or name of the resource	no
isMilestone	Yes or No	no
color	Color of the activity (hexadecimal value)	no
blockPosting	Yes or No, determines that the activity is blocked for transactions	no
useResourceEntries	Yes or No, determines if it possible to schedule resources on the activity	no
useProjectPlanning	Yes or No, determines if it possible to use this activity in the Gantt Chart	no
invoiceType	Type for invoicing, possible values: not_invoiceable, fixed_price, time_material	no
invoiceDate	Invoice date for the activity, when invoiceType = fixed_price	no
invoiceAmount	Amount to be invoiced, when invoiceType = fixed_price	no
breakdown/notes	Comments on the activity	no
requestOrganisationalUnit	The department that is applied to resource request information in bookings	no
requestPosition	The position that is applied to resource request information in bookings	no
equestSkillLevel1	The first skill and level that is applied to resource request information in bookings	no
requestSkillLevel2	The second skill and level that is applied to resource request information in bookings	no
requestSkillLevel3	The third skill and level that is applied to resource request information in bookings	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

project/activity/remove#

Service
https://api.timewax.com/project/breakdown/remove/

Purpose
Delete an activity from a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <breakdown></breakdown>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
breakdowns	Code or name of the activity	yes

The following xml structure is received after an successful execution:

<response> 
    <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

project/activity/authorization/add#

Service
https://api.timewax.com/project/breakdown/authorization/add/

Purpose
Authorise resources for activities for time sheets

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <authorizations>
        <authorization>
            <breakdown></breakdown>
            <resource></resource>
        </authorization>
    </authorizations>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
authorizations/authorization/breakdown	Code or name of the activity	yes
authorizations/authorization/resource	Code or name of the resource	yes

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

project/resources/add#

Service
https://api.timewax.com/project/resources/add/

Purpose
Add resources and commercial rates to a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <resources>
        <resource>
            <resource></resource>
            <rate></rate>
        </resource>
    </resources>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
resources/resource/resource	Code or name of the resource	yes
resources/resource/rate	Commercial rate for the resource. If left empty, default value is retrieved from the resource or position level	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Progress#

progress/list#

Service
https://api.timewax.com/progress/list/

Purpose
Retrieve progress information for a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <progresses>
        <progress>
            <id></id>
            <date></date>
            <projectCode></projectCode>
            <projectName></projectName>
            <breakdownCode></breakdownCode>
            <breakdownName></breakdownName>
            <percentageComplete></percentageComplete>
            <hoursNeededToComplete></hoursNeededToComplete>
            <actualNumbers></actualNumbers>
            <dateReady></dateReady>
            <remarks></remarks>
        </progress>
    </progresses>
</response>

Parameter	Description
valid	Indication that service was executed successfully
progresses/progress/id	Internal id of the progress
progresses/progress/date	Date of the progress
progresses/progress/projectCode	Code of the project
progresses/progress/projectName	Name of the project
progresses/progress/breakdownCode	Code of the activity
progresses/progress/breakdownName	Name of the activity
progresses/progress/percentageComplete	Percentage complete
progresses/progress/hoursNeededToComplete	Estimated time to complete in number of hours
progresses/progress/actualNumbers	Actual number of completed units (if enabled on the activity master)
progresses/progress/dateReady	Expected date the activity will be finished
progresses/progress/remarks	Remarks on the progress

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

progress/list_changed#

Service
https://api.timewax.com/progress/list_changed/

Purpose
Retrieve new or changed progress information in a specified date range

Request
The following xml structure must be provided:

<request>
    <token></token>
    <dateFrom></dateFrom>
    <dateTo></dateTo>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Date from, format yyyymmdd or yyyy-mm-dd	yes
dateTo	Date to, format yyyymmdd or yyyy-mm-dd	yes

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <progresses>
        <progress>
            <id></id>
            <date></date>
            <projectCode></projectCode>
            <projectName></projectName>
            <breakdownCode></breakdownCode>
            <breakdownName></breakdownName>
            <percentageComplete></percentageComplete>
            <hoursNeededToComplete></hoursNeededToComplete>
            <actualNumbers></actualNumbers>
            <dateReady></dateReady>
            <remarks></remarks>
        </progress>
    </progresses>
</response>

Parameter	Description
valid	Indication that service was executed successfully
progresses/progress/id	Internal id of the progress
progresses/progress/date	Date of the progress
progresses/progress/projectCode	Code of the project
progresses/progress/projectName	Name of the project
progresses/progress/breakdownCode	Code of the activity
progresses/progress/breakdownName	Name of the activity
progresses/progress/percentageComplete	Percentage complete
progresses/progress/hoursNeededToComplete	Estimated time to complete in number of hours
progresses/progress/actualNumbers	Actual number of completed units (if enabled on the activity)
progresses/progress/dateReady	Expected date the activity will be finished
progresses/progress/remarks	Remarks on the progress

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Position#

position/add#

Service
https://api.timewax.com/position/add/

Purpose
Create a new position

Request
The following xml structure must be provided:

<request>
    <token></token>
    <position>
        <code></code>
        <name></name>
    </position>
</request>

Parameter	Description	Required
token	Token for this request	yes
code	Code of the position	yes
name	Name of the position	yes

The following xml structure is received after an successful execution:

<response> 
    <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Department#

department/add#

Service
https://api.timewax.com/department/add/

Purpose
Create a new department

Request
The following xml structure must be provided:

<request>
    <token></token>
    <code></code>
    <name></name>
    <legalEntity></legalEntity>
    <manager></manager>
    <backupManager></backupManager>
    <resourceManager></resourceManager>
    <departmentParent></departmentParent>
</request>

Parameter	Description	Required
token	Token for this request	yes
code	Code of the department	yes
name	Name of the department	yes
legalEntity	Code or name of legal entity to which this department belongs	no
manager	Code or name of the resource that is the department manager	yes
backupManager	Code or name of the resource that is the backup department manager	no
resourceManager	Code or name of the resource that is the resource manager of the department	no
departmentParent	Code or name of the parent department to which this department belongs	no

The following xml structure is received after an successful execution:

<response> 
    <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

department/get#

Service
https://api.timewax.com/department/get/

Purpose
Retrieve information of a department

Request
The following xml structure must be provided:

<request>
    <token></token>
    <department></department>
</request>

Parameter	Description	Required
token	Token for this request	yes
department	Code or name of the department	yes

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <message></message>
    <departments>
        <department>
            <code></code>
            <name></name>
            <legalEntityCode></legalEntityCode>
            <legalEntityName></legalEntityName>
            <managerCode></managerCode>
            <managerName></managerName>
            <backupManagerCode></backupManagerCode>
            <backupManagerName></backupManagerName>
            <resourceManagerCode></resourceManagerCode>
            <resourceManagerName></resourceManagerName>
            <departmentParentCode></departmentParentCode>
            <departmentParentName></departmentParentName>
        </department>
    </departments>
</response>

Parameter	Description
code	Code of the department
name	Name of the department
legalEntityCode	Code of legal entity to which this department belongs
legalEntityName	Name of legal entity to which this department belongs
managerCode	Code of the resource that is the department manager
managerName	Name of the resource that is the department manager
backupManagerCode	Code of the resource that is the backup department manager
backupManagerName	Name of the resource that is the backup department manager
resourceManagerCode	Code of the resource that is the resource manager of the department
resourceManagerName	Name of the resource that is the resource manager of the department
departmentParentCode	Code of the parent department to which this department belongs
departmentParentName	Name of the parent department to which this department belongs

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors></errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

department/edit#

Service
https://api.timewax.com/department/edit/

Purpose
Edit a department

Request
The following xml structure must be provided:

<request>
    <token></token>
    <department></department>
    <code></code>
    <name></name>
    <legalEntity></legalEntity>
    <manager></manager>
    <backupManager></backupManager>
    <resourceManager></resourceManager>
    <departmentParent></departmentParent>
</request>

Parameter	Description	Required
token	Token for this request	yes
department	Code or name of the department to edit	yes
code	Code of the department	no
name	Name of the department	no
legalEntity	Code or name of legal entity to which this department belongs	no
manager	Code or name of the resource that is the department manager	no
backupManager	Code or name of the resource that is the backup department manager	no
resourceManager	Code or name of the resource that is the resource manager of the department	no
departmentParent	Code or name of the parent department	no

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <message></message>
    <departments>
        <department>
            <code></code>
            <name></name>
            <legalEntityCode></legalEntityCode>
            <legalEntityName></legalEntityName>
            <managerCode></managerCode>
            <managerName></managerName>
            <backupManagerCode></backupManagerCode>
            <backupManagerName></backupManagerName>
            <resourceManagerCode></resourceManagerCode> 
            <resourceManagerName></resourceManagerName>
            <departmentParentCode></departmentParentCode>
            <departmentParentName></departmentParentName>
        </department>
    </departments>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Resources#

resource/add#

Service
https://api.timewax.com/resource/add/

Purpose
Create a new resource

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource>
        <type></type>
        <user></user>
        <code></code>
        <name></name>
        <firstNames></firstNames>
        <infix></infix>
        <email></email>
        <organisationalUnit></organisationalUnit>
        <position></position>
        <privateAddress></privateAddress>
        <privatePostcode></privatePostcode>
        <privateCity></privateCity>
        <privateTelephone></privateTelephone>
        <privateMobile></privateMobile>
        <privateEmail></privateEmail>
        <birthDate></birthDate>
        <businessTelephone></businessTelephone>
        <businessMobile></businessMobile>
        <startDate></startDate>
        <endDate></endDate>
        <employeeNumber></employeeNumber>
        <bankAccountNumber></bankAccountNumber>
        <backupTime></backupTime>
        <regionCalendar></regionCalendar>
        <externalResource></externalResource>
        <sendEmailNotificationDueTimesheets></sendEmailNotificationDueTimesheets>
        <workingHoursMon></workingHoursMon>
        <workingHoursTue></workingHoursTue>
        <workingHoursWed></workingHoursWed>
        <workingHoursThu></workingHoursThu>
        <workingHoursFri></workingHoursFri>
        <workingHoursSat></workingHoursSat>
        <workingHoursSun></workingHoursSun>
        <startTimeMon></startTimeMon>
        <startTimeTue></startTimeTue>
        <startTimeWed></startTimeWed>
        <startTimeThu></startTimeThu>
        <startTimeFri></startTimeFri>
        <startTimeSat></startTimeSat>
        <startTimeSun></startTimeSun>
        <color></color>
        <remarks></remarks>
        <profiles>
            <profile></profile>
        </profiles>
    </resource>
</request>

Parameter	Description	Required
token	Token for this request	yes
type	Resource type: person or material. When left empty default value is person	no
user	Yes or no. Default no when left empty	no
code	Code of the resource	yes
name	Last name of the resource	yes
firstNames	First name of the resource	yes
infix	Infix	no
email	Email address of the resource	if user is yes
organisationalUnit	Code or name of the department	yes
position	Code or name of the position	yes
privateAddress	Private address	no
privatePostcode	Private postcode	no
privateCity	Private city	no
privateTelephone	Private telephone	no
privateMobile	Private mobile number	no
privateEmail	Private email	no
birthDate	Date of birth, format: yyyymmdd or yyyy-mm-dd	no
businessTelephone	Business telephone	no
businessMobile	Business mobile	no
startDate	Start date for the resource, format yyyymmdd or yyyy-mm-dd	yes
endDate	End date for the resource, format yyyymmdd or yyyy-mm-dd	no
employeeNumber	Employee number	no
bankAccountNumber	Bank account number	no
backupTime	Code or name of backup user for time sheets	no
regionCalendar	Code or name of the bank holiday calendar	no
externalResource	Yes or No	no
sendEmailNotificationDueTimesheets	Yes or No	no
workingHoursMon	Number of working hours on Monday	no
workingHoursTue	Number of working hours on Tuesday	no
workingHoursWed	Number of working hours on Wednesday	no
workingHoursThu	Number of working hours on Thursday	no
workingHoursFri	Number of working hours on Friday	no
workingHoursSat	Number of working hours on Saturday	no
workingHoursSun	Number of working hours on Sunday	no
startTimeMon	Default start time on Monday, format hh:mm	no
startTimeTue	Default start time on Tuesday, format hh:mm	no
startTimeWed	Default start time on Wednesday, format hh:mm	no
startTimeThu	Default start time on Thursday, format hh:mm	no
startTimeFri	Default start time on Friday, format hh:mm	no
startTimeSat	Default start time on Saturday, format hh:mm	no
startTimeSun	Default start time on Sunday, format hh:mm	no
color	Resource color (hexadecimal value)	no
remarks	Remarks of the resource	no
profiles/profile	Code or name of user profiles	no

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/edit#

Service
https://api.timewax.com/resource/edit/

Purpose
Edit an existing resource

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource></resource>
    <item>
        <code></code>
        <lastName></lastName>
        <firstNames></firstNames>
        <email></email>
        <infix></infix>
        <privateAddress></privateAddress>
        <privatePostcode></privatePostcode>
        <privateCity></privateCity>
        <privateTelephone></privateTelephone>
        <privateMobile></privateMobile>
        <birthDate></birthDate>
        <businessTelephone></businessTelephone>
        <businessMobile></businessMobile>
        <startDate></startDate>
        <endDate></endDate>
        <employeeNumber></employeeNumber>
        <backupTime></backupTime>
        <regionCalendar></regionCalendar>
        <externalResource></externalResource>
        <sendEmailNotificationDueTimesheets></sendEmailNotificationDueTimesheets>
        <workingHoursMon></workingHoursMon>
        <workingHoursTue></workingHoursTue>
        <workingHoursWed></workingHoursWed>
        <workingHoursThu></workingHoursThu>
        <workingHoursFri></workingHoursFri>
        <workingHoursSat></workingHoursSat>
        <workingHoursSun></workingHoursSun>
        <startTimeMon></startTimeMon>
        <startTimeTue></startTimeTue>
        <startTimeWed></startTimeWed>
        <startTimeThu></startTimeThu>
        <startTimeFri></startTimeFri>
        <startTimeSat></startTimeSat>
        <startTimeSun></startTimeSun>
        <color></color>
        <remarks></remarks>
        <organisationalUnit></organisationalUnit>
        <position></position>
        <user></user>
        <profiles>
            <profile></profile>
        </profiles>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
resource	Code or name of the resource	yes
user	Yes or No	no
code	Code of the resource	no
lastName	Last name of the resource	no
firstNames	First name of the resource	no
infix	Infix	no
email	Email address of the resource	if user is yes
organisationalUnit	Code or name of the department, updates the most recent department	no
position	Code or name of the position, updates the most recent position	no
privateAddress	Private address	no
privatePostcode	Private postcode	no
privateCity	Private city	no
privateTelephone	Private telephone number	no
privateMobile	Private mobile number	no
birthDate	Date of birth, format yyyymmdd or yyyy-mm-dd	no
businessTelephone	Business telephone	no
businessMobile	Business mobile	no
startDate	Start date for the resource, format: yyyymmdd or yyyy-mm-dd	no
endDate	End date for the resource, format: yyyymmdd or yyyy-mm-dd	no
employeeNumber	Employee number	no
backupTime	Code or name of the backup user for time sheets	no
regionCalendar	Code or name of the applicable bank holidays	no
externalResource	Yes or No	no
sendEmailNotificationDueTimesheets	Yes or No	no
workingHoursMon	Number of working hours on Monday	no
workingHoursTue	Number of working hours on Tuesday	no
workingHoursWed	Number of working hours on Wednesday	no
workingHoursThu	Number of working hours on Thursday	no
workingHoursFri	Number of working hours on Friday	no
workingHoursSat	Number of working hours on Saturday	no
workingHoursSun	Number of working hours on Sunday	No
startTimeMon	Default start time on Monday, format hh:mm	no
startTimeTue	Default start time on Tuesday, format hh:mm	no
startTimeWed	Default start time on Wednesday, format hh:mm	no
startTimeThu	Default start time on Thursday, format hh:mm	no
startTimeFri	Default start time on Friday, format hh:mm	no
startTimeSat	Default start time on Saturday, format hh:mm	no
startTimeSun	Default start time on Sunday, format hh:mm	no
color	Resource color (hexadecimal value)	no
remarks	Remarks of the resource	no
profiles/profile	Code or name of user profiles	if user is yes

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/organisationalunit/add#

Service
https://api.timewax.com/resource/organisationalunit/add/

Purpose
Add a department to a resource

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource></resource>
    <item>
        <organisationalUnit></organisationalUnit>
        <date></date>
    </item>
</request

Parameter	Description	Required
token	Token for this request	yes
resource	Code or name of the resource	yes
item/organisationalUnit	Code or name of the department	yes
item/date	Effective start date at the department, format: yyyymmdd or yyyy-mm-dd	yes

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/position/add#

Service
https://api.timewax.com/resource/position/add/

Purpose
Add a position to a resource

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource></resource>
    <item>
        <position></position>
        <date></date>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
resource	Code or name of the resource	yes
item/position	Code or name of the position	yes
item/date	Effective start date at the position, format: yyyymmdd or yyyy-mm-dd	yes

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/skilllevel/add#

Service
https://api.timewax.com/resource/skilllevel/add/

Purpose
Add a skill to a resource

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource></resource>
    <item>
        <skill></skill>
        <level></level>
        <date></date>
        <endDate></endDate>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
resource	Code or name of the resource	yes
item/skill	Code or name of the skill	yes
item/level	Code or name of the skill level	yes
item/date	Start date, format: yyyymmdd or yyyy-mm-dd	yes
item/endDate	End date, format: yyyymmdd or yyyy-mm-dd	no

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/get#

Service
https://api.timewax.com/resource/get/

Purpose
Retrieve all data of a resource

Request
The following xml structure must be provided:

<request>
   <token></token>
   <resource></resource>
</request>

Parameter	Description	Required
token	Token for this request	yes
resource	Name, full name or email	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <resource>
        <email></email>
        <code></code>
        <lastName></lastName>
        <firstNames></firstNames>
        <infix></infix>
        <isMaterial</isMaterial>
        <privateAddress></privateAddress>
        <privatePostcode></privatePostcode>
        <privateCity></privateCity>
        <privateCountry></privateCountry>
        <privateTelephone></privateTelephone>
        <privateMobile></privateMobile>
        <privateEmail></privateEmail>
        <birthDate</birthDate>
        <businessTelephone></businessTelephone>
        <businessMobile></businessMobile>
        <isActive></isActive>
        <startDate</startDate>
        <endDate></endDate>
        <employeeNumber></employeeNumber>
        <bankAccountNumber></bankAccountNumber>
        <backupTime></backupTime>
        <regionCalendar></regionCalendar>
        <isExternalResource></isExternalResource>
        <sendEmailNotificationDueTimesheets></sendEmailNotificationDueTimesheets>
        <workingHoursMonday></workingHoursMonday>
        <workingHoursTuesday ></workingHoursTuesday>
        <workingHoursWednesday></workingHoursWednesday>
        <workingHoursThursday></workingHoursThursday>
        <workingHoursFriday></workingHoursFriday>
        <workingHoursSaturday></workingHoursSaturday>
        <workingHoursSunday></workingHoursSunday>
        <startTimeMonday></startTimeMonday>
        <startTimeTuesday></startTimeTuesday>
        <startTimeWednesday></startTimeWednesday>
        <startTimeThursday></startTimeThursday>
        <startTimeFriday></startTimeFriday>
        <startTimeSaturday></startTimeSaturday>
        <startTimeSunday></startTimeSunday>
        <color></color>
        <organisationalUnits>
            <activeOrganisationalUnit></activeOrganisationalUnit>
            <organisationalUnit>
                <code></code>
                <name></name>
                <date></date>
            </organisationalUnit>
        </organisationalUnits>
        <positions>
            <activePosition></activePosition>
            <position>
                <code></code>
                <name></name>
                <date></date>
            </position>
            <skill>
                <skillCode></skillCode>
                <skillName></skillName>
                <levelCode></levelCode>
                <levelName></levelName>
                <date></date>
            </skill>
        </skills>
        <rates></rates>
    </resource>
</response>

isMaterialYes or no, is this resource an object

Parameter	Description
valid	Indication that service was executed successfully
email	Email address
code	Code of the resource
lastName	Last name of the resource
firstNames	First name of the resource
infix	Infix of the resource
privateAddress	Private address
privatePostcode	Private postcode
privateCity	Private city
privateCountry	Private country
privateTelephone	Private telephone number
privateMobile	Private mobile phone number
privateEmail	Private email address
birthDate	Date of birth
businessTelephone	Business telephone number
businessMobile	Business mobile phone number
isActive	Yes or No
startDate	Start date
endDate	End date
employeeNumber	Employee number
bankAccountNumber	Bank account number
backupTime	Backup user for time sheets
regionCalendar	Bank holiday calendar
isExternalResource	Yes or no, is this resource external?
sendEmailNotificationDueTimesheets	Yes or no, send an email when time sheets are due
workingHoursMonday – Sunday	Working hours per day
startTimeMonday – Sunday	Default start time per day
color	Color of the resource
activeOrganisationalunit	Code of the active department
organisationalUnits/organisationalUnit/code	Code of the department
organisationalUnits/organisationalUnit/name	Name of the department
organisationalUnits/organisationalUnit/date	Effective start date at the department
activePosition	Code of the active position
positions/position/code	Code of the position
positions/position/name	Name of the position
positions/position/date	Effective start date for the position
skills/skill/skill	Skill of the resource
skills/skill/level	Skill level
skills/skill/date	Effective start date for the skill level
rates/rate/type	Type of the rate
rates/rate/date	Effective start date for the rate
rates/rate/currency	Currency
rates/rate/rate	Rate in currency value

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

resource/list#

Service
https://api.timewax.com/resource/list/

Purpose
Retrieve a list with resources

Request
The following xml structure must be provided:

<request>
   <token></token>
    <isActive></isActive>
</request>

Parameter	Description	Required
token	Token for this request	yes
isActive	Yes or No	no

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <resources>
        <resource>
            <resourceID></resourceID>
            <code></code>
            <fullName></fullName>
            <lastName></lastName>
            <firstNames></firstNames>
            <infix></infix>
            <color></color>
            <isMe>no</isMe>
            <isActive>no</isActive>
        </resource>
    </resources>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
resourceID	The unique ID of the resource
code	Code of the resource
fullName	Full name of the resource
lastName	Last name of the resource
firstNames	First name of the resource
infix	Infix of the resource
color	Resource color (hexadecimal value)
isMe	Yes or No, states if this resource belongs to the user requesting this service
isActive	Yes or No

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

Resource bookings#

calendar/entries/add#

Service
https://api.timewax.com/calendar/entries/add/

Purpose
Add planning bookings

Request

The following xml structure must be provided:

<request>
    <token></token>
    <entry>
        <type></type>
        <resource></resource>
        <project></project>
        <breakdown></breakdown>
        <status></status>
        <note></note>
        <date></date>
        <timeFrom></timeFrom>
        <hours></hours>
        <breaktime></breaktime>
        <traveltime></traveltime>
        <fullDay></fullDay>
        <location></location>
        <description></description>
        <remarks></remarks>
        <linkedResources>
            <resource></resource>
        </linkedResources>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
    </entry>
</request>

Parameter	Description	Required
token	Token for this request	yes
type	Type of the booking: “entry” for bookings with resources, “request” for bookings without	yes
resource	Code or name of the resource	if type = “entry”
project	Code or name of the project	yes
breakdown	Code or name of the activity	yes
status	Hard or Soft	no
note	Yes or No, determines if this booking is a note booking	no
date	Date of the booking, format: yyyymmdd or yyyy-mm-dd	yes
timeFrome	Start time for the booking, format: hh:mm	yes
hours	Number of hours	yes
breaktime	Number of hours for break time	no
traveltime	Number of hours for travel time	no
fullDay	Yes or No, marks the booking as “Full day”	no
Location	Location	no
description	Description	no
remarks	Remarks	no
linkedResources/resource	Code or name of the resource, only used when type = “request”	no
requestOrganisationalUnit	The department when request information is needed	no
requestPosition	The position when request information is needed	no
requestSkillLevel1	First skill when request information is needed	no
requestSkillLevel2	Second skill when request information is needed	no
requestSkillLevel3	Third skill when request information is needed	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully
id	Id of the entry

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <id></id>
   <errors>no</errors>
</response>

calendar/entries/list#

Service
https://api.timewax.com/calendar/entries/list/

Purpose
Retrieve a list of planning bookings

Request
The following xml structure must be provided:

<request>
    <token></token>
    <dateFrom></dateFrom>
    <dateTo></dateTo>
    <entryId></entryId>
    <resource></resource>
    <project></project>
    <breakdown></breakdown>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Date from, format yyyymmdd or yyyy-mm-dd	yes
dateTo	Date to, format yyyymmdd or yyyy-mm-dd	yes
resource	Code or name or the resource	no
project	Code or name of the project	no
breakdown	Code or name of the activity	no

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <entries>
        <entry>
            <id></id>
            <date></date>
            <resourceName></resourceName>
            <resourceCode></resourceCode>
            <resourceEmployeeNumber></resourceEmployeeNumber>
            <resourceId></resourceId>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <breakdownId></breakdownId>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <status></status>
            <type></type>
            <note></note>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <remarks></remarks>
            <location>m</location>
            <requestDepartmentCode></requestDepartmentCode>
            <requestDepartmentName></requestDepartmentName>
            <requestPositionCode></requestPositionCode>
            <requestPositionName></requestPositionName>
            <requestSkillLevel1></requestSkillLevel1> 
            <requestSkillLevel2></requestSkillLevel2>
            <requestSkillLevel3></requestSkillLevel3>
            <addDate></addDate>
            <modifyDate></modifyDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/date	Date of the booking
entries/entry/resourceName	Name of the resource
entries/entry/resourceCode	Code of the resource
entries/entry/resourceEmployeeNumber	Employee number of the resource
entries/entry/resourceId	Internal system ID of the resource
entries/entry/project	Name of the project
entries/entry/projectCode	Code of the project
entries/entry/breakdown	Name of the activity
entries/entry/breakdownCode	Code of the activity
entries/entry/breakdownId	Internal system ID of the activity
entries/entry/breakdownParent	Name of the parent activity
entries/entry/breakdownParentCode	Code of the parent activity
entries/entry/status	Status of the booking (Hard or Soft)
entries/entry/type	Field list value from the type field
entries/entry/note	Yes or No, indicates if the booking is a note entry
entries/entry/timeFrom	Start time of the booking
entries/entry/timeTo	End time of the booking
entries/entry/hours	Number of hours
entries/entry/description	Description
entries/entry/remarks	Remarks
entries/entry/location	Location
entries/entry/requestDepartmentCode	Code of the department for which a resource is requested
entries/entry/requestDepartmentName	Name of the department for which a resource is requested
entries/entry/requestPositionCode	Code of the position for which a resource is requested
entries/entry/requestPositionName	Name of the position for which a resource is requested
entries/entry/requestSkillLevel1	First skill for which a resource is requested
entries/entry/requestSkillLevel2	Second skill for which a resource is requested
entries/entry/requestSkillLevel3	Third skill for which a resource is requested
entries/entry/addDate	Add date of the booking
entries/entry/modifyDate	Modification date of the booking

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

calendar/entries/list_changed#

Service
https://api.timewax.com/calendar/entries/list_changed/

Purpose
Retrieve planning bookings that have been added, modified or deleted in a specified date range

Request
The following xml structure must be provided:

<request>
   <token></token>
   <dateFrom></dateFrom>
   <dateTo></dateTo>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Add or modification date from, format yyyymmdd or yyyy-mm-dd	yes
dateTo	Add or modification date to, format yyyymmdd or yyyy-mm-dd	yes

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <entries>
        <entry>
            <id></id>
            <date></date>
            <resourceName></resourceName>
            <resourceCode></resourceCode>
            <resourceEmployeeNumber></resourceEmployeeNumber>
            <resourceId></resourceId>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <breakdownId></breakdownId>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <status></status>
            <type></type>
            <note></note>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <remarks></remarks>
            <location>m</location>
            <requestDepartmentCode></requestDepartmentCode>
            <requestDepartmentName></requestDepartmentName>
            <requestPositionCode></requestPositionCode>
            <requestPositionName></requestPositionName>
            <requestSkillLevel1></requestSkillLevel1> 
            <requestSkillLevel2></requestSkillLevel2>
            <requestSkillLevel3></requestSkillLevel3>
            <addDate></addDate>
            <modifyDate></modifyDate>
            <deleteDate></deleteDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/date	Date of the booking
entries/entry/resourceName	Name of the resource
entries/entry/resourceCode	Code of the resource
entries/entry/resourceEmployeeNumber	Employee number of the resource
entries/entry/resourceId	Internal system ID of the resource
entries/entry/project	Name of the project
entries/entry/projectCode	Code of the project
entries/entry/breakdown	Name of the activity
entries/entry/breakdownCode	Code of the activity
entries/entry/breakdownId	Internal system ID of the activity
entries/entry/breakdownParent	Name of the parent activity
entries/entry/breakdownParentCode	Code of the parent activity
entries/entry/status	Status of the booking (Hard or Soft)
entries/entry/type	Field list value from the type field
entries/entry/note	Yes or No, indicates if the booking is a note entry
entries/entry/timeFrom	Start time of the booking
entries/entry/timeTo	End time of the booking
entries/entry/hours	Number of hours
entries/entry/description	Description
entries/entry/remarks	Remarks
entries/entry/location	Location
entries/entry/requestDepartmentCode	Code of the department for which a resource is requested
entries/entry/requestDepartmentName	Name of the department for which a resource is requested
entries/entry/requestPositionCode	Code of the position for which a resource is requested
entries/entry/requestPositionName	Name of the position for which a resource is requested
entries/entry/requestSkillLevel1	Fist skill for which a resource is requested
entries/entry/requestSkillLevel2	Second skill for which a resource is requested
entries/entry/requestSkillLevel3	Third skill for which a resource is requested
entries/entry/addDate	Add date of the booking
entries/entry/modifyDate	Modification date of the booking
entries/entry/deleteDate	Deletion date of the booking

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

calendar/entries/edit#

Service
https://api.timewax.com/calendar/entries/edit/

Purpose
Update a planning booking

Request
The following xml structure must be provided:

<request>
    <token></token>
    <entry>
        <id></id>
        <type></type>
        <resource></resource>
        <project></project>
        <breakdown></breakdown>
        <status></status>
        <note></note>
        <date></date>
        <timeFrom></timeFrom>
        <hours></hours>
        <breaktime></breaktime>
        <traveltime></traveltime>
        <fullDay></fullDay>
        <location></location>
        <description></description>
        <remarks></remarks>
        <linkedResources>
            <resource></resource>
        </linkedResources>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
    </entry>
</request>

Parameter	Description	Required
token	Token for this request	yes
id	Id of the booking to edit	yes
type	Type of the booking: “entry” for resource bookings, “request” for bookings without a resource	yes
resource	Code or name of the resource	if type= “entry”
project	Code or name of the project	yes
breakdown	Code or name of the activity	yes
status	Hard or Soft	no
note	Yes or No, determines if this booking is a note booking	no
date	Date of the booking, format yyyymmdd or yyyy-mm-dd	yes
timeFrom	Start time for the booking, format: hh:mm	yes
hours	Number of hours	yes
breaktime	Number of hours for break time	no
traveltime	Number of hours for travel time	no
fullDay	Yes or No, marks the booking as “Full day”	no
Location	Location	no
description	Description	no
remarks	Remarks	no
linkedResources/resource	Code or name of a resource, only used when booking type = “request”	no
requestOrganisationalUnit	Department when request information is needed	no
requestPosition	Position when request information is needed	no
requestSkillLevel1	First skill when request information is needed	no
requestSkillLevel2	Second skill when request information is needed	no
requestSkillLevel3	Third skill when request information is needed	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

calendar/entries/delete#

Service
https://api.timewax.com/calendar/entries/delete/

Purpose
Delete a planning booking

Request
The following xml structure must be provided:

<request>
    <token></token>
    <entry>
        <id></id>
    </entry>
</request>

Parameter	Description	Required
token	Token for this request	yes
id	The unique id of a booking. Retrieve an id with calendar/entries/list	yes

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Gantt Chart#

projectplanning/save#

Service
https://api.timewax.com/projectplanning/save/

Purpose
Add or update Gantt Chart data for an activity

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <version></version>
    <breakdown></breakdown>
    <item>
        <startdate></startdate>
        <enddate></enddate>
        <comments></comments>
        <estimate></estimate>
        <label></label>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
version	Version of the Gantt Chart	yes
breakdown	Code or name of the activity	yes
item/startdate	Start date, format yyyymmdd or yyyy-mm-dd	yes
item/enddate	End date, format yyyymmdd or yyyy-mm-dd	yes
item/comments	Comments	no
item/estimate	Estimate	no
item/label	Label	no

The following xml structure is received after an successful execution:

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

projectplanning/list#

Service
https://api.timewax.com/projectplanning/list/

Purpose
Retrieve Gantt Chart data for a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <version></version>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
version	Version of the Gantt Chart	no

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <Entries>
        <Entry>
            <project></project>
            <projectCode></projectCode>
            <status></status>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <startdate></startdate>
            <enddate></enddate>
            <duration></duration>
            <comments></comments>
            <estimate></estimate>
            <label></label>
            <predecessors>
                <predecessor>
                   <projectCode></projectCode>
                   <breakdownCode></breakdownCode>
                </predecessor>
            </predecessors> 
            <successors>
                <successor>
                    <projectCode></projectCode>
                    <breakdownCode></breakdownCode>
                </predecessor>            
            </successors>
        </Entry>
    </Entries>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project	Name of the project
projectCode	Code of the project
version	Version of the Gantt Chart
breakdown	Name of the activity
breakdownCode	Code of the activity
startdate	Start date of the activity
enddate	End date of the activity
duration	Duration in days
comments	Comment
estimate	Estimated number of days
label	Label

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

Time entries#

time/entries/add#

Service
https://api.timewax.com/time/entries/add/

Purpose
Add time lines to time sheets

Request
The following xml structure must be provided:

<request>
    <token></token>
    <timelines>
        <timeline>
            <resource></resource>
            <project></project>
            <breakdown></breakdown>
            <date></date>
            <hours></hours>
            <startTime></startTime>
            <endTime></endTime>
            <description></description>
            <reference></reference>
            <KM></KM>
            <descriptionKM></descriptionKM>
            <type></type>
        </timeline>
    </timelines>
</request>

Parameter	Description	Required
token	Token for this request	yes
resource	Code or name of the reosurc	yes
project	Code or name of the project	yes
breakdown	Code or name of the activity	yes
date	Date of the booking, format yyyymmdd or yyyy-mm-dd	yes
hours	Number of hours	yes
startTime	Start time of the time line, format: hh:mm	yes
endTime	End time of the time line, format: hh:mm	yes
reference	Reference	no
description	Description	no
KM	Number of kilometers	no
descriptionKM/resource	Description field for kilometers	no
type	Type (field list value)	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

time/entries/list#

Service
https://api.timewax.com/time/entries/list/

Purpose
Retrieve a list of time lines

Request
The following xml structure must be provided:

<request>
    <token></token>
    <dateFrom></dateFrom>
    <dateTo></dateTo>
    <resource></resource>
    <project></project>
    <onlyApprovedEntries></onlyApprovedEntries>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Date from, format yyyymmdd or yyyy-mm-dd	yes
dateTo	Date to, format yyyymmdd or yyyy-mm-dd	yes
resource	Code or name of the resource	no
project	Code or name of the project	no
onlyApprovedEntries	Yes or No, to select on approval status	no

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <entries>
        <entry>
            <id></id>
            <date></date>
            <resource></resource>
            <resourceCode></resourceCode>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownId></breakdownId>
            <breakdownCode></breakdownCode>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <status></status>
            <dateUpdateStatus></dateUpdateStatus>
            <reference></reference>
            <type></type>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <KM></KM>
            <descriptionKM></descriptionKM>
            <rejectionRemarks></rejectionRemarks>
            <commercialRate></commercialRate>
            <addDate></addDate>
            <modifyDate></modifyDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
id	The unique id of the time line
date	Date of the booking
resource	Name of the resource
resourceCode	Code of the resource
project	Name of the project
projectCode	Code of the project
breakdown	Name of the activity
breakdownId	Internal ID of the activity
breakdownCode	Code of the project
breakdownParent	Name of the parent activity
breakdownParentCode	Code of the parent activity
status	Status of the booking
dateUpdateStatus	Last update of the time line (approved or rejected)
type	Type (field list value)
reference	Reference
timeFrom	Start time of the time line, format hh:mm
timeTo	End time of the time line, format hh:mm
hours	Number of hours
description	Description
KM	Number of kilometers
descriptionKM	Description of the kilometers
rejectionRemarks	Remarks when the time line has been rejected
commercicalRate	Commercial rate
addDate	Add date of the time line
modifyDate	Modification date of the time line

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

time/entries/list_changed#

Service
https://api.timewax.com/time/entries/list_changed/

Purpose
Retrieve a list of added or modified time lines in a specified date range

Request
The following xml structure must be provided:

<request>
    <token></token>
    <dateFrom></dateFrom>
    <dateTo></dateTo>
    <resource></resource>
    <onlyApprovedEntries></onlyApprovedEntries>
</request>

Parameter	Description	Required
token	Token for this request	yes
dateFrom	Add or modification date from, format: yyyymmdd or yyyy-mm-dd	yes
dateTo	Add or modification date to, format yyyymmdd or yyyy-mm-dd	yes
resource	Code or name of the resource	no
onlyApprovedEntries	Yes or No, selection of approval status of time lines	no

The following xml structure is received after an successful execution:

<response>
    <valid>true</valid>
    <entries>
        <entry>
            <id></id>
            <date></date>
            <resource></resource>
            <resourceCode></resourceCode>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <status></status>
            <dateUpdateStatus></dateUpdateStatus>
            <reference></reference>
            <type></type>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <KM></KM>
            <descriptionKM></descriptionKM>
            <rejectionRemarks></rejectionRemarks>
            <invoiceStatus></invoiceStatus>
            <commercialRate></commercialRate>
            <addDate></addDate>
            <modifyDate></modifyDate>
            <deleteDate></deleteDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/id	Unique id of the time line
entries/entry/date	Date of the booking
entries/entry/resource	Name of the resource
entries/entry/resourceCode	Code of the resource
entries/entry/project	Name of the project
entries/entry/projectCode	Code of the project
entries/entry/breakdown	Name of the activity
entries/entry/breakdownCode	Code of the activity
entries/entry/breakdownParent	Name of the parent activity
entries/entry/breakdownParentCode	Code of the parent activity
entries/entry/status	Status
entries/entry/dateUpdateStatus	Last update of the time line (approved or rejected)
entries/entry/type	Type (field list value)
entries/entry/reference	Reference
entries/entry/timeFrom	Start time of the time line, format hh:mm
entries/entry/timeTo	End time of the time line, format: hh:mm
entries/entry/hours	Number of hours
entries/entry/description	Description
entries/entry/KM	Number of kilometers
entries/entry/descriptionKM	Description of the kilometers
entries/entry/rejectionRemarks	Remarks in case the time line has been rejected
entries/entry/commericalRate	Commercial rate
entries/entry/addDate	Add date of the time line
entries/entry/modifyDate	Modification date of the time line
entries/entry/deleteDate	Delete date of the time line

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
errors	Reason why the service has executed unsuccessfully

Budget costs#

budgetcost/list#

Service
https://api.timewax.com/budgetcost/list/

Purpose
Retrieve a list of cost items within a project

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <budgetcosts>
        <budgetcost>
            <name></name>
            <date></date>
            <breakdown></breakdown>
            <invoiceType></invoiceType>
            <type></type>
            <budgetAmount></budgetAmount>
            <invoiceDate></invoiceDate>
            <invoiceAmount></invoiceAmount>
            <invoiceStatus></invoiceStatus>
            <description></description>
        </budgetcost>
    </budgetcosts>
</response>

Parameter	Description
valid	Indication that service was executed successfully
name	Name of the cost item
date	Date, format:yyyy-mm-dd
breakdown	Name of the activity
invoiceType	Type for invoicing: Non-chargeable, Fixed price or Costing
type	Type (field list value)
budgetAmount	Budgeted amount
invoiceDate	Invoice date
invoiceAmount	Amount for invoicing
invoiceStatus	Status
description	Description

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

budgetcost/add#

Service
https://api.timewax.com/budgetcost/add/

Purpose
Add a cost item to a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <budgetcost>
        <project></project>
        <name></name>
        <date></date>
        <breakdown></breakdown>
        <type></type>
        <budgetAmount></budgetAmount>
    </budgetcost>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
name	Name of the cost item	yes
date	Date, format yyyy-mm-dd	yes
breakdown	Name of the activity	yes
type	Type (field list value)	yes
budgetAmount	Budget amount	no

The following xml structure is received after an successful execution:

<response> 
   <valid>yes</valid>
</response>

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was executed successfully: Yes or No
error	Reason why the service has executed unsuccessfully

Purchase invoices#

purchaseinvoices/list#

Service
https://api.timewax.com/purchaseinvoices/list/

Purpose
Retrieve a list of all purchase invoices of a project

Request
The following xml structure must be provided:

<request>
   <token></token>
   <project></project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <purchaseInvoices>
        <purchaseInvoice>
            <invoiceDate></invoiceDate>
            <invoiceNumber></invoiceNumber>
            <invoiceAmount></invoiceAmount>
            <budgetCost></budgetCost>
            <breakdown></breakdown>
            <type></type>
            <invoiceType></invoiceType>
            <description></description>
        </purchaseInvoice>
    </purchaseInvoices>
</response>

Parameter	Description
valid	Indication that service was executed successfully
invoiceDate	Invoice date, format yyyy-mm-dd
invoiceNumber	Invoice number
invoiceAmount	Invoice amount
budgetCost	Name of the cost item
breakdown	Name of the activity
type	Type (field list value)
invoiceType	Type for invoicing: Non-chargeable, Fixed price or Costing
description	Description of the invoice

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully

purchaseinvoices/add#

Service
https://api.timewax.com/purchaseinvoices/add/

Purpose
Add a purchase invoices to a cost item of a project

Request
The following xml structure must be provided:

<request>
    <token></token>
    <purchaseInvoice>
        <project></project>
        <budgetCost></budgetCost>
        <purchaseInvoiceDate></purchaseInvoiceDate>
        <purchaseInvoiceNumber></purchaseInvoiceNumber>
        <purchaseInvoiceAmount></purchaseInvoiceAmount>
        <description></description>
    </purchaseInvoice>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the project	yes
budgetCost	Name of the cost item	yes
purchaseInvoiceDate	Invoice date, format: yyyy-mm-dd or yyyymmdd	yes
purchaseInvoiceNumber	Invoice number	yes
purchaseInvoiceAmount	Amount of the invoice	no
description	Description of the invoice	no

The following xml structure is received after an successful execution:

<response>
   <valid>yes</valid>
</response>

Parameter	Description
valid	Indication that service was executed successfully

The following xml structure is received after an incorrect execution:

<response> 
   <valid>no</valid>
   <errors>no</errors>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
error	Reason why the service has executed unsuccessfully