Service
https://api.timewax.com/project/get/
Goal
Getting a project with all fields.
Request
The following xml structure must be provided:
<request>
<token></token>
<project></project>
</request>
Parameter | Description | Required |
---|---|---|
token | Token for this request | yes |
project/code | Project code | yes |
The following xml structure is received after an successful execution:
<response>
<valid>yes</valid> <project>
<code></code>
<name></name>
<shortName></shortName>
<useInvoicing></useInvoicing>
<chargeable></chargeable>
<approveTime></approveTime>
<approveExpenses></approveExpenses>
<approveCalenderEntries></approveCalenderEntries>
<orgUnitManagerIsApprover></orgUnitManagerIsApprover>
<blockEntries></blockEntries>
<isTemplate></isTemplate>
<isActive></isActive>
<startDate></startDate>
<endDate></endDate>
<notes></notes>
<company></company>
<organisationalUnit></organisationalUnit>
<projectManager></projectManager>
<currency></currency>
<parentProject></parentProject>
<status></status>
<color></color>
<emailContactPerson></emailContactPerson>
<externalLinkFiles></externalLinkFiles>
<invoice>
<responsible></responsible>
<backupResponsible></backupResponsible>
<debtor>
<attn></attn>
<name></name>
<address></address>
<postcode></postcode>
<city></city>
<country></country>
<debtorNumber></debtorNumber>
<email></email>
</debtor>
<invoiceLayout></invoiceLayout>
<invoiceLayoutCreditnote></invoiceLayoutCreditnote>
<invoicetypeHours></invoicetypeHours>
<invoicetypeKM></invoicetypeKM>
<invoicetypeKMRate></invoicetypeKMRate>
<invoicetypeExpenses></invoicetypeExpenses>
<VATSalesHours></VATSalesHours>
<VATSalesExpenses></VATSalesExpenses>
<reference1></reference1>
<reference2></reference2>
<reference3></reference3>
<reference4></reference4>
<reference5></reference5>
</invoice>
<portfolio>
<code></code>
<name></name>
</portfolio>
</project>
</response>
Parameter | Description |
---|---|
valid | Indication that service was not executed successfully |
project/code | Project code |
project/name | Project name |
project/shortName | Project short name |
project/useInvoicing | yes or no. Is it possible to invoice from this project? |
project/chargeable | yes or no. Is this project chargeable? |
project/approveTime | yes or no. Do submitted hours need to be approved? |
project/approveExpenses | yes or no. Do submitted expenses need to be approved? |
project/approveCalenderEntries | yes or no. Can calendar entries beapproved? |
project/orgUnitManagerIsApprover | yes or no. |
project/blockEntries | yes or no. Blocks making bookings on the proejct |
project/isTemplate | yes or no. Can this project be used as a template for new projects? |
project/isActive | yes or no. Is the project active? |
project/startDate | yyyymmdd. Start date of the project |
project/endDate | yyyymmdd. End dat of the project |
project/notes | Remarks |
project/company | The company/customer name for this project |
project/organisationalUnit | Name. The organizational unit where the project belongs |
project/projectManager | Name. Project manager of the project (Resource) |
project/currency | Project currency |
project/parentProject | Name. The parent project (Project) |
project/status | Project status (Attributes) |
project/color | Project color (hexadecimal value) |
project/externalLinkFiles | URL to an online file location |
project/status | status (Attribute) |
invoice/blockInvoice | yes or no. Block invoices for this project? |
invoice/backupResponsible | Name. Who is also allowed to start the invoice run |
invoice/debtor/name, address, postcode, city, country, debtorNumber and email | Adres of the debtor (company, debtor role) |
invoice/invoiceLayout | Name. Invoice lay-out for the invoice |
invoice/invoiceLayoutCreditnote | Name. Invoice lay-out for the credit note |
invoice/invoicetypeHours | Type hours (Attributes) |
invoice/invoicetypeKM | yes or no. Do kilometers have to be invoiced? |
invoice/invoicetypeKMRate | Rate per kilometer |
invoice/invoicetypeExpenses | yes or no. Do expenses have to be invoiced? |
invoice/VATSalesHours | Name. What VAT percentage to apply for hours. |
invoice/VATSalesExpenses | Name. What VAT percentage to apply for expenses. |
invoice/reference1 | Invoice reference 1 |
invoice/reference2 | Invoice reference 2 |
invoice/reference3 | Invoice reference 3 |
invoice/reference4 | Invoice reference 4 |
invoice/reference5 | Invoice reference 5 |
portfolio/code | Code of the portfolio |
portfolio/name | Name of the portfolio |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<errors>no</errors>
</response>
Parameter | Description |
---|---|
valid | Indication that service was not executed successfully |
error | Reason why the service has executed unsuccessfully |
Opmerkingen