Generate a new purchase order in your ConstructionOnline company account
https://api.constructiononline.com/api/PurchaseOrders?Info={poInfo}
This endpoint allows users to create a new purchase order for a project in their ConstructionOnline company account. If successful, the endpoint will return a record of the newly created purchase order. The new purchase order will be automatically assigned a unique numerical ID called 'ID', which will be used for any future references. The required fields for this endpoint include PRJ_ID, VENDOR_ID, and ITEMS (NAME and RATE); all other properties are optional and can be entered during purchase order creation.
Please note: purchase orders can only be created for existing projects in ConstructionOnline. If a specific project ID is not included in the request, the purchase order creation will fail.
Requests
Info: JSON
- Properties to be added to the purchase order.
- Required properties for the purchase order: PRJ_ID, VENDOR_ID, ITEMS
- Required properties for the purchase order ITEMS: NAME, RATE
- Allowed properties for the purchase order: TITLE, DUE_DATE, START_DATE, COMPLETION_DATE, DELIVERY_DATE, ACTIVE, APPROVAL_STATUS, APPROVER, APPROVAL_DATE, VERIFICATION_STATUS, VERIFIER, VERIFICATION_DATE, INT_NOTES, SCOPE_OF_WORK, TRADE, PO_TYPE, TRAFFIC_COLOR, LMOD, LMOD_BY, DATE_CREATED, CREATED_BY
- Allowed properties for the purchase order ITEMS: COST_CODE_ID, TAX_TYPE_ID, TAX_PERCENT, DESCRIPTION, QTY, UNIT
Individual properties for creation should be entered as JSON key-value pairs, as seen below:
{
"PRJ_ID": "1340167",
"VENDOR_ID" : "885048",
"DUE_DATE" : "2024-11-22T00:00:00",
"START_DATE" : "2024-11-11T00:00:00",
"COMPLETION_DATE" : "2024-11-21T00:00:00",
"ITEMS" : [
{
"NAME" : "HVAC Labor",
"RATE" : "15000.00"
}
{
"NAME" : "HVAC Materials"
"RATE" : "62320.00"
}
]
}
Example requests in cURL, C#, Python, and JavaScript can be found below:
# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
# {poInfo} with the information for purchase order creation
curl -X POST https://api.constructiononline.com/api/PurchaseOrders?Info={poInfo} -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
{poInfo} with the information for purchase order creation */
public string MakeRequest(string endpoint, string payload) {
string username = {username};
string password = {password};
string apiKey = {apikey};
string response = "";
var handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
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");
HttpContent content = new StringContent(payload, System.Text.Encoding.UTF32, "application/json");
response = client.PostAsync(endpoint, content).Result.ToString();
}
return response;
}
MakeRequest("api/PurchaseOrders?Info={poInfo}");
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{poInfo} with the information for purchase order creation
import base64, requests, json
#Global Variables
apikey = {apikey}
username = {username}
password = {password}
#Functions
def makeRequest(endpoint, payload):
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.request("POST", url, headers=headers, data=payload)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/PurchaseOrders?Info={poInfo}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{poInfo} with the information for purchase order creation */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint, payload) {
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: 'POST',
body: '',
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/PurchaseOrders?Info={poInfo}");
Responses
200: Success
A successful request will return a 200 response with a record of the newly created purchase order in the body.
A sample response and property definitions can be found here.
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: Nov 4, 2024