Update a Receipt

Edit an existing receipt in your ConstructionOnline company account

 https://api.constructiononline.com/api/Receipts?id={id}&Info={receiptInfo}

This endpoint allows users to edit an existing receipt within their ConstructionOnline company account. To update a receipt, users need the unique numerical ID associated with it, stored in the "ID" property. Updated properties should be specified in the request's "receiptInfo" parameter; only the properties listed here will be modified, while all others remain unchanged.

To update a receipt item, users also need the unique numerical ID assigned to that specific item.

• Requests
• Responses

Requests

id: integer

• Unique identifier for the receipt.

Info: JSON 

• Updated properties for the receipt.
• Allowed properties for the receipt: TITLE, SUBTOTAL, TAX_PERCENT, TAX_TYPE, VENDOR_ID, NOTES, TRADE, RECEIPT_STATUS, TRAFFIC_COLOR, TAGS, ITEMS
  • Allowed properties for the receipt ITEMS: QTY, RATE 

Sample request URLs:

• Lump sum receipt:
  • https://api.constructiononline.com/api/Receipts/id=26&Info={"TITLE" : "Lumber Receipt" , "SUBTOTAL" : "14250.67"}
• Itemized receipt:
  
  • https://api.constructiononline.com/api/Receipts/id=28&Info={"TITLE" : "Lumber Receipt" , "ITEMS" : [{ "ID" : "52" , "RATE" : "45.00"}]}

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
# {id} with the receipt's ID
# {receiptInfo} with the updated properties

curl -X PUT https://api.constructiononline.com/api/Receipts?id={id}&Info={receiptInfo} -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 
           {id} with the receipt's ID 
           {receiptInfo} with the updated properties */

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.PutAsync(endpoint, content).Result.ToString();
                }
                return response;
            }
     MakeRequest("api/Receipts?id={id}&Info={receiptInfo}");

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{id} with the receipt's ID
#{receiptInfo} with the updated properties

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("PUT", url, headers=headers, data=payload)
                return json.dumps(json.loads(response.text), indent=2)   
    #Main Program 
    print(makeRequest("api/Receipts?id={id}&Info={receiptInfo}"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key 
           {id} with the receipt's ID 
           {receiptInfo} with the updated properties */

 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: 'PUT',
                    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/Receipts?id={id}&Info={receiptInfo}");

Responses

 200: Success

A successful request will return a 200 response with a record of the edited receipt 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. The ID may have been entered incorrectly or an receipt with the entered ID does not exist.

 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 11, 2024