Service
https://api.timewax.com/calculation/list/
Goal
Requesting calculations.
Request
The following xml structure must be provided:
<request>
<token></token>
<dateFrom></dateFrom>
<dateTo></dateTo>
<department></department>
<client></client>
</request>
Parameter | Description | Required |
---|---|---|
token | Token for this request | yes |
dateFrom | Starting date. Format: yyyymmdd or yyyy-mm-dd. | no |
dateTo | Date to. Format: yyyymmdd or yyyy-mm-dd. | no |
resource | Code or name. Request calculations for a specific department. | no |
client | Code or name. Request calculations for a specific client. | no |
The following xml structure is received after an successful execution:
<response>
<valid>true</valid>
<message></message>
<calculations>
<calculation>
<code></code>
<name></name>
<departmentCode></departmentCode>
<departmentName></departmentName>
<clientCode></clientCode>
<clientName></clientName>
<projectCode></projectCode>
<projectName></projectName>
<date></date>
<status></status>
<statusName></statusName>
<template></template>
<active></active>
<description></description>
<footnote></footnote>
<groups>
<group>
<name></name>
<lines>
<line>
<name></name>>
<productCode></productCode>
<productName></productName>
<type></type>
<typeName></typeName>
<numberOfItems></numberOfItems>
<price></price>
<amount></amount>
<external></external>
<purchaseValue></purchaseValue>
<description></description>
</line>
</lines>
</group>
</groups>
</calculation>
</calculations>
</response>
Price per item
Parameter | Description |
---|---|
valid | Indication that service was executed successfully |
message | |
code | Code of the calculation |
name | Name of the calculation |
departmentCode | Code of the department |
departmentName | Name of the department |
clientCode | Client name |
clientName | Client code |
projectCode | Project code (only when status is 1) |
projectName | Project code (only when status is 1) |
date | Calculation date |
status | The status of the calculation (0 or 1) |
statusName | Status name (0 = Concept, 1 = Final) |
template | Yes or No |
active | Yes or No |
description | Value from field description |
footnote | Value from field footnote. |
groups/group/name | Name of the group |
Line/name | Value from the line description |
Line/productCode | Code of the product |
Line/productName | Name of the product |
Line/type | Code line type. 10001 = Hours, 10002 = Days and 10003 = Item |
Line/typeName | Name line type. 10001 = Hours, 10002 = Days and 10003 = Item |
Line/numberOfItems | Number of hours, days or Items |
Line/price | Price per item |
Line/amount | Line amount |
Line/external | Yes or No |
Line/purchaseValue | Purchase value |
Line/description | Line description |
The following xml structure is received after an incorrect execution:
<response>
<valid>no</valid>
<errors>no</errors>
</response>
Parameter | Description |
---|---|
valid | Indication that service was not executed successfully |
errors | Reason why the service has executed unsuccessfully |
Comments