Returns all receipts for the project that corresponds with the provided ID
https://api.constructiononline.com/Receipts?projectID={id}
This endpoint allows users to extract all receipts from a specific project within their ConstructionOnline company account. Users must know the unique ID assigned to the project to call this endpoint.
Requests
REQUIRED PARAMETERS
projectID: integer
- Unique identifier for the project.
Sample URL request:
- https://api.constructiononline.com/api/Receipts?projectID=1432504
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
# {projectID} with the project's ID
curl https://api.constructiononline.com/api/Receipts?projectID={projectID} -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
{projectID} with the project'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/Receipts?projectID={projectID}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{projectID} with the project'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/Receipts?projectID={projectID}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{projectID} with the project'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/Receipts?projectID={projectID}");
Responses
200: Success
A successful request will return a 200 response with the requested receipts in the body, as seen below. Definitions for all returned properties can be found here.
{ "ID": 26,
"TITLE": "Home Depot Receipt - Lumber",
"COMPANY_ID": 23573,
"PRJ_ID": 1432504,
"DATE_CREATED": "2024-09-23T08:13:03.527",
"CREATED_BY": 885048,
"SUBTOTAL": 71.53,
"TAX_PERCENT": 7.48917144054772,
"TAX_TYPE": 3333031,
"TOTAL": 76.8870043314238,
"AMOUNT_BILLED": 0.0,
"AMOUNT_PAID": 0.0,
"PAID": false,
"VENDOR_ID": 0,
"LMOD": "2024-09-23T08:18:22.977",
"LMOD_BY": 885048,
"NOTES": "",
"TRADE": 0,
"RECEIPT_STATUS": 105770,
"IS_EXPENSE": false,
"TRAFFIC_COLOR": 0,
"ITEMS": [
{
"ID": 49,
"PRJ_ID": 1432504,
"RECEIPT_ID": 26,
"NAME": "4x6-10FT #2 PT GC",
"QTY": 1.0,
"UNIT": 266,
"RATE": 15.67,
"SUBTOTAL": 15.67,
"TOTAL": 16.8435531647338,
"TAX_TYPE_ID": 3333031,
"TAX_PERCENT": 7.48917144054772,
"AMOUNT_BILLED": 0.0,
"AMOUNT_BILLED_NO_TAX": 0.0,
"AMOUNT_PAID": 0.0,
"AMOUNT_PAID_NO_TAX": 0.0
},
{
"ID": 50,
"PRJ_ID": 1432504,
"RECEIPT_ID": 26,
"NAME": "4x4-10FT #2 PT GC",
"QTY": 4.0,
"UNIT": 266,
"RATE": 11.88,
"SUBTOTAL": 47.52,
"TOTAL": 51.0788542685483,
"TAX_TYPE_ID": 3333031,
"TAX_PERCENT": 7.48917144054772,
"AMOUNT_BILLED": 0.0,
"AMOUNT_BILLED_NO_TAX": 0.0,
"AMOUNT_PAID": 0.0,
"AMOUNT_PAID_NO_TAX": 0.0
},
{
"ID": 51,
"PRJ_ID": 1432504,
"RECEIPT_ID": 26,
"NAME": "2x4-8FT #2PRIME PT GC WEATHERSHIELD",
"QTY": 2.0,
"UNIT": 266,
"RATE": 4.17,
"SUBTOTAL": 8.34,
"TOTAL": 8.96459689814168,
"TAX_TYPE_ID": 3333031,
"TAX_PERCENT": 7.48917144054772,
"AMOUNT_BILLED": 0.0,
"AMOUNT_BILLED_NO_TAX": 0.0,
"AMOUNT_PAID": 0.0,
"AMOUNT_PAID_NO_TAX": 0.0
}
]
}
404: Error
The server was not able to locate the resource specified in the request.
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: Sep 24, 2024