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>

   <planAmount></planAmount>

   <percentageComplete></percentageComplete>

   <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 breakdown.
invoiceType	Type for invoicing. Options: Non-chargeable, Fixed price or Costing
type	Attribute value.
budgetAmount	The budgeted amount.
planAmount	The planned amount
percentageComplete	Indication of percentage complete.
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

Timewax support| Jurgen March 31, 2017 13:41

Comments