xmlapi/costs.xml
jsonapi/costs.json
| Parameter | Type | Description |
|---|---|---|
| [IN] Parameters described in Overview | ||
| Company | String | [IN] The company number(s) |
| Job-And-Phase | String | [IN] Phase to retrieve cost lines for |
| Job-Number | String | [IN] Job/Opp to retrieve cost lines for |
| Response | XML or JSON | [OUT] XML or JSON containing cost lines for the job or phase supplied |
Description
(example in a browser: http://dev/xmlapi/costs.xml?company=1&job-number=1/00008619&user=user&password=user)
The Costs call retrieves a list of cost lines for a specified job/opp or phase.
Parameters
- Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
- Job-And-Phase – The fully qualified job-and-phase number
- Job-Number – The job number to return all cost records for a job/opp
Note
Only pass EITHER Job-And-Phase OR Job-Number
Return Values
Response – XML or JSON containing the list of cost lines in the correct order.
<Costs TotalRows=nnn TotalPages=nnn MorePages=True/False>
<Cost>
<JobPhase> Job phase number
<Type> Type. T = Time, M = Material, P = Purchases
<Name> Staff Name (Time and Materials) or Supplier name (Purchases)
<Description> Description of cost
<Date> Date cost incurred
<Quantity> Hours/Days for time, Units for Materials
<Value> Cost value
<Detail> Cost detail text