HomeAPI Reference
HomeAPI Reference
HomeAPI Reference
API Reference
Start typing to search…

Estimates

xmlapi/estimates.xml
jsonapi/estimates.json

Parameter

Type

Description

[IN] Parameters described in Overview

Company

String

[IN] The company number(s)

Job-And-Phase

String

[IN] Phase to retrieve estimate lines for

Job-Number

String

[IN] Job/Opp to retrieve estimate lines for

Response

XML or JSON

[OUT] XML or JSON containing estimate lines for the job or phase supplied

Description

The Estimates call retrieves a list of estimate 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 estimate lines for a job/opp

🚧

Note

Only pass EITHER Job-And-Phase OR Job-Number

Return Values

Response – XML or JSON containing the list of estimate lines in the correct order.

<Estimates  TotalRows=nnn TotalPages=nnn MorePages=True/False>
  <Estimate>
    <Phase> Phase number of estimate line
    <Type> Type: S = Staff Time, M = Material, B = Purchases bought-in, T = Tender template
    <Description> Estimate line description
    <EstimatedUnits> Hours/Days estimated (for time) or Units for Materials
    <ActualUnits> Hours/Days actual (for time) or Units for Materials
    <EstimatedCost> Estimated cost total for estimate line
    <ActualCost> Actual cost total for estimate line
    <Detail> Text detail (may contain paragraphs of text)