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.

We are continuously expanding services. Do you need a service that is currently not available? Submit a request and we will make the service available as soon as possible.

The following services are currently available:

Token#

authentication/token/get#

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

Goal
Obtaining a token for the authentication of the other api services.

Request
The following xml structure must be provided:

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

Parameter	Description	Required
Client	Client to connect to. Client name can be found in the start page (User). In the top of the settingsmenu you’ll see User – Clientname (picture)	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/

Goal
Adding new companies

Request
The following xml structure must be provided:

<request>
    <token></token>
    <company>
        <code></code>
        <name></name>
        <isDebtor></isDebtor>
        <language></language>
        <contactPerson></contactPerson>
        <parent></parent>
        <industry></industry>
        <type></type>
        <mailingAttn></mailingAttn>
        <mailingAddress></mailingAddress>
        <mailingPostcode></mailingPostcode>
        <mailingCity></mailingCity>
        <mailingCountry></mailingCountry>
        <officeAttn></officeAttn>
        <officeAddress></officeAddress>
        <officePostcode></officePostcode>
        <officeCity></officeCity>
        <officeCountry></officeCountry>
        <telephone></telephone>
        <fax></fax>
        <VATNumber></VATNumber>
        <website></website>
        <notes></notes>
        <debtors>
            <debtor>
                <name></name>
                <attn></attn>
                <address></address>
                <postcode></postcode>
                <city></city>
                <country></country>
                <currency></currency>
                <debtorNumber></debtorNumber>
                <email></email>
            </debtor>
        </debtors>
        <contactPersons>
            <contactPerson>
                <name></name>
                <position></position>
                <organisationalUnit></organisationalUnit>
                <telephone></telephone>
                <mobile></mobile>
                <email></email>
                <birthDate></birthDate>
                <communication1></communication1>
                <communication2></communication2>
                <communication3></communication3>
                <communication4></communication4>
                <communication5></communication5>
                <notes></notes>
            </contactPerson>
        </contactPersons>
    </company>
</request>

Parameter	Description	Required
token	Token for this request	yes
company/code	Company code	yes
company/name	Company name	yes
company/isDebtor	Yes or no. Marks if this company is a debtor	no
company/language	Language (iso code)	no
company/contactPerson	Contact (an existing resource)	no
company/parent	The parent company (an existing company)	no
company/industry	Industry (attribute value)	no
company/type	Type (attribute value)	no
company/mailingAttn	Contact person office address	no
company/mailingAddress	Office address	no
company/mailingPostcode	Postcode office address	no
company/mailingCity	City office address	no
company/mailingCountry	Country office address	no
company/officeAttn	Contact t.b.v. bezoekadres	no
company/officeAddress	Address	no
company/officePostcode	Postcode address	no
company/officeCity	City address	no
company/officeCountry	Country address	no
company/telephone	Telephone	no
company/fax	Fax	no
company/VATNumber	VAT number	no
company/website	URL website	no
company/notes	Remarks	no
debtor/name	Debitor name	no
debtor/attn	Contact person for invoices	no
debtor/address	Invoice address	no
debtor/postcode	Postcode invoice address	no
debtor/city	City invoice address	no
debtor/country	Country invoice address	no
debtor/currency	Debtor currency	no
debtor/debtorNumber	Debtor number	no
debtor/email	Debtor email	no
contactPerson/name	Contact person name	no
contactPerson/position	Position	no
contactPerson/organisationalUnit	Departments	no
contactPerson/telephone	Telephone	no
contactPerson/mobile	Mobile	no
contactPerson/email	Email	no
contactPerson/birthDate	Day of birth. Format: yyyymmdd	no
contactPerson/communication1 – 5	Code or name. Attribute value	no
contactPerson/notes	Notes	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/

Goal
Getting a company with all fields.

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 company	yes

The following xml structure is received after an successful execution:

<token></token>
<company>
    <code></code>
    <name></name>
    <isDebtor></isDebtor>
    <language></language>
    <contactPerson></contactPerson>
    <parent></parent>
    <industry></industry>
    <type></type>
    <mailingAttn></mailingAttn>
    <mailingAddress></mailingAddress>
    <mailingPostcode></mailingPostcode>
    <mailingCity></mailingCity>
    <mailingCountry></mailingCountry>
    <officeAttn></officeAttn>
    <officeAddress></officeAddress>
    <officePostcode></officePostcode>
    <officeCity></officeCity>
    <officeCountry></officeCountry>
    <telephone></telephone>
    <fax></fax>
    <VATNumber></VATNumber>
    <website></website>
    <notes></notes>
    <debtors>
        <debtor>
            <name></name>
            <attn></attn>
            <address></address>
            <postcode></postcode>
            <city></city>
            <country></country>
            <currency></currency>
            <debtorNumber></debtorNumber>
        </debtor>
    </debtors>
</company>

Parameter	Description
token	Token for this request
company/code	Company code
company/Name	Company name
company/isDebtor	Yes or no. Marks if this company is a debtor
company/language	Language
company/contactPerson	Contact (an existing resource)
company/parent	The parent company (an existing company)
company/industry	Industry (attribute value)
company/type	Type (attribute value)
company/mailingAttn	Contact person office address
company/mailingAddress	Office address
company/mailingPostcode	Postcode office address
company/mailingCity	City office address
company/mailingCountry	Country office address
company/officeAttn	Contact t.b.v. bezoekadres
company/officeAddress	Address
company/officePostcode	Postcode address
company/officeCity	City address
company/officeCountry	Country address
company/telephone	Telephone
company/fax	Fax
company/VATNumber	VAT number
company/website	URL website
company/notes	Remarks
debtor/name	Debitor name
debtor/attn	Contact person for invoices
debtor/address	Invoice address
debtor/postcode	Postcode invoice address
debtor/city	City invoice address
debtor/country	Country invoice address
debtor/currency	Debtor currency
debtor/debtorNumber	Debtor number

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/

Goal
Update existing companies

Request
The following xml structure must be provided:

<request>
    <token></token>
    <company></company>
    <item>
        <code></code>
        <name></name>
        <isDebtor></isDebtor>
        <language></language>
        <contactPerson></contactPerson>
        <parent></parent>
        <industry></industry>
        <type></type>
        <mailingAttn></mailingAttn>
        <mailingAddress></mailingAddress>
        <mailingPostcode></mailingPostcode>
        <mailingCity></mailingCity>
        <mailingCountry></mailingCountry>
        <officeAttn></officeAttn>
        <officeAddress></officeAddress>
        <officePostcode></officePostcode>
        <officeCity></officeCity>
        <officeCountry></officeCountry>
        <telephone></telephone>
        <fax></fax>
        <VATNumber></VATNumber>
        <website></website>
        <notes></notes>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
company	Code or name	yes
code	Company code	no
name	Company name	no
isDebtor	Yes or no. Marks if this company is a debtor	no
language	Language (iso code)	no
contactPerson	Contact (an existing resource)	no
parent	The parent company (an existing company)	no
industry	Industry (attribute value)	no
type	Type (attribute value)	no
mailingAttn	Contact person office address	no
mailingAddress	Office address	no
mailingPostcode	Postcode office address	no
mailingCity	City office address	no
mailingCountry	Country office address	no
officeAttn	Contact t.b.v. bezoekadres	no
officeAddress	Address	no
officePostcode	Postcode address	no
officeCity	City address	no
officeCountry	Country address	no
telephone	Telephone	no
fax	Fax	no
VATNumber	VAT number	no
website	URL 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/

Goal
Getting a list with companies.

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>
        <code></code>
        <name></name>
    </companies>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
company/code	Company code
company/name	Company name

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_based_on_template#

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

Goal
Adding new projects 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. The project template on which the new project is based	yes
project/code	Project code	yes
project/name	Project name	yes
project/company	Code or name. The company/customer for this project	yes
project/parentProject	Code or name. The parent project for this project	no
project/organisationalUnit	Code or name. The organizational unit where the project belongs	yes
project/projectManager	Code or name. Project manager of the project (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	yyyymmdd. Basis for the project planning	When project/generateProjectPlanning = 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
error	Reason why the service has executed unsuccessfully

project/get#

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

Goal
Getting a project with all fields.

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	Project code	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>
        <approveExpenses></approveExpenses>
        <approveCalenderEntries></approveCalenderEntries>
        <orgUnitManagerIsApprover></orgUnitManagerIsApprover>
        <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>
        <emailContactPerson></emailContactPerson>
        <externalLinkFiles></externalLinkFiles>
        <invoice>
            <responsible></responsible>
            <backupResponsible></backupResponsible>
            <debtor>
                <attn></attn>
                <name></name>
                <address></address>
                <postcode></postcode>
                <city></city>
                <country></country>
                <debtorNumber></debtorNumber>
                <email></email>
            </debtor>
            <invoiceLayout></invoiceLayout>
            <invoiceLayoutCreditnote></invoiceLayoutCreditnote>
            <invoicetypeHours></invoicetypeHours>
            <invoicetypeKM></invoicetypeKM>
            <invoicetypeKMRate></invoicetypeKMRate>
            <invoicetypeExpenses></invoicetypeExpenses>
            <VATSalesHours></VATSalesHours>
            <VATSalesExpenses></VATSalesExpenses>
            <reference1></reference1>
            <reference2></reference2>
            <reference3></reference3>
            <reference4></reference4>
            <reference5></reference5>
        </invoice>
        <portfolio>
            <code></code>
            <name></name>
        </portfolio>
    </project>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project/code	Project code
project/name	Project name
project/useInvoicing	Yes or no. Is it possible to invoice from this project?
project/chargeable	Yes or no. Is this project chargeable?
project/approveTime	Yes or no. Do submitted hours need to be approved?
project/approveExpenses	Yes or no. Do submitted expenses need to be approved?
project/approveCalenderEntries	Yes or no. Can calendar entries beapproved?
project/orgUnitManagerIsApprover	Yes or no
project/blockEntries	Yes or no. Blocks making bookings on the proejct
project/isTemplate	Yes or no. Can this project be used as a template for new projects?
project/isActive	Yes or no. Is the project active?
project/startDate	yyyymmdd. Start date of the project
project/endDate	yyyymmdd. End dat of the project
project/notes	Remarks
project/company	The company/customer name for this project
project/organisationalUnit	Name. The organizational unit where the project belongs
project/projectManager	Name. Project manager of the project (Resource)
project/currency	Project currency
project/parentProject	Name. The parent project (Project)
project/status	Project status (Attributes)
project/color	Project color (hexadecimal value)
project/externalLinkFiles	URL to an online file location
project/status	Status (Attribute)
invoice/blockInvoice	Yes or no. Block invoices for this project?
invoice/backupResponsible	Name. Who is also allowed to start the invoice run
invoice/debtor/name, address, postcode, city, country, debtorNumber and email	Adres of the debtor (company, debtor role)
invoice/invoiceLayout	Name. Invoice lay-out for the invoice
invoice/invoiceLayoutCreditnote	Name. Invoice lay-out for the credit note
invoice/invoicetypeHours	Type hours (Attributes)
invoice/invoicetypeKM	Yes or no. Do kilometers have to be invoiced?
invoice/invoicetypeKMRate	Rate per kilometer
invoice/invoicetypeExpenses	Yes or no. Do expenses have to be invoiced?
invoice/VATSalesHours	Name. What VAT percentage to apply for hours.
invoice/VATSalesExpenses	Name. What VAT percentage to apply for expenses.
invoice/reference1	Invoice reference 1
invoice/reference2	Invoice reference 2
invoice/reference3	Invoice reference 3
invoice/reference4	Invoice reference 4
invoice/reference5	Invoice reference 5
portfolio/code	Code of the portfolio
portfolio/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/

Goal
Getting a list of all changed projects in a specific 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	yes
dateTo	Add or modification date to. Format: yyyymmdd.	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	Project code
project/name	Project name

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/

Goal
Getting 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	Project code
project/name	Project name

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/

Goal
Updating an existing project.

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <item>
        <code></code>
        <name></name>
        <useTimePlanning></useTimePlanning>
        <useResourceBudget></useResourceBudget>
        <useInvoicing></useInvoicing>
        <approveTime></approveTime>
        <approveExpenses></approveExpenses>
        <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>
        <invoice>
            <blockInvoice></blockInvoice>
            <responsible></responsible>
            <backupResponsible></backupResponsible>
            <debtor></debtor>
            <invoiceLayout></invoiceLayout>
            <invoiceLayoutCreditnote></invoiceLayoutCreditnote>
            <invoicetypeHours></invoicetypeHours>
            <invoicetypeKM></invoicetypeKM>
            <invoicetypeKMRate></invoicetypeKMRate>
            <invoicetypeExpenses></invoicetypeExpenses>
            <VATSalesHours></VATSalesHours>
            <VATSalesExpenses></VATSalesExpenses>
            <reference1></reference1>
            <reference2></reference2>
            <reference3></reference3>
            <reference4></reference4>
            <reference5></reference5>
        </invoice>
    </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	The new code for the project	yes
project/name	Project name	yes
project/approveTime	Yes or no. Do submitted hours need to be approved?	no
project/approveExpenses	Yes or no. Do submitted expense need to be approved?	no
project/blockEntries	Yes or no. Blocks making bookings 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	yyyy-mm-dd. Start date of the project	no
project/endDate	yyyy-mm-dd. End dat of the project	no
project/notes	Remarks	no
project/company	Code or name. The company/customer for this project	yes
project/organisationalUnit	Code or name. The organizational unit where the project belongs	yes
project/projectManager	Code or name. Project manager of the project (Resource)	yes
project/currency	Project currency	yes
project/parentProject	Code or name. The parent project(Project)	no
project/status	Project status (Attributes)	no
project/color	Project color (hexadecimal value)	no
project/externalLinkFiles	URL to an online file location	no
project/emailContactPerson	Email of the (external) contact person	no
invoice/blockInvoice	Yes or no. Block invoices for this project?	no
invoice/responsible	Code or name. Who is allowed to start the invoice run	yes, when project/useInvoicing = yes
invoice/backupResponsible	Code or name. Who is also allowed to start the invoice run	no
invoice/debtor	Name of the debtor (company)	yes, when project/useInvoicing = yes
invoice/invoiceLayout	Code or name. Invoice lay-out for the invoice	no
invoice/invoiceLayoutCreditnote	Code or name. Invoice lay-out for the credit note	no
invoice/invoicetypeHours	Type hours (Attributes)	no
invoice/invoicetypeKM	Yes or no. Do kilometers have to be invoiced?	no
invoice/invoicetypeKMRate	Rate per kilometer	yes, when invoice/invoicetypeKM = yes
invoice/invoicetypeExpenses	Yes or no. Do expenses have to be invoiced?	no
invoice/VATSalesHours	Code or name. What VAT percentage to apply for hours	no
invoice/VATSalesExpenses	Code or name. What VAT percentage to apply for expenses	no
invoice/reference1	Invoice reference 1	no
invoice/reference2	Invoice reference 2	no
invoice/reference3	Invoice reference 3	no
invoice/reference4	Invoice reference 4	no
invoice/reference5	Invoice reference 5	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/

Goal
Removing 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	Project code	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/

Goal
Adding new activities (breakdowns) to a projects

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <breakdowns>
        <breakdown>
            <code></code>
            <name></name>
            <parentBreakdown></parentBreakdown>
            <accountingType></accountingType>
            <status></status>
            <plannedHours></plannedHours>
            <plannedRate></plannedRate>
            <rateIsCommercialRate></rateIsCommercialRate>
            <useNumbersInProgress></useNumbersInProgress>
            <budgetNumbers></budgetNumbers>
            <teamManager></teamManager>
            <isDeliverable></isDeliverable>
            <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>
        </breakdown>
    </breakdowns>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name of the Project	yes
breakdowns/breakdown/code	Code of the activity	yes
breakdowns/breakdown/name	Name of the activity	yes
breakdowns/breakdown/parentBreakdown	Code or name. The main activity. Should already exist	no
breakdowns/breakdown/accountingType	Code or name. Attribute	no
breakdowns/breakdown/status	Code or name. Attribute	no
breakdowns/breakdown/plannedHours	Budgeted hours	no
breakdowns/breakdown/plannedRate	Budget rate	no
breakdowns/breakdown/rateIsCommercialRate	Yes or no. Planned rate = commercial rate.	no
breakdowns/breakdown/useNumbersInProgress	Yes or no. Progress must be reported in numbers.	no
breakdowns/breakdown/budgetNumbers	In case useNumbersInProgress = Yes, budgeted numbers.	no
breakdowns/breakdown/teamManager	Code or name. Resource has to be added to the project (project/resource/add)	no
breakdowns/breakdown/isDeliverable	Yes or no. Marks if this activity is a deliverable.	no
breakdowns/breakdown/isMilestone	Yes or no. Marks if this activity is a milestone.	no
breakdowns/breakdown/color	Color of this activity (hexadecimal value).	no
breakdowns/breakdown/blockPosting	Yes or no. Is the activity blocked for making bookings?	no
breakdowns/breakdown/useResourceEntries	Yes or no. Is it possible to plan resources on the activity.	no
breakdowns/breakdown/useProjectPlanning	Yes or no. Is it possible to use this activity in project planning.	no
breakdowns/breakdown/invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing.	no
breakdowns/breakdown/invoiceDate	When breakdowns/breakdown/invoiceType = Fixed price. Invoice date for the activity.	no
breakdowns/breakdown/invoiceAmount	When breakdowns/breakdown/invoiceType = Fixed price. Amount to be invoiced.	no
breakdowns/breakdown/notes	Text. Activity comment.	no
breakdowns/breakdown/requestOrganisationalUnit	The Department (Organisational Unit) for the request.	no
breakdowns/breakdown/requestPosition	The requested position for the request.	no
breakdowns/breakdown/requestSkillLevel1	The requested skillLevel 1 for the request.	no
breakdowns/breakdown/requestSkillLevel2	The requested skillLevel 2 for the request.	no
breakdowns/breakdown/requestSkillLevel3	The requested skillLevel 3 for the request.	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/

Goal
Getting an activity (breakdown) with all fields.

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>
        <code></code>
        <name></name>
        <parentBreakdown></parentBreakdown>
        <isMilestone></isMilestone>
        <blockPosting></blockPosting>
        <useResourceEntries></useResourceEntries>
        <useProjectPlanning></useProjectPlanning>
        <invoiceType></invoiceType>
        <invoiceDate></invoiceDate>
        <invoiceAmount></invoiceAmount>
        <invoiceStatus></invoiceStatus>
        <status></status>
        <teamManager></teamManager>
        <budgetHours></budgetHours>
        <budgetRate></budgetRate>
        <teamManager></teamManager>
        <rateIsCommercialRate></rateIsCommercialRate>
        <useNumbersInProgress></useNumbersInProgress>
        <budgetNumbers></budgetNumbers>
        <accountingType></accountingType>
        <notes></notes>
        <requestOrganisationalUnit></requestOrganisationalUnit>
        <requestPosition></requestPosition>
        <requestSkillLevel1></requestSkillLevel1>
        <requestSkillLevel2></requestSkillLevel2>
        <requestSkillLevel3></requestSkillLevel3>
        <rates>
            <rate>
                <resourceCode></resourceCode>
                <resourceName></resourceName>
                <commercialRate></commercialRate>
            </rate>
        </rates>
    </breakdown>
</response>

Parameter	Description
token	Token for this request
id	ID of the activity
code	Code of the activity
name	Name of the activity
parentBreakdown	Name of the main activity
isMilestone	Yes or no
breakdown/blockPosting	Yes or no. Is the activity blocked for making bookings?
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing
invoiceDate	When invoiceType = Fixed price. Invoice date for the activity
invoiceAmount	When invoiceType = Fixed price. Amount to be invoiced
invoiceStatus	Status of the invoice. Options: none, open, proposed or invoiced
status	Attribute value
teamManager	Resource name
budgetHours	Budgeted hours
budgetRate	Budget rate
accountingType	Time, expenses or time_expenses
rateIsCommercialRate	Yes or no. Budgeted rate = commercial rate
useNumbersInProgress	Yes or no. Progress must be reported in numbers
budgetNumbers	In case useNumbersInProgress = Yes, budgeted numbers
useResourceEntries	Yes or no. Is it possible to plan resources on the activity
useProjectPlanning	Yes or no. Is it possible to use this activity in Gantt chart, project planning
notes	Text. Activity comment
requestOrganisationalUnit	The Department, Organisational Unit for the request
requestPosition	The requested position for the request
requestSkillLevel1	The requested skillLevel 1 for the request
requestSkillLevel2	The requested skillLevel 2 for the request
requestSkillLevel3	The requested skillLevel 3 for the request

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/

Goal
Getting a list with all activities (breakdowns) 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. The project for this request	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <breakdowns>
        <breakdown>
            <id></id>
            <code></code>
            <name></name>
            <parentBreakdown></parentBreakdown>
            <parentBreakdownCode></parentBreakdownCode>
            <parentBreakdownName></parentBreakdownName>
            <accountingType></accountingType>
            <status></status>
            <color></color>
            <plannedHours></plannedHours>
            <plannedRate></plannedRate>
            <teamManager></teamManager>
            <isMilestone></isMilestone>
            <blockPosting></blockPosting>
            <blockInvoice></blockInvoice>
            <useResourceEntries></useResourceEntries>
            <invoiceType></invoiceType>
            <invoiceDate></invoiceDate>
            <invoiceAmount></invoiceAmount>
            <notes></notes>
            <requestOrganisationalUnit></requestOrganisationalUnit>
            <requestPosition></requestPosition>
            <requestSkillLevel1></requestSkillLevel1>
            <requestSkillLevel2></requestSkillLevel2>
            <requestSkillLevel3></requestSkillLevel3>
            <rates></rates>
            <rates></rates>
            <resourceCode></resourceCode>
            <resourceName></resourceName>
            <commercialRate></commercialRate>
            <rate></rate>
            <rates></rates>
        </breakdown>
    </breakdowns>
</response>

Parameter	Description
valid	Indication that service was executed successfully
breakdowns/breakdown/id	The id of the activity
breakdowns/breakdown/code	Code of the activity
breakdowns/breakdown/name	Name of the activity
breakdowns/breakdown/parentBreakdown	The id of the main activity
breakdowns/breakdown/parentBreakdownCode	The code of the main activity
breakdowns/breakdown/parentBreakdownName	The name of the main activity
breakdowns/breakdown/accountingType	Code or name. Attribute
breakdowns/breakdown/status	Code or name. Attribute
breakdowns/breakdown/color	Activity color (hexadecimal value)
breakdowns/breakdown/plannedHours	Budgeted hours
breakdowns/breakdown/plannedRate	Budget rate
breakdowns/breakdown/teamManager	Code or name. Resource has to be added to the project (project/resource/add)
breakdowns/breakdown/isDeliverable	Yes or no. Marks if this activity is a deliverable
breakdowns/breakdown/blockPosting	Yes or no. Is the activity blocked for making bookings?
breakdowns/breakdown/useResourceEntries	Yes or no. Is it possible to make resource bookings on the activity
breakdowns/breakdown/invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing
breakdowns/breakdown/invoiceDate	When breakdowns/breakdown/invoiceType = Fixed price. Invoice date for the activity
breakdowns/breakdown/invoiceAmount	When breakdowns/breakdown/invoiceType = Fixed price. Amount to be invoiced
breakdowns/breakdown/notes	Text. Activity comment
breakdowns/breakdown/requestOrganisationalUnit	The Department, Organisational Unit for the request
breakdowns/breakdown/requestPosition	The requested position for the request
breakdowns/breakdown/requestSkillLevel1	The requested skillLevel 1 for the request
breakdowns/breakdown/requestSkillLevel2	The requested skillLevel 2 for the request
breakdowns/breakdown/requestSkillLevel3	The requested skillLevel 3 for the request
breakdowns/breakdown/rates/rate/resourceCode	The code of the resource connected to the activity
breakdowns/breakdown/rates/rate/resourceName	The name of the resource connected to the activity
breakdowns/breakdown/rates/rate/commercialRate	The commercial rate of the resource connected to the 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
Editing existing activities (breakdowns)

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project></project>
    <Breakdown></Breakdown>
    <item>
        <code></code>
        <name></name>
        <parentBreakdown></parentBreakdown>
        <accountingType></accountingType>
        <status></status>
        <plannedHours></plannedHours>
        <plannedRate></plannedRate>
        <rateIsCommercialRate></rateIsCommercialRate>
        <useNumbersInProgress></useNumbersInProgress>
        <budgetNumbers></budgetNumbers>
        <teamManager></teamManager>
        <isDeliverable></isDeliverable>
        <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. The parent activity. Should already exist	no
accountingType	Code or name. Attribute	no
status	Code or name. Attribute	no
plannedHours	Budgeted hours	no
plannedRate	Budget rate	no
rateIsCommercialRate	Yes or no. Planned rate = commercial rate	no
useNumbersInProgress	Yes or no. Progress must be reported in numbers	no
budgetNumbers	In case useNumbersInProgress = Yes, budgeted numbers	no
teamManager	Code or name. Resource has to be added to the project (project/resource/add)	no
isDeliverable	Yes or no. Marks if this activity is a deliverable	no
isMilestone	Yes or no. Marks if this activity is a milestone	no
color	The color of this activity (hexadecimal value)	no
blockPosting	Yes or no. Is the activity blocked for making bookings?	no
useResourceEntries	Yes or no. Is it possible to plan resources on the activity	no
useProjectPlanning	Yes or no. Is it possible to use this activity in project planning	no
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing	no
invoiceDate	When breakdowns/breakdown/invoiceType = Fixed price. Invoice date for the activity	no
invoiceAmount	When breakdowns/breakdown/invoiceType = Fixed price. Amount to be invoiced	no
breakdown/notes	Text. activity comment	no
requestOrganisationalUnit	The Department (Organisational Unit) for the request	no
requestPosition	The requested position for the request	no
equestSkillLevel1	The requested skillLevel 1 for the request	no
requestSkillLevel2	The requested skillLevel 2 for the request	no
requestSkillLevel3	The requested skillLevel 3 for the request	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/authorization/add#

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

Goal
Authorizing resource for an activity (breakdown)

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 to authorize for 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/remove#

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

Goal
Removing the authorisation for resources from an activity (breakdown)

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 to update	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/

Goal
Adding resources to a projects

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	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/add#

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

Goal
Adding new projects

Request
The following xml structure must be provided:

<request>
    <token></token>
    <project>
        <code></code>
        <name></name>
        <useTimePlanning></useTimePlanning>
        <useResourceBudget></useResourceBudget>
        <useInvoicing></useInvoicing>
        <chargeable></chargeable>
        <approveTime></approveTime>
        <approveExpenses></approveExpenses>
        <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>
        <invoice>
            <blockInvoice></blockInvoice>
            <responsible></responsible>
            <backupResponsible></backupResponsible>
            <debtor></debtor>
            <invoiceLayout></invoiceLayout>
            <invoiceLayoutCreditnote></invoiceLayoutCreditnote>
            <invoicetypeHours></invoicetypeHours>
            <invoicetypeKM></invoicetypeKM>
            <invoicetypeKMRate></invoicetypeKMRate>
            <invoicetypeExpenses></invoicetypeExpenses>
            <VATSalesHours></VATSalesHours>
            <VATSalesExpenses></VATSalesExpenses>
            <reference1></reference1>
            <reference2></reference2>
            <reference3></reference3>
            <reference4></reference4>
            <reference5></reference5>
        </invoice>
    </project>
</request>

Parameter	Description	Required
token	Token for this request	yes
project/code	Project code	yes
project/name	Project name	yes
project/useInvoicing	Yes or no. Is it possible to invoice from this 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/approveExpenses	Yes or no. Do submitted expense need to be approved?	no
project/blockEntries	Yes or no. Blocks making bookings on the proejct	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	yyyymmdd. Start date of the project	no
project/endDate	yyyymmdd. End dat of the project	no
project/notes	Remarks	no
project/company	Code or name. The company/customer for this project	yes
project/organisationalUnit	Code or name. The organizational unit where the project belongs	yes
project/projectManager	Code or name. Project manager of the project (Resource)	yes
project/currency	Project currency	yes
project/parentProject	Code or name. The parent project(Project)	no
project/status	Project status (Attributes)	no
project/color	Project color (hexadecimal value)	no
project/externalLinkFiles	URL to an online file location	no
project/emailContactPerson	Email of the (external) contact person	no
invoice/blockInvoice	Yes or no. Block invoices for this project?	no
invoice/responsible	Code or name. Who is allowed to start the invoice run	yes, when project/useInvoicing = yes
invoice/backupResponsible	Code or name. Who is also allowed to start the invoice run	no
invoice/debtor	Name of the debtor (company)	yes, when project/useInvoicing = yes
invoice/invoiceLayout	Code or name. Invoice lay-out for the invoice	no
invoice/invoiceLayoutCreditnote	Code or name. Invoice lay-out for the credit note	no
invoice/invoicetypeHours	Type hours (Attributes)	no
invoice/invoicetypeKM	Yes or no. Do kilometers have to be invoiced?	no
invoice/invoicetypeKMRate	Rate per kilometer	yes, when invoice/invoicetypeKM = yes
invoice/invoicetypeExpenses	Yes or no. Do expenses have to be invoiced?	no
invoice/VATSalesHours	Code or name. What VAT percentage to apply for hours	no
invoice/VATSalesExpenses	Code or name. What VAT percentage to apply for expenses	no
invoice/reference1	Invoice reference 1	no
invoice/reference2	Invoice reference 2	no
invoice/reference3	Invoice reference 3	no
invoice/reference4	Invoice reference 4	no
invoice/reference5	Invoice reference 5	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/list#

Service

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

Goal
Getting 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 project which are in use as a Parent project	no
isActive	Yes or No. Selects only project which are marked as active	no
portfolio	Code or name. Selects only projects from a specific 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	Project code
project/name	Project name

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

Resources#

resource/add#

Service

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

Goal
Adding new resources

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource>
        <type></type>
        <code></code>
        <name></name>
        <firstNames></firstNames>
        <email></email>
        <organisationalUnit></organisationalUnit>
        <position></position>
        <infix></infix>
        <titleBefore></titleBefore>
        <titleAfter></titleAfter>
        <gender></gender>
        <language></language>
        <privateAddress></privateAddress>
        <privatePostcode></privatePostcode>
        <privateCity></privateCity>
        <privateCountry></privateCountry>
        <privateTelephone></privateTelephone>
        <privateMobile></privateMobile>
        <privateEmail></privateEmail>
        <birthDate></birthDate>
        <businessTelephone></businessTelephone>
        <businessMobile></businessMobile>
        <startDate></startDate>
        <endDate></endDate>
        <employeeNumber></employeeNumber>
        <bankAccountNumber></bankAccountNumber>
        <backupTime></backupTime>
        <backupExpenses></backupExpenses>
        <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>
        <profiles>
            <profile></profile>
        </profiles>
    </resource>
</request>

Parameter	Description	Required
token	Token for this request	Yes
type	Resource type. Options: person or material. When left empty default is person	No
code	The code of the resource	Yes
name	Resource name	Yes
firstNames	Resource first name	Yes
email	Email. Must be unique	Yes
organisationalUnit	Code or name of the organisational unit	Yes
position	Code or name of the position of the resource	Yes
infix	Infix	No
titleBefore	Title before	No
titleAfter	Title after	No
gender	Gender. Options Male/Female or M/F	No
language	Code or name	No
privateAddress	Private address	No
privatePostcode	Private postcode	No
privateCity	Private City	No
privateCountry	Private Country	No
privateTelephone	Private telephone	No
privateMobile	Private mobile number	No
privateEmail	Private email	No
birthDate	Date of birth. Format: yyyymmdd	No
businessTelephone	Business telephone	No
businessMobile	Business mobile	No
startDate	Start date for the resource. Format yyyymmdd	Yes
endDate	End date for the resource. Format yyyymmdd	No
employeeNumber	Employee number	No
bankAccountNumber	Bank accountnumber	No
backupTime	Code or name, must be an existing resource	No
backupExpenses	Code or name, must be an existing resource	No
regionCalendar	Code or name. Applicable region calendar.	No
externalResource	Yes or no.	No
sendEmailNotificationDueTimesheets	Yes or no	No
workingHoursMon	Number of hours	No
workingHoursTue	Number of hours	No
workingHoursWed	Number of hours	No
workingHoursThu	Number of hours	No
workingHoursFri	Number of hours	No
workingHoursSat	Number of hours	No
workingHoursSun	Number of hours	No
startTimeMon	Default start time. Format hh:mm	No
startTimeTue	Default start time. Format hh:mm	No
startTimeWed	Default start time. Format hh:mm	No
startTimeThu	Default start time. Format hh:mm	No
startTimeFri	Default start time. Format hh:mm	No
startTimeSat	Default start time. Format hh:mm	No
startTimeSun	Default start time. Format hh:mm	No
color	Resource color (hexadecimal value)	No
profiles/profile	Code or name. Applicable profile	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/

Goal
Editing existing resources

Request
The following xml structure must be provided:

<request>
    <token></token>
    <resource></resource>
    <item>
        <code></code>
        <lastName></lastName>
        <firstNames></firstNames>
        <initials></initials>
        <email></email>
        <infix></infix>
        <titleBefore></titleBefore>
        <titleAfter></titleAfter>
        <gender></gender>
        <language></language>
        <privateAddress></privateAddress>
        <privatePostcode></privatePostcode>
        <privateCity></privateCity>
        <privateCountry></privateCountry>
        <privateTelephone></privateTelephone>
        <privateMobile></privateMobile>
        <privateEmail></privateEmail>
        <birthDate></birthDate>
        <businessTelephone></businessTelephone>
        <businessMobile></businessMobile>
        <startDate></startDate>
        <endDate></endDate>
        <employeeNumber></employeeNumber>
        <bankAccountNumber></bankAccountNumber>
        <backupTime></backupTime>
        <backupExpenses></backupExpenses>
        <productivity></productivity>
        <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>
    </item>
</request>

regionCalendarCode or name. Applicable region calendar.No

Parameter	Description	Required
token	Token for this request	Yes
Resource	Code or name of the resource	Yes
code	The code of the resource	No
LastName	Resource last name	No
firstNames	Resource first name	No
initials	Initials of the resource	No
email	Email. Must be unique	No
infix	Infix	No
titleBefore	Title before	No
titleAfter	Title after	No
gender	Gender. Options Male/Female or M/F	No
language	Code or name	No
privateAddress	Private address	No
privatePostcode	Private postcode	No
privateCity	Private City	No
privateCountry	Private Country	No
privateTelephone	Private telephone	No
privateMobile	Private mobile number	No
privateEmail	Private email	No
birthDate	Date of birth. Format: yyyymmdd	No
businessTelephone	Business telephone	No
businessMobile	Business mobile	No
startDate	Start date for the resource. Format: yyyymmdd	No
endDate	End date for the resource. Format: yyyymmdd	No
employeeNumber	Employee number	No
bankAccountNumber	Bank accountnumber	No
backupTime	Code or name, must be an existing resource	No
backupExpenses	Code or name, must be an existing resource	No
externalResource	Yes or no	No
sendEmailNotificationDueTimesheets	Yes or no	No
workingHoursMon	Number of hours	No
workingHoursTue	Number of hours	No
workingHoursWed	Number of hours	No
workingHoursThu	Number of hours	No
workingHoursFri	Number of hours	No
workingHoursSat	Number of hours	No
workingHoursSun	Number of hours	No
startTimeMon	Default start time. Format hh:mm	No
startTimeTue	Default start time. Format hh:mm	No
startTimeWed	Default start time. Format hh:mm	No
startTimeThu	Default start time. Format hh:mm	No
startTimeFri	Default start time. Format hh:mm	No
startTimeSat	Default start time. Format hh:mm	No
startTimeSun	Default start time. Format hh:mm	No
color	Resource color (hexadecimal value)	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/organisationalunit/add#

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

Goal
Adding an organisatinal unit to a resource

Request
The following xml structure must be provided:

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

Fore nameInfixPrivate telephonePrivate mobileEnd date for the resource. Format yyyymmddEmployee NumberNumber of holiday hours previous yearYes or noYes or noDefault start time. Format hh:mmDefault start time. Format hh:mm

Parameter	Description	Required
token	Token for this request	Yes
resource	The resource code, name or email	yes
item/organisationalUnit	Code or name	Yes
item/date	Start date, Format: yyyymmdd	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/edit#

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

Goal
Editing the organisational units start date for a resource

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	Yes
resource	The resource code, name or email	yes
organisationalUnit	Code or name	Yes
date	Start date, Format: yyyymmdd or yyyy-mm-dd	Yes
item/date	Start date, 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/organisationalunit/remove#

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

Goal
Remove an organisational unit from a resource

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
resource	The resource code, name or email	yes
organisationalUnit	Code or name	yes
date	Start date for the organisational unit	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/

Goal
Adding 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	The resource code, name or email	yes
item/position	Code or name	yes
item/date	Start date, Format: yyyymmdd	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/edit#

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

Goal
Editing the start date of a position for a resources

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
resource	The resource code, name or email	yes
position	Code or name	yes
date	Start date, Format: yyyymmdd or yyyy-mm-dd	yes
item/date	Start date, 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/remove#

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

Goal
Remove a position from a resource

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	Yes
resource	The resource code, name or email	yes
position	Code or name	Yes
Date	Start date for this position	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/

Goal
Adding 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	The resource code, name or email	yes
item/skill	Code or name	yes
item/level	Code or name	yes
item/date	Start date, Format: yyyymmdd	yes
item/endDate	End date, Format: yyyymmdd	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/skilllevel/edit#

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

Goal
Editing a skill of a resources

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
resource	The resource code, name or email	yes
skill	Code or name	yes
level	Code or name	yes
date	Start date, Format: yyyymmdd or yyyy-mm-dd	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/skilllevel/remove#

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

Goal
Remove an existing contact persons from a company

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
company	Code or name of the company	yes
contactPerson	Name contact person to remove	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

resource/get#

Service

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

Goal
Getting a resource with all fields.

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>
        <titleBefore></titleBefore>
        <titleAfter></titleAfter>
        <isMaterial</isMaterial>
        <gender></gender>
        <contactPerson></contactPerson>
        <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>
        <socialSecurityNumbe>
        </socialSecurityNumber>
        <bankAccountNumber></bankAccountNumber>
        <backupTime></backupTime>
        <backupExpenses></backupExpenses>
        <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>

Parameter	Description
valid	Indication that service was executed successfully
email	Resource email
code	Resource code
lastName	Resource last name
firstNames	Resource first names
infix	Resource infix
titleBefore	Resource title before
titleAfter	Resource title after
isMaterial	Yes or no, is this Resource a material
gender	Resource gender
contactPerson	Contact person (existing resource)
privateAddress	Resource private address
privatePostcode	Resource private postcode
privateCity	Resource private city
privateCountry	Resource private country
privateTelephone	Resource private telephone
privateMobile	Resource private mobile
privateEmail	Resource private email
birthDate	Resource birthDate
businessTelephone	Resource business telephone
businessMobile	Resource business mobile
isActive	Yes or no, is this resource active?
startDate	Resource start date
endDate	Resource end date
employeeNumber	Resource employee number
bankAccountNumber	Resource bankaccountnumber
backupTime	Backup resource for time
backupExpenses	Backup resource for expenses
regionCalendar	Region calendar
isExternalResource	Yes or no, is this resource external?
sendEmailNotificationDueTimesheets	Yes or no, send an email when timesheets are due
workingHoursMonday – Sunday	Working hours per day
startTimeMonday – Sunday	Default start time per day
color	Resource color
activeOrganisationalunit	Code of the active department
organisationalUnits/organisationalUnit/code	Code of the department
organisationalUnits/organisationalUnit/name	Resource department
organisationalUnits/organisationalUnit/date	Start date for the department
activePosition	Code of the active position
positions/position/code	Resource position code
positions/position/name	Resource position
positions/position/date	Start date for the position
skills/skill/skill	Resource skill
skills/skill/level	Skill level
skills/skill/date	Start date for the skill
rates/rate/type	Type of the rate
rates/rate/date	Start date for the rate
rates/rate/currency	Currency
rates/rate/rate	The applicable rate

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/

Goal
Getting a list with all active resources.

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>
    <resources>
        <resource>
            <resourceID></resourceID>
            <code></code>
            <fullName></fullName>
            <lastName></lastName>
            <firstNames></firstNames>
            <infix></infix>
            <color></color>
        </resource>
    </resources>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
resourceID	The unique ID of the resource
code	Resource code
fullName	Full name
lastName	Last name
firstNames	First names
infix	Infix
color	Resource color (hexadecimal 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

Skill#

skill/add#

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

Goal
Adding a skill and level

Request
The following xml structure must be provided:

<request>
    <token></token>
    <skill>
        <code></code>
        <name></name>
        <description></description>
        <levels>
            <level>
                <code></code>
                <name></name>
                <description></description>
            </level>
        </levels>
    </skill>
</request>

Parameter	Description	Required
token	Token for this request	yes
code	The code of the skill	yes
name	Name of the skill	yes
description	Description of the skill	no
levels/level/code	The code of the level	yes
levels/level/name	The name of the level	yes
levels/level/description	The description of the level	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

skill/edit#

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

Goal
Editing an existing skill

Request
The following xml structure must be provided:

<request>
    <token></token>
    <skill></skill>
    <item>
        <code></code>
        <name></name>
        <description></description>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
skill	Code or name of the skill	yes
item/code	The code of the skill	yes
item/name	The name of the level	yes
item/description	The description of the level	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

skill/remove#

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

Goal
Remove a skill

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
skill	Code or name of the skill	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

skill/level/add#

Service
https://api.timewax.com/skill/level/add/

Goal
Adding a level to a skill

Request
The following xml structure must be provided:

<request>
    <token></token>
    <skill></skill>
    <item>
        <code></code>
        <name></name>
        <description></description>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
Skill	The code of the skill	yes
item/code	The code of the skill	yes
item/name	The name of the skill	yes
item/description	The description of the skill	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

skill/level/edit#

Service
https://api.timewax.com/skill/level/edit/

Goal
Editing a skill level

Request
The following xml structure must be provided:

<request>
    <token></token>
    <skill></skill>
    <level></level>
    <item>
        <code></code>
        <name></name>
        <description></description>
    </item>
</request>

Parameter	Description	Required
token	Token for this request	yes
skill	Code or name of the skill	yes
level	Code or name of the level	yes
item/code	The code of the skill	yes
item/name	The name of the skill	yes
item/description	The description of the skill	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

skill/level/remove#

Service
https://api.timewax.com/skill/level/remove/

Goal
Removing a skill level

Request
The following xml structure must be provided:

<request>
    <token></token>
    <skill></skill>
    <level></level>
</request>

Parameter	Description	Required
token	Token for this request	yes
skill	Code or name of the skill	yes
level	Code or name of the level	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 bookings#

calendar/entries/add#

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

Goal
Adding resource or project bookings in the calendar or the planning board.

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
type	Type of the booking. “entry” for resource bookings, “request” for request (= project) bookings	yes
resource	Code or name. The planned resource	When type= “entry”: yes
project	Code or name. The project for the booking	yes
breakdown	Code or name. The activity for the booking	yes
status	Hard or Soft. The status of the booking	yes
date	Date of the booking. Format: yyyymmdd	yes
timeFrome	Start time for the booking. Format: hh:mm	yes
hours	Number of hours	yes
fullDay	Yes or No.Marks the booking as “Full day”	no
Location	The location field	no
description	The description field	no
remarks	The remarks field	no
linkedResources/resource	Code or name.Only for request bookings. The resource(s) connected to the booking	no
requestOrganisationalUnit	The Organisational Unit for the request	no
requestSkillLevel1	The requestSkillLevel 1 for the request	no
requestSkillLevel2	The requestSkillLevel 2 for the request	no
requestSkillLevel3	The requestSkillLevel 3 for the request	no
needsAction	Yes or no. Marks if there is an action for this booking	no
actionsText	Description of the action	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/

Goal
Requesting resource or project bookings from the calendar or the planning board.

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	yes
dateTo	Date to. Format: yyyymmdd	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>
            <date></date>
            <resourceName></resourceName>
            <resourceCode></resourceCode>
            <resourceEmployeeNumber></resourceEmployeeNumber>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <type></type>
            <status></status>
            <approved></approved>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <remarks></remarks>
            <location></location>
            <actionFor></actionFor>
            <addDate></addDate>
            <modifyDate></modifyDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/date	The date of the booking
entries/entry/resourceName	Name of the booked resource
entries/entry/resourceCode	Code of the booked resource
entries/entry/resourceEmployeeNumber	The employee number of the booked resource
entries/entry/project	The project name
entries/entry/projectCode	The project code
entries/entry/breakdown	The activity name
entries/entry/breakdownCode	The activity code
entries/entry/breakdownParent	The name of the parent activity
entries/entry/breakdownParentCode	The code of the parent activity
entries/entry/type	Value from the field type
entries/entry/status	The status of the booking. Options: Hard or Soft
entries/entry/approved	Indication that the booking is approved. Options Yes or No
entries/entry/timeFrom	Starting 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/actionFor	Resource responsible for the action
entries/entry/action	Description of the action
entries/entry/addDate	The add date of the line
entries/entry/modifyDate	The modification date of the 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

calendar/entries/list_changed#

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

Goal
Requesting resource or project bookings from the calendar or the planning board for a specific 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	yes
dateTo	Add or modification date to. Format: yyyymmdd	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>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <breakdownParent></breakdownParent>
            <breakdownParentCode></breakdownParentCode>
            <status></status>
            <approved></approved>
            <timeFrom></timeFrom>
            <timeTo></timeTo>
            <hours></hours>
            <description></description>
            <remarks></remarks>
            <location></location>
            <actionFor></actionFor>
            <addDate></addDate>
            <modifyDate></modifyDate>
            <deleteDate></deleteDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/id	The unique id of the booking
entries/entry/date	The date of the booking
entries/entry/resourceName	Name of the booked resource
entries/entry/resourceCode	Code of the booked resource
entries/entry/resourceEmployeeNumber	The employee number of the booked resource
entries/entry/project	The project name
entries/entry/projectCode	The project code
entries/entry/breakdown	The activity name.
entries/entry/breakdownCode	The activity code.
entries/entry/breakdownParent	The name of the parent activity
entries/entry/breakdownParentCode	The code of the parent activity
entries/entry/status	The stsatus of the booking. Options: Hard or Soft
entries/entry/approved	Indication that the booking is approved. Options Yes or No
entries/entry/timeFrom	Starting 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/actionFor	Resource responsible for the action
entries/entry/action	Description of the action
entries/entry/addDate	The add date of the line. Format yyyy-mm-dd HH:mm:ss
entries/entry/modifyDate	The modification date of the line
entries/entry/deleteDate	The delete date of the line. Format yyyy-mm-dd HH:mm:ss

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/

Goal
Updating resource or project bookings in the calendar or the planning bord.

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
type	Type of the booking. “entry” for resource bookings, “request” for request (= project) bookings	yes
resource	Code or name. The planned resource	When type= “entry”: yes
project	Code or name. The project for the booking	yes
breakdown	Code or name. The activity for the booking	yes
status	Hard or Soft. The status of the booking	yes
date	Date of the booking. Format: yyyymmdd	yes
timeFrome	Start time for the booking. Format: hh:mm	yes
hours	Number of hours	yes
fullDay	Yes or No.Marks the booking as “Full day”	no
Location	The location field	no
description	The description field	no
remarks	The remarks field	no
linkedResources/resource	Code or name. The resource(s) connected to the booking	no
requestOrganisationalUnit	The Organisational Unit for the request	no
requestSkillLevel1	The requestSkillLevel 1 for the request	no
requestSkillLevel2	The requestSkillLevel 2 for the request	no
requestSkillLevel3	The requestSkillLevel 3 for the request	no
needsAction	Yes or no. Marks if there is an action for this booking	no
actionsText	Description of the action	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/

Goal
Deleting resource or project bookings in the calendar or the planning bord.

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 the booking. Requesting an id can be done via 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/

Goal
Add or update a project planning to a breakdown

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
project	The project code or name	yes
version	The version of the planning	yes
breakdown	The activity code or name	yes
item/startdate	Start date for this plan line. Format: yyyymmdd or yyyy-mm-dd	yes
item/enddate	End date for this plan line. Format: yyyymmdd or yyyy-mm-dd	yes. when no duration is provided
item/duration	Number of days, 0 decimals	yes. when no enddate is provided
item/comments	Additional comments	no
item/estimate	Estimate number of days	no
item/label	Optional 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/

Goal
Returns details of a project planning from 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	The project code or name	yes
version	The version of the planning	yes

The following xml structure is received after an successful execution:

<response>
    <valid>yes</valid>
    <Entries>
        <Entry>
            <project></project>
            <projectCode></projectCode>
            <breakdown></breakdown>
            <breakdownCode></breakdownCode>
            <startdate></startdate>
            <enddate></enddate>
            <duration></duration>
            <comments></comments>
            <estimate></estimate>
            <label></label>
        </Entry>
    </Entries>
</response>

Parameter	Description
valid	Indication that service was not executed successfully
project	Name of the project
projectCode	Project code
breakdown	Activity name
breakdownCode	Activity code
version	Activity name
startdate	Start date for this plan line
enddate	End date for this plan line
duration	Duration in days
comments	Additional comment
estimate	Estimate number of days
label	Additional 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

projectplanning/delete#

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

Goal
Delete a planning from an activity

Request
The following xml structure must be provided:

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

Parameter	Description	Required
token	Token for this request	yes
project	The project code or name	yes
version	The version of the planning	yes
breakdown	The activity code or name	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

Time entries#

time/entries/add#

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

Goal
Adding time registration bookings (realisation).

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. The resource for the booking	yes
project	Code or name. The project for the booking	yes
breakdown	Code or name. The activity for the booking	yes
date	Date of the booking. Format: yyyymmdd	yes
hours	Number of hours	yes
startTime	Start time for the booking. Format: hh:mm	yes
endTime	End time for the booking. Format: hh:mm	yes
reference	Reference field	no
description	The description field	no
KM	Number of kilometers.	no
descriptionKM/resource	The description field for the kilometers	no
type	The type of the booking. Attribute	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/

Goal
Requesting time bookings.

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	Starting date. Format: yyyymmdd	yes
dateTo	Date to. Format: yyyymmdd	yes
resource	Code or name. Request bookings for a specific resource	no
project	Code or name. Request bookings for a specific project	no
onlyApprovedEntries	Yes or no. Returns only entries with this 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>
            <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>
            <commericalRate></commericalRate>
            <addDate></addDate>
            <modifyDate></modifyDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/id	The unique id of the time line
entries/entry/date	The date of the booking
entries/entry/resource	Resource name
entries/entry/resourceCode	Resource code
entries/entry/project	The project name of the booking
entries/entry/projectCode	The project code of the booking
entries/entry/breakdown	The activity name of the booking
entries/entry/breakdownCode	The activity code of the booking
entries/entry/breakdownParent	The name of the parent activity
entries/entry/breakdownParentCode	The code of the parent activity
entries/entry/status	The status of the booking
entries/entry/dateUpdateStatus	The last update of the line (approved or rejected)
entries/entry/type	value from the field type
entries/entry/reference	Value in the reference field
entries/entry/timeFrom	Starting time of the booking. Format: hh:mm
entries/entry/timeTo	End time for the booking. 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 booking has been rejected in approval
entries/entry/invoiceStatus	Has the line been invoiced?
entries/entry/commericalRate	Commercial rate of this line
entries/entry/addDate	The add date of the line
entries/entry/modifyDate	The modification date of the 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/

Goal
Requesting time bookings for a specific 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.	yes
dateTo	Add or modification date to. Format: yyyymmdd.	yes
resource	Resource of the changed timeline	no
onlyApprovedEntries	Selection of Approved Entries. Format: Yes or No	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>
            <commericalRate></commericalRate>
            <addDate></addDate>
            <modifyDate></modifyDate>
            <deleteDate></deleteDate>
        </entry>
    </entries>
</response>

Parameter	Description
valid	Indication that service was executed successfully
entries/entry/id	The unique id of the time line
entries/entry/date	The date of the booking
entries/entry/resource	Resource name
entries/entry/resourceCode	Resource code
entries/entry/project	The project name of the booking
entries/entry/projectCode	The project code of the booking
entries/entry/breakdown	The activity name of the booking
entries/entry/breakdownCode	The activity code of the booking
entries/entry/breakdownParent	The name of the parent activity
entries/entry/breakdownParentCode	The code of the parent activity
entries/entry/status	The status of the booking
entries/entry/dateUpdateStatus	The last update of the line (approved or rejected)
entries/entry/type	Value from the field type
entries/entry/reference	Value in the reference field
entries/entry/timeFrom	Starting time of the booking. Format: hh:mm
entries/entry/timeTo	End time for the booking. 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 booking has been rejected in approval
entries/entry/invoiceStatus	Has the line been invoiced?
entries/entry/commericalRate	Commercial ratie of this line
entries/entry/addDate	The add date of the line. Format yyyy-mm-dd HH:mm:ss
entries/entry/modifyDate	The modification date of the line. Format yyyy-mm-dd HH:mm:ss
entries/entry/deleteDate	The delete date of the line. Format yyyy-mm-dd HH:mm:ss

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/

Goal
Getting a list with all budgeted costs 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. The project for this request	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 line
date	Input date. Format:yyyy-mm-dd
breakdown	Name of activity
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing
type	Attribute value
budgetAmount	The budgeted amount
invoiceDate	The date per when this line can be invoiced (invoiceStatus is open) or when the line is invoice (invoiceStatus is invoiced)
invoiceAmount	The amount which is invoiced or will be invoiced
invoiceStatus	The invoice status of this line
description	Description of the 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
error	Reason why the service has executed unsuccessfully

budgetcost/add#

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

Goal
Adding budgeted costs to a project.

Request
The following xml structure must be provided:

<request>
    <token></token>
    <budgetcost>
        <project></project>
        <name></name>
        <date></date>
        <breakdown></breakdown>
        <invoiceType></invoiceType>
        <type></type>
        <budgetAmount></budgetAmount>
        <invoiceDate></invoiceDate>
        <invoiceAmount></invoiceAmount>
        <description></description>
    </budgetcost>
</request>

Parameter	Description	Required
token	Token for this request	yes
project	Code or name. The project for this request	yes
name	Name of the cost line	yes
date	Input date. Format:yyyy-mm-dd	yes
breakdown	Name of activity	yes
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing	yes
type	Attribute value	yes
budgetAmount	The budgeted amount	no
invoiceDate	The date per when this line can be invoiced (invoiceStatus is open)	no
invoiceAmount	The amount which is invoiced or will be invoiced	no
description	Description of the line	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/

Goal
Getting a list with 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. The project for this request	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>
            <salesInvoiceDate></salesInvoiceDate>
            <salesInvoiceAmount></salesInvoiceAmount>
            <salesInvoiceStatus></salesInvoiceStatus>
            <description></description>
        </purchaseInvoice>
    </purchaseInvoices>
</response>

Parameter	Description
valid	Indication that service was executed successfully
invoiceDate	Invoice date. Format:yyyy-mm-dd
invoiceNumber	The number of the original invoice
invoiceAmount	The amount of the invoice
budgetCost	The related budget cost line. see purchaseinvoices/list/
breakdown	Name of activity
type	Attribute value
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing
salesInvoiceDate	The date per when this line can be invoiced (invoiceStatus is open) or when the line is invoice (invoiceStatus is invoiced)
salesInvoiceAmount	The amount which is invoiced or will be invoiced
salesInvoiceStatus	The invoice status of this line
description	Description of the 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
error	Reason why the service has executed unsuccessfully

purchaseinvoices/add#

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

Goal
Adding purchase invoices to 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>
        <salesInvoiceDate></salesInvoiceDate>
        <salesInvoiceAmount></salesInvoiceAmount>
    </purchaseInvoice>
</request>

purchaseInvoiceNumberThe number of the original invoice.yes

Parameter	Description	Required
token	Token for this request	yes
project	Code or name. The project for this request	yes
budgetCost	The related budget cost line. see purchaseinvoices/list	yes
purchaseInvoiceDate	Invoice date. Format:yyyy-mm-dd	yes
purchaseInvoiceAmount	The amount of the invoice	no
description	Description of the line	no
salesInvoiceDate	The date per when this line can be invoiced	no
salesInvoiceAmount	The amount which is invoiced or will be invoiced	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