Get all Payments

Returns a record of all payments within your ConstructionOnline company account

https://api.constructiononline.com/POPayments

This endpoint allows users to extract a record of all payments from their ConstructionOnline company account.

• Requests
• Responses

Requests

Sample URL request:

• https://api.constructiononline.com/api/POPayments

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

curl https://api.constructiononline.com/api/POPayments-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 */

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/POPayments"));

Python

#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key

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/POPayments"))

JavaScript

/* replace {username} with the email address for your ConstructionOnline account
           {password} with your ConstructionOnline password
           {apikey} with your provided API key */

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/POPayments");

Responses

 200: Success

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

{   "ID": 2948,
    "TITLE": "Payment# 1432504-000",
    "NUMBER": "1432504-000",
    "COMPANY_ID": 23573,
    "PRJ_ID": 1432504,
    "ESTIMATE_ID": 504358,
    "VENDOR_ID": 1551562,
    "PAID_DATE": "2024-09-25T00:00:00",
    "DATE_CREATED": "2024-09-24T14:56:01.037",
    "CREATED_BY": 885048,
    "SUBTOTAL": 0.0,
    "TOTAL": 92320.0,
    "LMOD": "2024-09-24T19:56:01.04",
    "LMOD_BY": 885048,
    "NOTES": "",
    "PAYMENT_METHOD": 0,
    "TRAFFIC_COLOR": 0,
    "ACCT_INT_ID": 0,
    "ACCT_INT_VENDOR_ID": 0,
    "SENT_TO_ACCT_INT_VALUE": 0.0,
    "ITEMS": [
        {
            "ID": 44900,
            "PAYMENT_ID": 2948,
            "NAME": "HVAC Subcontract",
            "DESCRIPTION": "",
            "RELATED_ITEM_ID": 91401849,
            "ORG_RELATED_ITEM_ID": 91401849,
            "RELATED_ITEM_TYPE": 0,
            "IS_ADDITIONAL_ITEM": false,
            "PO_ID": 2392,
            "PO_ITEM_ID": 45342,
            "RECEIPT_ID": 0,
            "RECEIPT_ITEM_ID": 0,
            "BILL_ID": 21,
            "BILL_ITEM_ID": 138,
            "TAX_TYPE_ID": 0,
            "TAX_PERCENT": 0.0,
            "SUBTOTAL_COST": 92320.0,
            "TOTAL_COST": 92320.0,
            "PAID_TO_DATE_NO_TAX": 92320.0,
            "PAID_TO_DATE": 92320.0,
            "REMAINING_NO_TAX": 0.0,
            "REMAINING": 0.0,
            "SUBTOTAL": 92320.0,
            "TOTAL": 92320.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: Oct 2, 2024