Returns all estimates in your ConstructionOnline company account that were modified after the specified date
https://api.constructiononline.com/v2/estimates?fromDate={fromDate}
This endpoint returns all estimates that were recently modified, based on the date specified by the user. All estimates that were modified on or beyond the entered date will be returned. Please note that this endpoint does not return individual categories, subcategories, or items belonging to the estimate. This endpoint only returns a high-level estimate object, not the individual components of the estimate.
Requests
REQUIRED PARAMETERS
fromDate: date
- Oldest modification date. All estimates modified on or after the date will be returned.
- Should be entered in YYYY-MM-DD format. For example: October 14 2023 would be 2023-10-14.
Sample URL request:
- https://api.constructiononline.com/api/v2/estimates?fromDate=2023-01-01
Example requests in cURL, C#, Python, and JavaScript can be found below:
cURL
# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {fromDate} with the oldest modification date
curl https://api.constructiononline.com/api/v2/estimates?fromDate={fromDate} -u {email}:{password} -H 'APIKey:{apikey}'
C#
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{fromDate} with the oldest modification date */
public string GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.Timeout = new TimeSpan(0, 0, 30);
client.BaseAddress = new Uri("http://api.constructiononline.com");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
client.DefaultRequestHeaders.Add("APIKey", apikey);
client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
response = client.GetAsync(endpoint).Result;
}
return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/v2/estimates?fromDate={fromDate}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{fromDate} with the oldest modification date
import base64, requests, json
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
url = "https://api.constructiononline.com/" + endpoint
userPass = username + ":" + password
headers = {
"APIKey": apikey,
"Accept-Encoding": "gzip, deflate, br",
"Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
}
response = requests.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/v2/estimates?fromDate={fromDate}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{fromDate} with the oldest modification date */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint) {
auth = btoa('${username}:${password}');
var myHeaders = new Headers();
myHeaders.append("APIKey", apikey);
myHeaders.append("Accept-Encoding", "gzip, deflate, br");
myHeaders.append("Authorization", "Basic ${auth}");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
return response;
};makeRequest("api/v2/estimates?fromDate={fromDate}");
Responses
200: Success
A successful request will return a 200 response with the requested estimates in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 367610,
"NAME": "1342 S Ross St Estimate",
"MARKUP_NAME": "Company Overhead and Margin",
"TOTAL_PRICE": 565167.85714285728,
"TOTAL_ALLOWANCE": 0.0,
"TOTAL_COM": 198855.35714285722,
"TOTAL_MARKUP": 460.0,
"TOTAL_BASECOST": 365852.50000000006,
"TOTAL_SALES_TAX": 0.0,
"ORIGINAL_CONTRACT_VALUE": 565167.85714285728,
"TOTAL_ACTUALS": 0.0,
"TOTAL_COMMITTED": 0.0,
"TOTAL_INVOICED": 0.0,
"TOTAL_REMAINING": 564707.85714285728,
"TOTAL_BALANCE": 565167.85714285728,
"TOTAL_ADJUSTMENT": 0.0,
"TOTAL_ADJUSTEDCOST": 365852.50000000006,
"TOTAL_QB_ACTUALS": 0.0,
"TOTAL_QB_INVOICED": 0.0,
"TOTAL_QB_COMMITTED": 0.0,
"TOTAL_LINKED_CO_PRICE": 0.0,
"TOTAL_LINKED_CO_COST": 0.0,
"TOTAL_CONTRACTPRICE": 366312.50000000006,
"CREATED_BY": 999997,
"DATE_CREATED": "2022-09-22T14:44:14.263",
"CREATOR": "Alex Kim",
"LMOD_BY": 999997,
"LMOD": "2022-09-22T14:44:14.257",
"MODIFIER": "Alex Kim",
"FIVE_COLUMN_ESTIMATE": false,
"ADVANCED_ESTIMATE": true,
"COST_TOTAL": 365852.50000000006,
"COST_ACTUAL": 0.0,
"COST_INVOICED": 0.0,
"COST_VARIENCE": 0.0,
"COST_COMMITTED": 0.0,
"COST_PAID": 0.0,
"TOTAL_PROFIT": 460.0,
"PROJECT_ID": 1312899,
"PROJECT_NAME": "1342 S Ross St",
"LAST_QBD_ESTIMATE_DATE": null,
"LAST_QBD_ACTUAL_DATE": null,
"LAST_QBD_INVOICE_DATE": null,
"LAST_QBD_PO_DATE": null
},
{
(estimates continued....)
}
404: Error
The server was not able to locate the resource specified in the request. The date may not have been entered in an acceptable format, or no estimates were modified on/after the specified date.
429: Error
The user has surpassed the request rate limit for the hour, day, week, or month.
500: Error
There was an internal server error and the server was unable to complete the request.
Last updated: Feb 7, 2024