Get Company Overhead and Margin

Returns all entries within the Company Overhead and Margin section of an estimate

https://api.constructiononline.com/api/EstimateMarkup?estID={estID}

In ConstructionOnline, each estimate has a dedicated Company Overhead and Margin section which contains calculated values for company overhead, company margin, contingency fees, and any other overhead/profit costs the company has accounted for. This endpoint allows users to extract every entry (in other words, each individual line item) from an estimate's Company Overhead and Margin section in one single call.

• Requests
• Responses

Requests

REQUIRED PARAMETERS

estID: integer

• Unique identifier for the estimate.

Sample URL request:

• https://api.constructiononline.com/api/EstimateMarkup?estID=456789

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
# {estID} with the estimate's ID

curl https://api.constructiononline.com/api/EstimateMarkup?estID={estID} -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 
           {estID} with the estimate's ID */

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/EstimateMarkup?estID={estID}"));

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{estID} with the estimate's ID

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/EstimateMarkup?estID={estID}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {estID} with the estimate's ID */

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/EstimateMarkup?estID={estID}");

Responses

 200: Success

A successful request will return a 200 response with the requested company overhead and margin components in the body, as seen below. Definitions for all returned properties can be found here. 

{
        "ID": 1396830,
        "NAME": "Company Overhead",
        "ESTIMATE_ID": 367610,
        "VALUE": 8.0,
        "MARKUP_TYPE": 2,
        "INVOICED": 0.0,
        "ACTUALS": 0.0,
        "QB_ACTUALS": 0.0,
        "QB_INVOICED": 0.0,
        "TOTAL_MARKUP": 29305.000000000004
    },
    {
        "ID": 1396831,
        "NAME": "Company Margin",
        "ESTIMATE_ID": 367610,
        "VALUE": 30.0,
        "MARKUP_TYPE": 1,
        "INVOICED": 0.0,
        "ACTUALS": 0.0,
        "QB_ACTUALS": 0.0,
        "QB_INVOICED": 0.0,
        "TOTAL_MARKUP": 169550.35714285722
    },
    {
        "ID": 1396832,
        "NAME": "Contingency",
        "ESTIMATE_ID": 367610,
        "VALUE": 0.0,
        "MARKUP_TYPE": 3,
        "INVOICED": 0.0,
        "ACTUALS": 0.0,
        "QB_ACTUALS": 0.0,
        "QB_INVOICED": 0.0,
        "TOTAL_MARKUP": 0.0
    }