API#
The API is available at https://api.timewax.com.
The API is realized as an http(s) service which by a POST request sends data to the xml Timewax server. Based on this request XML data is returned. Each service has its own URL and request and response definition. All services are authorized based on a token. The token is obtained using the Timewax credentials. This token is valid for 60 minutes and during that period it can be used for various services.
Requests are subject to rate limiting. For the limits and best practices to handle requests, read this support article.
Token#
authentication/token/get#
Service
https://api.timewax.com/authentication/token/get/
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 environment. The client environment name can be found on the start page in the top right menu. Click on settings and you will see the User name – Client name. | yes |
| username | API ID. This ID can be found in Masters > Resources > Resource – Data Security | yes |
| password | The password of the user | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<token></token>
<validUntil></validUntil>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| token | The obtained token |
| validUntil | The token is valid until |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<errors>no</errors>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
Client#
company/add#
Service
https://api.timewax.com/company/add/
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 | 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
Retrieving all the data of a client.
Request
The following xml structure must be provided:
<request>
<token></token>
<company></company>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| company | Code or name of the client | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<company>
<code></code>
<name></name>
<contactPerson></contactPerson>
<industry></industry>
<type></type>
<officeAttn></officeAttn>
<officeAddress></officeAddress>
<officePostcode></officePostcode>
<officeCity></officeCity>
<officeRegion></officeRegion>
<officeCountry></officeCountry>
<telephone></telephone>
<vatNumber></vatNumber>
<website></website>
<notes></notes>
<isActive></isActive>
</company>
</response>
| Parameter | Description |
|---|---|
| token | Token for this request |
| company/code | Code |
| company/Name | Name |
| company/contactPerson | Internal contact (resource) for the client |
| company/industry | Industry (field list value) |
| company/type | Type (field list value) |
| company/officeAttn | For the attention of |
| company/officeAddress | Address |
| company/officePostcode | Postal code |
| company/officeCity | City |
| company/officeCountry | Country |
| company/telephone | Telephone |
| company/VATNumber | VAT number |
| company/website | URL website |
| company/notes | Remarks |
| company/isActive | Yes or No. If the client is active or not |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<errors>no</errors>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
company/edit#
Service
https://api.timewax.com/company/edit/
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
Retrieving a list with clients.
Request
The following xml structure must be provided:
<request> <token></token> </request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<companies>
<company>
<code></code>
<name></name>
<isActive></isActive>
</company>
</companies>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| company/code | Client code |
| company/name | Client name |
| company/isActive | Yes or No. If the client is active or not |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
Project#
project/add#
Service
https://api.timewax.com/project/add/
Goal
Create new projects
Request
The following xml structure must be provided:
<request>
<token></token>
<project>
<code></code>
<name></name>
<useInvoicing></useInvoicing>
<chargeable></chargeable>
<approveTime></approveTime>
<blockEntries></blockEntries>
<isTemplate></isTemplate>
<isActive></isActive>
<startDate></startDate>
<endDate></endDate>
<notes></notes>
<company></company>
<organisationalUnit></organisationalUnit>
<projectManager></projectManager>
<backupProjectManager></backupProjectManager>
<currency></currency>
<parentProject></parentProject>
<status></status>
<color></color>
<externalLinkFiles></externalLinkFiles>
<emailContactPerson></emailContactPerson>
</project>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project/code | Project code | yes |
| project/name | Project name | yes |
| project/useInvoicing | Yes or no. Is this an invoiceable project? | no |
| project/chargeable | Yes or no. Is this project chargeable? | no |
| project/approveTime | Yes or no. Do submitted hours need to be approved? | no |
| project/blockEntries | Yes or no. Block bookings for planning and time sheets? | no |
| project/isTemplate | Yes or no. Can this project be used as a template for new projects? | no |
| project/isActive | Yes or no. Is the project active? | no |
| project/startDate | Start date of the project. Format yyyymmdd or yyyy-mm-dd | no |
| project/endDate | End date of the project. Format yyyymmdd or yyyy-mm-dd | no |
| project/notes | Remarks | no |
| project/company | Code or name of the client | yes |
| project/organisationalUnit | Code or name of the department | yes |
| project/projectManager | Code or name of the project manager | yes |
| project/backupProjectManager | Code or name of the backup project manager | no |
| project/currency | Project currency | yes |
| project/parentProject | Code or name of the parent project | no |
| project/status | Project status (field lists) | no |
| project/color | Project color (hexadecimal value) | no |
| project/externalLinkFiles | URL to an online file | no |
| project/emailContactPerson | Email of the (external) contact person | no |
The following xml structure is received after an successful execution:
<response> <valid>yes</valid> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
project/add_based_on_template#
Service
https://api.timewax.com/project/add_based_on_template/
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
Retrieving all the data of a project.
Request
The following xml structure must be provided:
<request> <token></token> <project></project> </request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project | Project code or name | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<project>
<code></code>
<name></name>
<useInvoicing></useInvoicing>
<chargeable></chargeable>
<approveTime></approveTime>
<orgUnitManagerIsApprover></orgUnitManagerIsApprover>
<blockEntries></blockEntries>
<isTemplate></isTemplate>
<isActive></isActive>
<startDate></startDate>
<endDate></endDate>
<notes></notes>
<company></company>
<companyCode></companyCode>
<organisationalUnit></organisationalUnit>
<organisationalUnitCode></organisationalUnitCode>
<projectManager></projectManager>
<backupProjectManager></backupProjectManager>
<projectManagerCode></projectManagerCode>
<currency></currency>
<currencyCode></currencyCode>
<parentProject></parentProject>
<parentProjectCode></parentProjectCode>
<status></status>
<color></color>
<externalLinkFiles></externalLinkFiles>
<emailContactPerson></emailContactPerson>
<portfolios>
<code></code>
<name></name>
</portfolios>
</project>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| project/code | Project code |
| project/name | Project name |
| project/useInvoicing | Yes or no. Invoiceable project or not |
| project/chargeable | Yes or no. Chargeable project or not |
| project/approveTime | Yes or no. If hours need to be approved or not |
| project/orgUnitManagerIsApprover | Yes or no. If the department manager approves time sheets |
| project/blockEntries | Yes or no. Blocks new planning bookings and time sheets for this project |
| project/isTemplate | Yes or no. Determines if this project is a template |
| project/isActive | Yes or no. Determines if the project is active or not |
| project/startDate | yyyymmdd. Start date of the project |
| project/endDate | yyyymmdd. End date of the project |
| project/notes | Remarks about the project |
| project/company | The name of the customer to which this project belongs |
| project/companyCode | The code of the customer to which this project belongs |
| project/organisationalUnit | The name of the department to which this project belongs |
| project/organisationalUnitCode | The code of the department to which this project belongs |
| project/projectManager | The name of the project manager |
| project/backupProjectManager | The name of the backup project manager |
| project/projectManagerCode | The code of the project manager |
| project/currency | The name of the project currency |
| project/currencyCode | The code of the project currency |
| project/parentProject | The code of the parent project |
| project/parentProjectCode | The name of the parent project |
| project/status | The project status |
| project/color | The project color in hexadecimal value |
| project/externalLinkFiles | URL to an online file location |
| project/emailContactPerson | The email of the external contact person of the project |
| portfolios/code | Code of the portfolio |
| portfolios/name | Name of the portfolio |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully. |
| error | Reason why the service has executed unsuccessfully. |
project/list_changed#
Service
https://api.timewax.com/project/list_changed/
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/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 |
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>
<isMilestone></isMilestone>
<color></color>
<blockPosting></blockPosting>
<useResourceEntries></useResourceEntries>
<useProjectPlanning></useProjectPlanning>
<chargeable></chargeable>
<typeMandatoryTimesheets></typeMandatoryTimesheets>
<descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
<invoiceType></invoiceType>
<invoiceDate></invoiceDate>
<invoiceAmount></invoiceAmount>
<notes></notes>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition></requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
</breakdown>
</breakdowns>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project | Code or name of the project | yes |
| code | Code of the activity | yes |
| name | Name of the activity | yes |
| parentBreakdown | Code or name of the parent activity, this value must already exist | no |
| accountingType | Time, expenses or time_expenses | no |
| status | Code or name of the value of this field list | no |
| plannedHours | Budget hours | no |
| plannedRate | Commercial budget rate | no |
| rateIsCommercialRate | Yes or no, determines if the budget rate is the fixed commercial rate | no |
| useNumbersInProgress | Yes or no, determines if progress must be reported in numbers | no |
| budgetNumbers | Target when NumbersInProgress = Yes | no |
| teamManager | Resource name | no |
| isMilestone | Yes or no | no |
| color | Color of this activity (hexadecimal value) | no |
| blockPosting | Yes or no, determines that the activity is blocked for transactions | no |
| useResourceEntries | Yes or no, determines if it possible to schedule resources on the activity | no |
| useProjectPlanning | Yes or no, determines if it possible to use this activity in the Gantt Chart | no |
| chargeable | Yes or no, determines if the activity is marked as chargeable | no |
| typeMandatoryTimesheets | Yes or no, determines if a type is mandatory in time sheets | no |
| descriptionMandatoryTimesheets | Yes or no, determines if a description is mandatory in time sheets | no |
| invoiceType | Type for invoicing, possible values: not_invoiceable, fixed_price, time_material | no |
| invoiceDate | Invoice date for the activity, when invoiceType = fixed_price | no |
| invoiceAmount | Amount to be invoiced, when invoiceType = fixed_price | no |
| notes | Comments on the activity | no |
| requestOrganisationalUnit | The department that is applied to resource request information in bookings | no |
| requestPosition | The position that is applied to resource request information in bookings | no |
| requestSkillLevel1 | The first skill and level that is applied to resource request information in bookings | no |
| requestSkillLevel2 | The second skill and level that is applied to resource request information in bookings | no |
| requestSkillLevel3 | The third skill and level that is applied to resource request information in bookings | no |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
project/activity/get#
Service
https://api.timewax.com/project/breakdown/get/
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>
<breakdownId></breakdownId>
<code></code>
<name></name>
<parentBreakdown></parentBreakdown>
<isMilestone></isMilestone>
<blockPosting></blockPosting>
<useResourceEntries></useResourceEntries>
<useProjectPlanning></useProjectPlanning>
<chargeable></chargeable>
<typeMandatoryTimesheets></typeMandatoryTimesheets>
<descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
<invoiceType></invoiceType>
<invoiceDate></invoiceDate>
<invoiceAmount></invoiceAmount>
<invoiceStatus></invoiceStatus>
<status></status>
<teamManager></teamManager>
<budgetHours></budgetHours>
<budgetRate></budgetRate>
<teamManager></teamManager>
<rateIsCommercialRate></rateIsCommercialRate>
<useNumbersInProgress></useNumbersInProgress>
<budgetNumbers></budgetNumbers>
<accountingType></accountingType>
<notes></notes>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition></requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
<externalId></externalId>
<rates>
<rate>
<resourceCode></resourceCode>
<resourceName></resourceName>
<commercialRate></commercialRate>
<costRate></costRate>
</rate>
</rates>
</breakdown>
</response>
| Parameter | Description |
|---|---|
| token | Token for this request |
| id | ID of the activity |
| breakdownId | Internal system ID of the activity |
| code | Code of the activity |
| name | Name of the activity |
| parentBreakdown | Name of the parent activity |
| isMilestone | Yes or no |
| blockPosting | Yes or no, determines that the activity is blocked for transactions |
| invoiceType | Type for invoicing, possible values: not_invoiceable, fixed_price, time_material |
| invoiceDate | Invoice date for the activity, when invoiceType = fixed_price |
| invoiceAmount | Amount to be invoiced, when invoiceType = fixed_price |
| invoiceStatus | Status of the invoice, possible values: none, open, proposed or invoiced |
| status | Status value |
| teamManager | Resource name |
| budgetHours | Budget hours |
| budgetRate | Commercial budget rate |
| accountingType | Time, expenses or time_expenses |
| rateIsCommercialRate | Yes or no, determines if the budget rate is the fixed commercial rate |
| useNumbersInProgress | Yes or no, determines if progress must be reported in numbers |
| budgetNumbers | Target when NumbersInProgress = Yes |
| useResourceEntries | Yes or no, determines if it possible to schedule resources on the activity |
| useProjectPlanning | Yes or no, determines if it possible to use this activity in the Gantt Chart |
| chargeable | Yes or no, determines if the activity is marked as chargeable |
| typeMandatoryTimesheets | Yes or no, determines if a type is mandatory in time sheets |
| descriptionMandatoryTimesheets | Yes or no, determines if a description is mandatory in time sheets |
| notes | Comments on the activity |
| requestOrganisationalUnit | The department that is applied to resource request information in bookings |
| requestPosition | The position that is applied to resource request information in bookings |
| requestSkillLevel1 | The first skill and level that is applied to resource request information in bookings |
| requestSkillLevel2 | The second skill and level that is applied to resource request information in bookings |
| requestSkillLevel3 | The third skill and level that is applied to resource request information in bookings |
| resourceCode | Code of the resource that is authorized to the activity |
| resourceName | Name of the resource that is authorized to the activity |
| commercialRate | The commercial rate applied for the resource on this activity |
| costRate | The cost price rate applied for the resource on this activity |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
project/activity/list#
Service
https://api.timewax.com/project/breakdown/list/
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>
<breakdown>
<id></id>
<breakdownId></breakdownId>
<code></code>
<name></name>
<parentBreakdown></parentBreakdown>
<isMilestone></isMilestone>
<blockPosting></blockPosting>
<useResourceEntries></useResourceEntries>
<useProjectPlanning></useProjectPlanning>
<chargeable></chargeable>
<typeMandatoryTimesheets></typeMandatoryTimesheets>
<descriptionMandatoryTimesheets></descriptionMandatoryTimesheets>
<invoiceType></invoiceType>
<invoiceDate></invoiceDate>
<invoiceAmount></invoiceAmount>
<invoiceStatus></invoiceStatus>
<status></status>
<teamManager></teamManager>
<budgetHours></budgetHours>
<budgetRate></budgetRate>
<teamManager></teamManager>
<rateIsCommercialRate></rateIsCommercialRate>
<useNumbersInProgress></useNumbersInProgress>
<budgetNumbers></budgetNumbers>
<accountingType></accountingType>
<notes></notes>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition></requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
<externalId></externalId>
<rates>
<rate>
<resourceCode></resourceCode>
<resourceName></resourceName>
<commercialRate></commercialRate>
<costRate></costRate>
</rate>
</rates>
</breakdown>
</response>
| Parameter | Description |
|---|---|
| token | Token for this request |
| id | ID of the activity |
| breakdownId | Internal system ID of the activity |
| code | Code of the activity |
| name | Name of the activity |
| parentBreakdown | Name of the parent activity |
| isMilestone | Yes or no |
| blockPosting | Yes or no, determines that the activity is blocked for transactions |
| invoiceType | Type for invoicing, possible values: not_invoiceable, fixed_price, time_material |
| invoiceDate | Invoice date for the activity, when invoiceType = fixed_price |
| invoiceAmount | Amount to be invoiced, when invoiceType = fixed_price |
| invoiceStatus | Status of the invoice, possible values: none, open, proposed or invoiced |
| status | Status value |
| teamManager | Resource name |
| budgetHours | Budget hours |
| budgetRate | Commercial budget rate |
| accountingType | Time, expenses or time_expenses |
| rateIsCommercialRate | Yes or no, determines if the budget rate is the fixed commercial rate |
| useNumbersInProgress | Yes or no, determines if progress must be reported in numbers |
| budgetNumbers | Target when NumbersInProgress = Yes |
| useResourceEntries | Yes or no, determines if it possible to schedule resources on the activity |
| useProjectPlanning | Yes or no, determines if it possible to use this activity in the Gantt Chart |
| chargeable | Yes or no, determines if the activity is marked as chargeable |
| typeMandatoryTimesheets | Yes or no, determines if a type is mandatory in time sheets |
| descriptionMandatoryTimesheets | Yes or no, determines if a description is mandatory in time sheets |
| notes | Comments on the activity |
| requestOrganisationalUnit | The department that is applied to resource request information in bookings |
| requestPosition | The position that is applied to resource request information in bookings |
| requestSkillLevel1 | The first skill and level that is applied to resource request information in bookings |
| requestSkillLevel2 | The second skill and level that is applied to resource request information in bookings |
| requestSkillLevel3 | The third skill and level that is applied to resource request information in bookings |
| resourceCode | Code of the resource that is authorized to the activity |
| resourceName | Name of the resource that is authorized to the activity |
| commercialRate | The commercial rate applied for the resource on this activity |
| costRate | The cost price rate applied for the resource on this activity |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
project/activity/edit#
Service
https://api.timewax.com/project/breakdown/edit/
Goal
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: not_invoiceable, fixed_price, time_material | 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/remove#
Service
https://api.timewax.com/project/breakdown/remove/
Goal
Remove activities (breakdowns) in projects
Request
The following xml structure must be provided:
<request>
<token></token>
<project></project>
<breakdown></breakdown>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project | Code or name of the project | yes |
| breakdowns | Code or name of the activity | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
project/activity/authorization/add#
Service
https://api.timewax.com/project/breakdown/authorization/add/
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/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 |
Progress#
progress/list#
Service
https://api.timewax.com/progress/list/
Goal
Request progress information for a specific project.
Request
The following xml structure must be provided:
<request>
<token></token>
<project></project>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project | Project code | yes |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<progresses>
<progress>
<id></id>
<date></date>
<projectCode></projectCode>
<projectName></projectName>
<breakdownCode></breakdownCode>
<breakdownName></breakdownName>
<percentageComplete></percentageComplete>
<hoursNeededToComplete></hoursNeededToComplete>
<actualNumbers></actualNumbers>
<dateReady></dateReady>
<remarks></remarks>
</progress>
</progresses>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| progresses/progress/id | The internal id of the progress |
| progresses/progress/date | The date of the progress |
| progresses/progress/projectCode | The project code |
| progresses/progress/projectName | The project name |
| progresses/progress/breakdownCode | The activity code |
| progresses/progress/breakdownName | The activity name |
| progresses/progress/percentageComplete | The reported percentage complete |
| progresses/progress/hoursNeededToComplete | Estimated time to complete in number of hours |
| progresses/progress/actualNumbers | Actual number of completed units (if enabled on the activity) |
| progresses/progress/dateReady | The expected date that the activity will be finished |
| progresses/progress/remarks | Remarks of the resource when the progress was submitted |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
progress/list_changed#
Service
https://api.timewax.com/progress/list_changed/
Goal
Request new or changed progress information for projects in a date range.
Request
The following xml structure must be provided:
<request>
<token></token>
<dateFrom></dateFrom>
<dateTo></dateTo>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| dateFrom | Date from. Format yyyymmdd or yyyy-mm-dd | yes |
| dateTo | Date to. Format yyyymmdd or yyyy-mm-dd | yes |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<progresses>
<progress>
<id></id>
<date></date>
<projectCode></projectCode>
<projectName></projectName>
<breakdownCode></breakdownCode>
<breakdownName></breakdownName>
<percentageComplete></percentageComplete>
<hoursNeededToComplete></hoursNeededToComplete>
<actualNumbers></actualNumbers>
<dateReady></dateReady>
<remarks></remarks>
</progress>
</progresses>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| progresses/progress/id | The internal id of the progress |
| progresses/progress/date | The date of the progress |
| progresses/progress/projectCode | The project code |
| progresses/progress/projectName | The project name |
| progresses/progress/breakdownCode | The activity code |
| progresses/progress/breakdownName | The activity name |
| progresses/progress/percentageComplete | The reported percentage complete |
| progresses/progress/hoursNeededToComplete | Estimated time to complete in number of hours |
| progresses/progress/actualNumbers | Actual number of completed units (if enabled on the activity) |
| progresses/progress/dateReady | The expected date that the activity will be finished |
| progresses/progress/remarks | Remarks of the resource when the progress was submitted |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
Position#
position/add#
Service
https://api.timewax.com/position/add/
Goal
Create new positions
Request
The following xml structure must be provided:
<request>
<token></token>
<position>
<code></code>
<name></name>
</position>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| code | Code of the position | yes |
| name | Name of the position | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
Department#
department/add#
Service
https://api.timewax.com/department/add/
Goal
Create new departments
Request
The following xml structure must be provided:
<request>
<token></token>
<code></code>
<name></name>
<legalEntity></legalEntity>
<manager></manager>
<backupManager></backupManager>
<resourceManager></resourceManager>
<departmentParent></departmentParent>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| code | Code of the department | yes |
| name | Name of the department | yes |
| legalEntity | Name of legal entity to which this department belongs | yes |
| manager | Name of the resource that is the department manager | yes |
| backupManager | Name of the resource that is the backup department manager | no |
| resourceManager | Name of the resource that is the resource manager of the department | no |
| departmentParent | Optionally the parent department to which this department belongs | no |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
department/get#
Service
https://api.timewax.com/department/get/
Goal
Retrieve department information
Request
The following xml structure must be provided:
<request>
<token></token>
<department></department>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| department | Code or name of the department | yes |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<message></message>
<departments>
<department>
<code></code>
<name></name>
<legalEntityCode></legalEntityCode>
<legalEntityName></legalEntityName>
<managerCode></managerCode>
<managerName></managerName>
<backupManagerCode></backupManagerCode>
<backupManagerName></backupManagerName>
<resourceManagerCode></resourceManagerCode>
<resourceManagerName></resourceManagerName>
<departmentParentCode></departmentParentCode>
<departmentParentName></departmentParentName>
</department>
</departments>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors></errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
department/edit#
Service
https://api.timewax.com/department/edit/
Goal
Edit departments
Request
The following xml structure must be provided:
<request>
<token></token>
<department></department>
<code></code>
<name></name>
<legalEntity></legalEntity>
<manager></manager>
<backupManager></backupManager>
<resourceManager></resourceManager>
<departmentParent></departmentParent>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| department | Code or name of the department to edit | yes |
| code | Code of the department | no |
| name | Name of the department | no |
| legalEntity | Name of legal entity to which this department belongs | no |
| manager | Name of the resource that is the department manager | no |
| backupManager | Name of the resource that is the backup department manager | no |
| resourceManager | Name of the resource that is the resource manager of the department | no |
| departmentParent | Optionally the parent department to which this department belongs | no |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<message></message>
<departments>
<department>
<code></code>
<name></name>
<legalEntityCode></legalEntityCode>
<legalEntityName></legalEntityName>
<managerCode></managerCode>
<managerName></managerName>
<backupManagerCode></backupManagerCode>
<backupManagerName></backupManagerName>
<resourceManagerCode></resourceManagerCode>
<resourceManagerName></resourceManagerName>
<departmentParentCode></departmentParentCode>
<departmentParentName></departmentParentName>
</department>
</departments>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
Resources#
resource/add#
Service
https://api.timewax.com/resource/add/
Goal
Create new resources
Request
The following xml structure must be provided:
<request>
<token></token>
<resource>
<type></type>
<user></user>
<code></code>
<name></name>
<firstNames></firstNames>
<infix></infix>
<email></email>
<organisationalUnit></organisationalUnit>
<position></position>
<privateAddress></privateAddress>
<privatePostcode></privatePostcode>
<privateCity></privateCity>
<privateTelephone></privateTelephone>
<privateMobile></privateMobile>
<privateEmail></privateEmail>
<birthDate></birthDate>
<businessTelephone></businessTelephone>
<businessMobile></businessMobile>
<startDate></startDate>
<endDate></endDate>
<employeeNumber></employeeNumber>
<bankAccountNumber></bankAccountNumber>
<backupTime></backupTime>
<regionCalendar></regionCalendar>
<externalResource></externalResource>
<sendEmailNotificationDueTimesheets></sendEmailNotificationDueTimesheets>
<workingHoursMon></workingHoursMon>
<workingHoursTue></workingHoursTue>
<workingHoursWed></workingHoursWed>
<workingHoursThu></workingHoursThu>
<workingHoursFri></workingHoursFri>
<workingHoursSat></workingHoursSat>
<workingHoursSun></workingHoursSun>
<startTimeMon></startTimeMon>
<startTimeTue></startTimeTue>
<startTimeWed></startTimeWed>
<startTimeThu></startTimeThu>
<startTimeFri></startTimeFri>
<startTimeSat></startTimeSat>
<startTimeSun></startTimeSun>
<color></color>
<remarks></remarks>
<profiles>
<profile></profile>
</profiles>
</resource>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| type | Resource type: person or material. When left empty default value is person | no |
| user | Yes or no. Default no when left empty | no |
| code | Code of the resource | yes |
| name | Last name of the resource | yes |
| firstNames | First name of the resource | yes |
| infix | Infix | no |
| Email address of the resource | yes if user is yes | |
| organisationalUnit | Code or name of the department | yes |
| position | Code or name of the position | yes |
| privateAddress | Private address | no |
| privatePostcode | Private postcode | no |
| privateCity | Private city | no |
| privateTelephone | Private telephone | no |
| privateMobile | Private mobile number | no |
| privateEmail | Private email | no |
| birthDate | Date of birth. Format: yyyymmdd or yyyy-mm-dd | no |
| businessTelephone | Business telephone | no |
| businessMobile | Business mobile | no |
| startDate | Start date for the resource. Format yyyymmdd or yyyy-mm-dd | yes |
| endDate | End date for the resource. Format yyyymmdd or yyyy-mm-dd | no |
| employeeNumber | Employee number | no |
| bankAccountNumber | Bank account number | no |
| backupTime | Code or name of backup user for time sheets | no |
| regionCalendar | Code or name of the bank holiday calendar | no |
| externalResource | Yes or no | no |
| sendEmailNotificationDueTimesheets | Yes or no | no |
| workingHoursMon | Number of working hours on Monday | no |
| workingHoursTue | Number of working hours on Tuesday | no |
| workingHoursWed | Number of working hours on Wednesday | no |
| workingHoursThu | Number of working hours on Thursday | no |
| workingHoursFri | Number of working hours on Friday | no |
| workingHoursSat | Number of working hours on Saturday | no |
| workingHoursSun | Number of working hours on Sunday | no |
| startTimeMon | Default start time on Monday. Format hh:mm | no |
| startTimeTue | Default start time on Tuesday. Format hh:mm | no |
| startTimeWed | Default start time on Wednesday. Format hh:mm | no |
| startTimeThu | Default start time on Thursday. Format hh:mm | no |
| startTimeFri | Default start time on Friday. Format hh:mm | no |
| startTimeSat | Default start time on Saturday. Format hh:mm | no |
| startTimeSun | Default start time on Sunday. Format hh:mm | no |
| color | Resource color (hexadecimal value) | no |
| remarks | Remarks of the resource | no |
| profiles/profile | Code or name of user profiles | no |
The following xml structure is received after an successful execution:
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
resource/edit#
Service
https://api.timewax.com/resource/edit/
Goal
Editing existing resources
Request
The following xml structure must be provided:
<request>
<token></token>
<resource></resource>
<item>
<code></code>
<lastName></lastName>
<firstNames></firstNames>
<email></email>
<infix></infix>
<privateAddress></privateAddress>
<privatePostcode></privatePostcode>
<privateCity></privateCity>
<privateTelephone></privateTelephone>
<privateMobile></privateMobile>
<birthDate></birthDate>
<businessTelephone></businessTelephone>
<businessMobile></businessMobile>
<startDate></startDate>
<endDate></endDate>
<employeeNumber></employeeNumber>
<backupTime></backupTime>
<regionCalendar></regionCalendar>
<externalResource></externalResource>
<sendEmailNotificationDueTimesheets></sendEmailNotificationDueTimesheets>
<workingHoursMon></workingHoursMon>
<workingHoursTue></workingHoursTue>
<workingHoursWed></workingHoursWed>
<workingHoursThu></workingHoursThu>
<workingHoursFri></workingHoursFri>
<workingHoursSat></workingHoursSat>
<workingHoursSun></workingHoursSun>
<startTimeMon></startTimeMon>
<startTimeTue></startTimeTue>
<startTimeWed></startTimeWed>
<startTimeThu></startTimeThu>
<startTimeFri></startTimeFri>
<startTimeSat></startTimeSat>
<startTimeSun></startTimeSun>
<color></color>
<remarks></remarks>
<organisationalUnit></organisationalUnit>
<position></position>
<user></user>
<profiles>
<profile></profile>
</profiles>
</item>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| resource | Code or name of the resource | yes |
| user | Yes or no | no |
| code | Code of the resource | no |
| lastName | Last name of the resource | no |
| firstNames | First name of the resource | no |
| infix | Infix | no |
| Email address of the resource | yes if user is yes | |
| organisationalUnit | Code or name of the department. Updates the most recent department | no |
| position | Code or name of the position. Updates the most recent position | no |
| privateAddress | Private address | no |
| privatePostcode | Private postcode | no |
| privateCity | Private city | no |
| privateTelephone | Private telephone number | no |
| privateMobile | Private mobile number | no |
| birthDate | Date of birth. Format yyyymmdd or yyyy-mm-dd | no |
| businessTelephone | Business telephone | no |
| businessMobile | Business mobile | no |
| startDate | Start date for the resource. Format: yyyymmdd or yyyy-mm-dd | no |
| endDate | End date for the resource. Format: yyyymmdd or yyyy-mm-dd | no |
| employeeNumber | Employee number | no |
| backupTime | Code or name of the backup user for time sheets | no |
| regionCalendar | Code or name of the applicable bank holidays | no |
| externalResource | Yes or no | no |
| sendEmailNotificationDueTimesheets | Yes or no | no |
| workingHoursMon | Number of working hours on Monday | no |
| workingHoursTue | Number of working hours on Tuesday | no |
| workingHoursWed | Number of working hours on Wednesday | no |
| workingHoursThu | Number of working hours on Thursday | no |
| workingHoursFri | Number of working hours on Friday | no |
| workingHoursSat | Number of working hours on Saturday | no |
| workingHoursSun | Number of working hours on Sunday | No |
| startTimeMon | Default start time on Monday. Format hh:mm | no |
| startTimeTue | Default start time on Tuesday. Format hh:mm | no |
| startTimeWed | Default start time on Wednesday. Format hh:mm | no |
| startTimeThu | Default start time on Thursday. Format hh:mm | no |
| startTimeFri | Default start time on Friday. Format hh:mm | no |
| startTimeSat | Default start time on Saturday. Format hh:mm | no |
| startTimeSun | Default start time on Sunday. Format hh:mm | no |
| color | Resource color (hexadecimal value) | no |
| remarks | Remarks of the resource | no |
| profiles/profile | Code or name of user profiles | 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 a department to a resource
Request
The following xml structure must be provided:
<request>
<token></token>
<resource></resource>
<item>
<organisationalUnit></organisationalUnit>
<date></date>
</item>
</request
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| resource | The code or name of the resource | yes |
| item/organisationalUnit | Code or name of the department | yes |
| item/date | Effective start date of the department for the resource, 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/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 | Code or name of the resource | yes |
| item/position | Code or name of the position | yes |
| item/date | Effective start date of the position for the resource, 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/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/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>
<socialSecurityNumber></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 address of the resource | |
| code | Code of the resource |
| lastName | Last name of the resource |
| firstNames | First name of the resource |
| infix | Infix of the resource |
| titleBefore | Depreciated, no longer in use |
| titleAfter | Depreciated, no longer in use |
| isMaterial | Yes or no, is this resource an object |
| gender | Depreciated, no longer in use |
| contactPerson | Depreciated, no longer in use |
| privateAddress | Private address |
| privatePostcode | Private postcode |
| privateCity | Private city |
| privateCountry | Private country |
| privateTelephone | Private telephone number |
| privateMobile | Private mobile phone number |
| privateEmail | Private email address |
| birthDate | Date of birth |
| businessTelephone | Business telephone number |
| businessMobile | Business mobile phone number |
| isActive | Yes or no, is this resource active? |
| startDate | Start date |
| endDate | End date |
| employeeNumber | Employee number |
| bankAccountNumber | Bank account number |
| backupTime | Backup user for time sheets |
| backupExpenses | Backup user for expense sheets |
| regionCalendar | Bank holiday calendar |
| isExternalResource | Yes or no, is this resource external? |
| sendEmailNotificationDueTimesheets | Yes or no, send an email when time sheets are due |
| workingHoursMonday – Sunday | Working hours per day |
| startTimeMonday – Sunday | Default start time per day |
| color | Color of the resource |
| activeOrganisationalunit | Code of the active department |
| organisationalUnits/organisationalUnit/code | Code of the department |
| organisationalUnits/organisationalUnit/name | Name of the department |
| organisationalUnits/organisationalUnit/date | Effective start date at the department |
| activePosition | Code of the active position |
| positions/position/code | Code of the position |
| positions/position/name | Name of the position |
| positions/position/date | Effective start date for the position |
| skills/skill/skill | Skill of the resource |
| skills/skill/level | Skill level |
| skills/skill/date | Effective start date for the skill level |
| rates/rate/type | Type of the rate |
| rates/rate/date | Effective start date for the rate |
| rates/rate/currency | Currency |
| rates/rate/rate | Rate in currency value |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
resource/list#
Service
https://api.timewax.com/resource/list/
Goal
Getting a list with all active resources.
Request
The following xml structure must be provided:
<request>
<token></token>
<isActive></isActive>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| isActive | Yes or no. Retrieve active or inactive resources | no |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<resources>
<resource>
<resourceID></resourceID>
<code></code>
<fullName></fullName>
<lastName></lastName>
<firstNames></firstNames>
<infix></infix>
<color></color>
<isMe>no</isMe>
<isActive>no</isActive>
</resource>
</resources>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| resourceID | The unique ID of the resource |
| code | Resource code |
| fullName | Full name |
| lastName | Last name |
| firstNames | First names |
| infix | Infix |
| color | Resource color (hexadecimal value) |
| isMe | Yes or no, states if this resource belongs to the user requesting this service |
| isActive | Yes or no, states if this resource is active or not. |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| error | Reason why the service has executed unsuccessfully |
Resource bookings#
calendar/entries/add#
Service
https://api.timewax.com/calendar/entries/add/
Goal
Adding planning bookings to resources or open request bookings without resources.
Request
The following xml structure must be provided:
<request>
<token></token>
<entry>
<type></type>
<resource></resource>
<project></project>
<breakdown></breakdown>
<status></status>
<note></note>
<date></date>
<timeFrom></timeFrom>
<hours></hours>
<breaktime></breaktime>
<traveltime></traveltime>
<fullDay></fullDay>
<location></location>
<description></description>
<remarks></remarks>
<linkedResources>
<resource></resource>
</linkedResources>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition></requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
</entry>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| type | Type of the booking: “entry” for resource bookings, “request” for bookings without a resource | yes |
| resource | Code or name of the resource | When type= “entry”: yes |
| project | Code or name of the project | yes |
| breakdown | Code or name of the activity | yes |
| status | Hard or Soft | no |
| note | Yes or no. Determines if this booking is a note booking | no |
| date | Date of the booking. Format: yyyymmdd or yyyy-mm-dd | yes |
| timeFrome | Start time for the booking. Format: hh:mm | yes |
| hours | Number of hours | yes |
| breaktime | Number of hours for break time | no |
| traveltime | Number of hours for travel time | no |
| fullDay | Yes or No. Marks the booking as “Full day” | no |
| Location | The location field | no |
| description | The description field | no |
| remarks | The remarks field | no |
| linkedResources/resource | Code or name of a resource. Only used when booking type = “request” | no |
| requestOrganisationalUnit | The department when request information is needed | no |
| requestPosition | The position when request information is needed | no |
| requestSkillLevel1 | First skill when request information is needed | no |
| requestSkillLevel2 | Second skill when request information is needed | no |
| requestSkillLevel3 | Third skill when request information is needed | no |
The following xml structure is received after an successful execution:
<response> <valid>yes</valid> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| id | Id of the entry |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <id></id> <errors>no</errors> </response>
calendar/entries/list#
Service
https://api.timewax.com/calendar/entries/list/
Goal
Retrieving resource bookings.
Request
The following xml structure must be provided:
<request>
<token></token>
<dateFrom></dateFrom>
<dateTo></dateTo>
<entryId></entryId>
<resource></resource>
<project></project>
<breakdown></breakdown>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| dateFrom | Date from. Format yyyymmdd | 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>
<id></id>
<date></date>
<resourceName></resourceName>
<resourceCode></resourceCode>
<resourceEmployeeNumber></resourceEmployeeNumber>
<resourceId></resourceId>
<project></project>
<projectCode></projectCode>
<breakdown></breakdown>
<breakdownCode></breakdownCode>
<breakdownId></breakdownId>
<breakdownParent></breakdownParent>
<breakdownParentCode></breakdownParentCode>
<status></status>
<type></type>
<note></note>
<timeFrom></timeFrom>
<timeTo></timeTo>
<hours></hours>
<description></description>
<remarks></remarks>
<location>m</location>
<requestDepartmentCode></requestDepartmentCode>
<requestDepartmentName></requestDepartmentName>
<requestPositionCode></requestPositionCode>
<requestPositionName></requestPositionName>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
<addDate></addDate>
<modifyDate></modifyDate>
</entry>
</entries>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| entries/entry/date | The date of the booking |
| entries/entry/resourceName | Name of the resource |
| entries/entry/resourceCode | Code of the resource |
| entries/entry/resourceEmployeeNumber | Employee number of the resource |
| entries/entry/resourceId | Internal system ID of the resource |
| entries/entry/project | Project name |
| entries/entry/projectCode | Project code |
| entries/entry/breakdown | Activity name |
| entries/entry/breakdownCode | Activity code |
| entries/entry/breakdownId | Internal system ID of the activity |
| entries/entry/breakdownParent | Name of the parent activity |
| entries/entry/breakdownParentCode | Code of the parent activity |
| entries/entry/status | Status of the booking (Hard or Soft) |
| entries/entry/type | Field list value from the type field |
| entries/entry/note | Yes or No. Indicates if the booking is a note entry |
| entries/entry/timeFrom | Start time of the booking |
| entries/entry/timeTo | End time of the booking |
| entries/entry/hours | Number of hours |
| entries/entry/description | Description |
| entries/entry/remarks | Remarks |
| entries/entry/location | Location |
| entries/entry/requestDepartmentCode | Code of the department for which a resource is requested |
| entries/entry/requestDepartmentName | Name of the department for which a resource is requested |
| entries/entry/requestPositionCode | Code of the position for which a resource is requested |
| entries/entry/requestPositionName | Name of the position for which a resource is requested |
| entries/entry/requestSkillLevel1 | Skill 1 for which a resource is requested |
| entries/entry/requestSkillLevel2 | Skill 2 for which a resource is requested |
| entries/entry/requestSkillLevel3 | Skill 3 for which a resource is requested |
| entries/entry/addDate | The add date of the booking |
| entries/entry/modifyDate | The modification date of the booking |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
calendar/entries/list_changed#
Service
https://api.timewax.com/calendar/entries/list_changed/
Goal
Retrieving resource bookings that have been added, modified or deleted 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>true</valid>
<entries>
<entry>
<id></id>
<date></date>
<resourceName></resourceName>
<resourceCode></resourceCode>
<resourceEmployeeNumber></resourceEmployeeNumber>
<resourceId></resourceId>
<project></project>
<projectCode></projectCode>
<breakdown></breakdown>
<breakdownCode></breakdownCode>
<breakdownId></breakdownId>
<breakdownParent></breakdownParent>
<breakdownParentCode></breakdownParentCode>
<status></status>
<type></type>
<note></note>
<timeFrom></timeFrom>
<timeTo></timeTo>
<hours></hours>
<description></description>
<remarks></remarks>
<location>m</location>
<requestDepartmentCode></requestDepartmentCode>
<requestDepartmentName></requestDepartmentName>
<requestPositionCode></requestPositionCode>
<requestPositionName></requestPositionName>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
<addDate></addDate>
<modifyDate></modifyDate>
<deleteDate></deleteDate>
</entry>
</entries>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| entries/entry/date | The date of the booking |
| entries/entry/resourceName | Name of the resource |
| entries/entry/resourceCode | Code of the resource |
| entries/entry/resourceEmployeeNumber | Employee number of the resource |
| entries/entry/resourceId | Internal system ID of the resource |
| entries/entry/project | Project name |
| entries/entry/projectCode | Project code |
| entries/entry/breakdown | Activity name |
| entries/entry/breakdownCode | Activity code |
| entries/entry/breakdownId | Internal system ID of the activity |
| entries/entry/breakdownParent | Name of the parent activity |
| entries/entry/breakdownParentCode | Code of the parent activity |
| entries/entry/status | Status of the booking (Hard or Soft) |
| entries/entry/type | Field list value from the type field |
| entries/entry/note | Yes or No. Indicates if the booking is a note entry |
| entries/entry/timeFrom | Start time of the booking |
| entries/entry/timeTo | End time of the booking |
| entries/entry/hours | Number of hours |
| entries/entry/description | Description |
| entries/entry/remarks | Remarks |
| entries/entry/location | Location |
| entries/entry/requestDepartmentCode | Code of the department for which a resource is requested |
| entries/entry/requestDepartmentName | Name of the department for which a resource is requested |
| entries/entry/requestPositionCode | Code of the position for which a resource is requested |
| entries/entry/requestPositionName | Name of the position for which a resource is requested |
| entries/entry/requestSkillLevel1 | Skill 1 for which a resource is requested |
| entries/entry/requestSkillLevel2 | Skill 2 for which a resource is requested |
| entries/entry/requestSkillLevel3 | Skill 3 for which a resource is requested |
| entries/entry/addDate | The add date of the booking |
| entries/entry/modifyDate | The modification date of the booking |
| entries/entry/deleteDate | The deletion date of the booking |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
calendar/entries/edit#
Service
https://api.timewax.com/calendar/entries/edit/
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>
<note></note>
<date></date>
<timeFrom></timeFrom>
<hours></hours>
<breaktime></breaktime>
<traveltime></traveltime>
<fullDay></fullDay>
<location></location>
<description></description>
<remarks></remarks>
<linkedResources>
<resource></resource>
</linkedResources>
<requestOrganisationalUnit></requestOrganisationalUnit>
<requestPosition></requestPosition>
<requestSkillLevel1></requestSkillLevel1>
<requestSkillLevel2></requestSkillLevel2>
<requestSkillLevel3></requestSkillLevel3>
</entry>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| id | Id of the booking to edit | yes |
| type | Type of the booking: “entry” for resource bookings, “request” for bookings without a resource | yes |
| resource | Code or name of the resource | When type= “entry”: yes |
| project | Code or name of the project | yes |
| breakdown | Code or name of the activity | yes |
| status | Hard or Soft | no |
| note | Yes or no. Determines if this booking is a note booking | no |
| date | Date of the booking. Format: yyyymmdd or yyyy-mm-dd | yes |
| timeFrom | Start time for the booking. Format: hh:mm | yes |
| hours | Number of hours | yes |
| breaktime | Number of hours for break time | no |
| traveltime | Number of hours for travel time | no |
| fullDay | Yes or No. Marks the booking as “Full day” | no |
| Location | The location field | no |
| description | The description field | no |
| remarks | The remarks field | no |
| linkedResources/resource | Code or name of a resource. Only used when booking type = “request” | no |
| requestOrganisationalUnit | The department when request information is needed | no |
| requestPosition | The position when request information is needed | no |
| requestSkillLevel1 | First skill when request information is needed | no |
| requestSkillLevel2 | Second skill when request information is needed | no |
| requestSkillLevel3 | Third skill when request information is needed | no |
The following xml structure is received after an successful execution:
<response> <valid>yes</valid> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
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 a resource booking.
Request
The following xml structure must be provided:
<request>
<token></token>
<entry>
<id></id>
</entry>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| id | The unique id of a booking. 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
Retrieving details of a project planning for a project.
Request
The following xml structure must be provided:
<request>
<token></token>
<project></project>
<version></version>
</request>
| Parameter | Description | Required |
|---|---|---|
| token | Token for this request | yes |
| project | The project code or name | yes |
| version | The version of the planning | no |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid>
<Entries>
<Entry>
<project></project>
<projectCode></projectCode>
<status></status>
<breakdown></breakdown>
<breakdownCode></breakdownCode>
<startdate></startdate>
<enddate></enddate>
<duration></duration>
<comments></comments>
<estimate></estimate>
<label></label>
<predecessors>
<predecessor>
<projectCode></projectCode>
<breakdownCode></breakdownCode>
</predecessor>
</predecessors>
<successors>
<successor>
<projectCode></projectCode>
<breakdownCode></breakdownCode>
</predecessor>
</successors>
</Entry>
</Entries>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| project | Project name |
| projectCode | Project code |
| version | Version of the project planning |
| breakdown | Activity name |
| breakdownCode | Activity code |
| startdate | Start date of the activity |
| enddate | End date of the activity |
| duration | Duration in days |
| comments | Comment to the duration |
| estimate | Estimated 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 |
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 | Date from in format yyyymmdd | yes |
| dateTo | Date to in format yyyymmdd | yes |
| resource | Code or name of a resource | no |
| project | Code or name of a project | no |
| onlyApprovedEntries | Yes or no, to select based on approval status | no |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<entries>
<entry>
<id></id>
<date></date>
<resource></resource>
<resourceCode></resourceCode>
<project></project>
<projectCode></projectCode>
<breakdown></breakdown>
<breakdownId></breakdownId>
<breakdownCode></breakdownCode>
<breakdownParent></breakdownParent>
<breakdownParentCode></breakdownParentCode>
<status></status>
<dateUpdateStatus></dateUpdateStatus>
<reference></reference>
<type></type>
<timeFrom></timeFrom>
<timeTo></timeTo>
<hours></hours>
<description></description>
<KM></KM>
<descriptionKM></descriptionKM>
<rejectionRemarks></rejectionRemarks>
<invoiceStatus></invoiceStatus>
<commercialRate></commercialRate>
<addDate></addDate>
<modifyDate></modifyDate>
</entry>
</entries>
</response>
| Parameter | Description |
|---|---|
| valid | Indication that service was executed successfully |
| id | The unique id of the time line |
| date | The date of the booking |
| resource | Resource name |
| resourceCode | Resource code |
| project | Project name |
| projectCode | Project code |
| breakdown | Activity name |
| breakdownId | Internal ID of the activity |
| breakdownCode | Activity code |
| breakdownParent | Name of the parent activity |
| breakdownParentCode | Code of the parent activity |
| status | Status of the booking |
| dateUpdateStatus | Last update of the time line (approved or rejected) |
| type | Value from the field type |
| reference | Value in the reference field |
| timeFrom | Start time of the time line in format hh:mm |
| timeTo | End time of the time line in format: hh:mm |
| hours | Number of hours |
| description | Description |
| KM | Number of kilometers |
| descriptionKM | Description of the kilometers |
| rejectionRemarks | Remarks if the time line has been rejected |
| invoiceStatus | Invoice status |
| commercicalRate | Commercial rate applied to this time line |
| addDate | Add date of the time line |
| modifyDate | Modification date of the time line |
The following xml structure is received after an incorrect execution:
<response> <valid>no</valid> <errors>no</errors> </response>
| Parameter | Description |
|---|---|
| valid | Indication that service was not executed successfully |
| errors | Reason why the service has executed unsuccessfully |
time/entries/list_changed#
Service
https://api.timewax.com/time/entries/list_changed/
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 |