Service
https://api.timewax.com/project/add/
Goal
Adding new projects
Request
The following xml structure must be provided:
<request> <token></token>
<project>
<code></code>
<name></name>
<shortName></shortName>
<useTimePlanning></useTimePlanning>
<useResourceBudget></useResourceBudget>
<useInvoicing></useInvoicing>
<chargeable></chargeable>
<approveTime></approveTime>
<approveExpenses></approveExpenses>
<blockEntries></blockEntries>
<isTemplate></isTemplate>
<isActive></isActive>
<startDate></startDate>
<endDate></endDate>
<notes></notes>
<company></company>
<organisationalUnit></organisationalUnit>
<projectManager></projectManager>
<currency></currency>
<parentProject></parentProject>
<status></status>
<color></color>
<externalLinkFiles></externalLinkFiles>
<emailContactPerson></emailContactPerson>
<invoice>
<blockInvoice></blockInvoice>
<responsible></responsible>
<backupResponsible></backupResponsible>
<debtor></debtor>
<invoiceLayout></invoiceLayout>
<invoiceLayoutCreditnote></invoiceLayoutCreditnote>
<invoicetypeHours></invoicetypeHours>
<invoicetypeKM></invoicetypeKM>
<invoicetypeKMRate></invoicetypeKMRate>
<invoicetypeExpenses></invoicetypeExpenses>
<VATSalesHours></VATSalesHours>
<VATSalesExpenses></VATSalesExpenses>
<reference1></reference1>
<reference2></reference2>
<reference3></reference3>
<reference4></reference4>
<reference5></reference5>
</invoice> <categories>
<alignment></alignment>
<risk></risk>
<location></location>
<complexity></complexity>
<knowledgeAvailible></knowledgeAvailible>
<budget></budget>
<businessType></businessType>
<duration></duration>
<financialRisk></financialRisk>
<decisionLevel></decisionLevel>
<benefits></benefits>
<politicalSensitivity></politicalSensitivity>
<productCategory></productCategory>
<innovation></innovation>
<portfolioAdvise>l</portfolioAdvise>
<priority></priority>
</categories>
</project>
</request>
Parameter | Description | Required |
---|---|---|
token | Token for this request | yes |
project/code | Project code | yes |
project/name | Project name | yes |
project/shortName | Project short name | yes |
project/useInvoicing | yes or no. Is it possible to invoice from this project? | no |
project/chargeable | yes or no. Is this project chargeable? | no |
project/approveTime | yes or no. Do submitted hours need to be approved? | no |
project/approveExpenses | yes or no. Do submitted expense need to be approved? | no |
project/blockEntries | yes or no. Blocks making bookings on the proejct | no |
project/isTemplate | yes or no. Can this project be used as a template for new projects? | no |
project/isActive | yes or no. Is the project active? | no |
project/startDate | yyyymmdd. Start date of the project | no |
project/endDate | yyyymmdd. End dat of the project | no |
project/notes | Remarks | no |
project/company | code or name. The company/customer for this project | yes |
project/organisationalUnit | code or name. The organizational unit where the project belongs | yes |
project/projectManager | code or name. Project manager of the project (Resource) | yes |
project/currency | Project currency | yes |
project/parentProject | code or name. The parent project(Project) | no |
project/status | Project status (Attributes) | no |
project/color | Project color (hexadecimal value) | no |
project/externalLinkFiles | URL to an online file location | no |
project/emailContactPerson | Email of the (external) contact person | no |
invoice/blockInvoice | yes or no. Block invoices for this project? | no |
invoice/responsible | code or name. Who is allowed to start the invoice run | yes, when project/useInvoicing = yes |
invoice/backupResponsible | code or name. Who is also allowed to start the invoice run | no |
invoice/debtor | Name of the debtor (company) | yes, when project/useInvoicing = yes |
invoice/invoiceLayout | code or name. Invoice lay-out for the invoice | no |
invoice/invoiceLayoutCreditnote | code or name. Invoice lay-out for the credit note | no |
invoice/invoicetypeHours | Type hours (Attributes) | no |
invoice/invoicetypeKM | yes or no. Do kilometers have to be invoiced? | no |
invoice/invoicetypeKMRate | Rate per kilometer | yes, when invoice/invoicetypeKM = yes |
invoice/invoicetypeExpenses | yes or no. Do expenses have to be invoiced? | no |
invoice/VATSalesHours | code or name. What VAT percentage to apply for hours. | no |
invoice/VATSalesExpenses | code or name. What VAT percentage to apply for expenses. | no |
invoice/reference1 | Invoice reference 1 | no |
invoice/reference2 | Invoice reference 2 | no |
invoice/reference3 | Invoice reference 3 | no |
invoice/reference4 | Invoice reference 4 | no |
invoice/reference5 | Invoice reference 5 | no |
categories/alignment | code or name. Attribute | no |
categories/risk | code or name. Attribute | no |
categories/location | code or name. Attribute | no |
categories/complexity | code or name. Attribute | no |
categories/knowledgeAvailible | code or name. Attribute | no |
categories/budget | code or name. Attribute | no |
categories/businessType | code or name. Attribute | no |
categories/duration | code or name. Attribute | no |
categories/financialRisk | code or name. Attribute | no |
categories/decisionLevel | code or name. Attribute | no |
categories/benefits | code or name. Attribute | no |
categories/politicalSensitivity | code or name. Attribute | no |
categories/productCategory | code or name. Attribute | no |
categories/innovation | code or name. Attribute | no |
categories/portfolioAdvise | code or name. Attribute | no |
categories/priority | code or name. 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 |
error | Reason why the service has executed unsuccessfully |
Comments