Purchasing
      Back to home
      1. ConstructionOnline API Documentation
      2. Purchasing

      Purchasing Overview

      Discover more about construction purchasing tools with the ConstructionOnline API

      Table of Contents

      1. Introduction

      2. api/PurchaseOrders
      3. api/Bills
      4. api/Expenses
      5. api/Receipts
      6. api/POPayments
      7. Items

      Introduction

      In ConstructionOnline, users can accurately and efficiently manage and track their projects job cost data with purchasing tools such as Purchase Orders, Bills, Expenses, Receipts, and Payments. Users have the ability to create and review these purchasing tools allowing for detailed job costing for each project in ConstructionOnline. Each financial record—whether it's a purchase order, bill, expense, receipt, or payment—is composed of specific properties that define its details and ensure clear organization.

      The ConstructionOnline API provides five different types of purchasing endpoints:

      • The api/PurchaseOrders endpoints return detailed information about a purchase order, such as its name, related project, total cost, and more. These endpoints will also include the items that are associated with the purchase order. Each purchase order will return as an individual object.

      • The api/Bills endpoints return detailed information about a bill, such as its name, related project, total cost, and more. These endpoints will also include the items that are associated with the bill. Each bill will return as an individual object.

      • The api/Expenses endpoints return detailed information about an expense, such as its name, related project, total cost, and more. These endpoints will also include the items that are associated with the expense, if the expense is an itemized expense. Each expense will return as an individual object.

      • The api/Receipts endpoints return detailed information about a receipt, such as its name, related project, total costs, and more. These endpoints will also include the items that are associated with the receipt, if the receipt is an itemized receipt. Each receipt will return as an individual object.

      • The api/POPayments endpoints return detailed information about a payment, such as its name, related project, total costs, and more. These endpoints will also include the items that are associated with the payment. Each payment will return as an individual object.

      api/PurchaseOrders

      The following properties will return when an api/PurchaseOrders endpoint is called:

      Name Type Description
      ID integer Unique identifier for the purchase order.
      TITLE string Name of the purchase order as it appears in ConstructionOnline.
      PO_NUMBER string Reference number for the purchase order as it appears in ConstructionOnline.
      COMPANY_ID integer Unique identifier for the ConstructionOnline company.
      PRJ_ID integer Unique identifier for the project that contains the purchase order.
      ESTIMATE_ID integer Unique identifier for the associated estimate.
      FROM_SCRATCH

      boolean

      		 Signifies the how the purchase order was created. Returns true if the purchase order was created from scratch, false if the purchase order was created from an estimate/change order.
      ACTIVE boolean Signifies the state of the purchase order. Returns true if the purchase order is currently set to active, false if the purchase order is currently set to a draft.
      DATE_CREATED string Date and time the purchase order was created. 
      CREATED_BY integer

      Unique identifier for the user who created the purchase order.
      DUE_DATE string Date and time the purchase order is set to be due. 
      START_DATE string Date and time the purchase order is set to start.
      COMPLETION_DATE string Date and time the purchase order is set to complete.
      DELIVERY_DATE string Date and time the purchase order is set to be delivered.
      SUBTOTAL decimal Subtotal of the purchase order before any tax. 
      TOTAL

      decimal

      		 Total value of the subtotal and the tax total of the purchase order.
      AMOUNT_BILLED decimal Total value of purchase order that has been billed.
      AMOUNT_PAID decimal Total value of the purchase order that has been paid.
      PAID_IN_FULL boolean Signifies if the purchase order has been paid. Returns true if the purchase order has been paid in full, false if the purchase order has not been paid in full.
      VENDOR_ID integer Unique identifier for the subcontractor/vendor that is assigned to the purchase order.
      LMOD string Date and time the purchase order was last modified.
      LMOD_BY integer Unique identifier for the user that last modified the purchase order.
      APPROVAL_STATUS integer Designates the approval status of the purchase order. A value of 0 is the status is declined, 1 is pending, and 2 is approved.
      VERIFIER integer Unique identifier for the user that verified the purchase order as approved.
      VERIFICATION_DATE string Date and time the purchase order was verified.
      INT_NOTES string Internal notes entered for the purchase order. Returns as an encoded string.
      SCOPE_OF_WORK string Scope of work entered for the purchase order. Returns as an encoded string.
      TRADE

      integer

      		 Unique identifier for the trade that is assigned to the purchase order.
      PO_TYPE integer Unique identifier for the purchase order type that is assigned to the purchase order.
      TRAFFIC_COLOR integer Represents the traffic light color assigned to the purchase order. The number 1 corresponds to the color green, 2 corresponds to the color yellow, 3 corresponds to the color red, and 0 means no color has been assigned to the purchase order.
      ACCT_INT_ID integer Unique identifier for the QuickBooks account that purchase order is integrated with.
      ACCT_INT_VENDOR_ID integer Unique identifier for the QuickBooks vendor that the purchase order is integrated with.
      SENT_TO_ACCT_INT_VALUE decimal Total value of the purchase order that was sent to QuickBooks.
      Example response:
      {   "ID": 2392,
          "TITLE": "PO# 1432504-000",
          "PO_NUMBER": "1432504-000",
          "COMPANY_ID": 23573,
          "PRJ_ID": 1432504,
          "ESTIMATE_ID": 504358,
          "FROM_SCRATCH": false,
          "ACTIVE": true,
          "DATE_CREATED": "2024-09-13T14:34:50.423",
          "CREATED_BY": 885048,
          "DUE_DATE": "2024-09-15T00:00:00",
          "START_DATE": "2024-10-02T00:00:00",
          "COMPLETION_DATE": "2024-10-05T00:00:00",
          "DELIVERY_DATE": "2024-09-30T00:00:00",
          "SUBTOTAL": 92320.0,
          "TOTAL": 92320.0,
          "AMOUNT_BILLED": 0.0,
          "AMOUNT_PAID": 0.0,
          "PAID_IN_FULL": false,
          "VENDOR_ID": 1551562,
          "LMOD": "2024-10-09T17:34:25.033",
          "LMOD_BY": 885048,
          "APPROVAL_STATUS": 1,
          "APPROVER": 0,
          "APPROVAL_DATE": null,
          "VERIFICATION_STATUS": 0,
          "VERIFIER": 0,
          "VERIFICATION_DATE": null,
          "INT_NOTES": "%3Cp%3E%3Cbr%3E%3C%2Fp%3E",
          "SCOPE_OF_WORK": "%3Ch3%3E%3Cstrong%3EScope of Work for HVAC Purchase Order%3C%2Fstrong%3E%3C%2Fh3%3E%0A%3Cp%3E%3Cstrong%3E1. Project Overview%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cp%3EThis document outlines the work needed to supply and install heating and air conditioning systems for the residential property located at 123 Maple Street.%3C%2Fp%3E%0A%3Cp%3E%3C%2Fp%3E%0A%3Cp%3E%3Cstrong%3E2. Objectives%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cul%3E%3Cli%3ESupply and install HVAC equipment.%3C%2Fli%3E%3Cli%3EEnsure the system operates correctly and meets all required standards.%3C%2Fli%3E%3C%2Ful%3E%0A%3Cp%3E%3Cstrong%3E3. Deliverables%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cul%3E%3Cli%3E%3Cstrong%3EEquipment Supply%3A%3C%2Fstrong%3E%3Cul%3E%3Cli%3EHeating unit%3A Gas furnace%2C 80%2C000 BTU%3C%2Fli%3E%3Cli%3ECooling unit%3A Central air conditioner%2C 5-ton capacity%3C%2Fli%3E%3Cli%3EThermostats%3A Programmable%2C Wi-Fi enabled%3C%2Fli%3E%3C%2Ful%3E%3C%2Fli%3E%3Cli%3E%3Cstrong%3EInstallation Services%3A%3C%2Fstrong%3E%3Cul%3E%3Cli%3ERemove existing HVAC equipment.%3C%2Fli%3E%3Cli%3EInstall new heating and cooling units.%3C%2Fli%3E%3Cli%3ETest the system to ensure proper operation and efficiency.%3C%2Fli%3E%3C%2Ful%3E%3C%2Fli%3E%3C%2Ful%3E%0A%3Cp%3E%3Cstrong%3E4. Schedule%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cul%3E%3Cli%3E%3Cstrong%3EOrder Date%3A%3C%2Fstrong%3E%26nbsp%3BSeptember 15%2C 2024%3C%2Fli%3E%3Cli%3E%3Cstrong%3EDelivery Date%3A%3C%2Fstrong%3E%26nbsp%3BSeptember 30%2C 2024%3C%2Fli%3E%3Cli%3E%3Cstrong%3EInstallation Start%3A%3C%2Fstrong%3E%26nbsp%3BOctober 2%2C 2024%3C%2Fli%3E%3Cli%3E%3Cstrong%3ECompletion Date%3A%3C%2Fstrong%3E%26nbsp%3BOctober 5%2C 2024%3C%2Fli%3E%3C%2Ful%3E%0A%3Cp%3E%3Cstrong%3E5. Responsibilities%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cul%3E%3Cli%3E%3Cstrong%3EContractor%3A%3C%2Fstrong%3E%26nbsp%3BProvide and install the HVAC equipment%2C ensure proper functionality%2C and comply with all relevant standards.%3C%2Fli%3E%3Cli%3E%3Cstrong%3EClient%3A%3C%2Fstrong%3E%26nbsp%3BProvide access to the property and make payments as outlined.%3C%2Fli%3E%3C%2Ful%3E%0A%3Cp%3E%3Cstrong%3E6. Contact Information%3C%2Fstrong%3E%3C%2Fp%3E%0A%3Cul%3E%3Cli%3E%3Cstrong%3EContractor%3A%3C%2Fstrong%3E%26nbsp%3BBrian Sanderson%2C United Heating and Air%3Cul%3E%3Cli%3EPhone%3A (555) 642-2003%3C%2Fli%3E%3Cli%3EEmail%3A%26nbsp%3Bbsanderson%40udatraining.com%3C%2Fli%3E%3C%2Ful%3E%3C%2Fli%3E%3Cli%3E%3Cstrong%3EClient%3A%3C%2Fstrong%3E%26nbsp%3BCole Whaley%3Cul%3E%3Cli%3EPhone%3A (555) 366-1122%3C%2Fli%3E%3Cli%3EEmail%3A cwhaley%40udatraining.com%3C%2Fli%3E%3C%2Ful%3E%3C%2Fli%3E%3C%2Ful%3E",
          "TRADE": 75300,
          "PO_TYPE": 105756,
          "TRAFFIC_COLOR": 0,
          "ACCT_INT_ID": 0,
          "ACCT_INT_VENDOR_ID": 0,
          "SENT_TO_ACCT_INT_VALUE": 0.0,
          "ITEMS": [
              {
                  "ID": 45342,
                  "PRJ_ID": 1432504,
                  "PO_ID": 2392,
                  "RELATED_ITEM_ID": 91401849,
                  "ORG_RELATED_ITEM_ID": 91401849,
                  "RELATED_ITEM_TYPE": 0,
                  "IS_ADDITIONAL_ITEM": false,
                  "COST_CODE_ID": 0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "NAME": "HVAC Subcontract",
                  "DESCRIPTION": "",
                  "QTY": 1.0,
                  "UNIT": 90055,
                  "RATE": 92320.0,
                  "SUBTOTAL": 92320.0,
                  "TOTAL": 92320.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0,
                  "ACCT_INT_LINE_ID": null
              }
          ]
      }

      api/Bills

      The following properties will return when an api/Bills endpoint is called:

      Name Type Description
      ID integer Unique identifier for the bill.
      TITLE string Name of the bill as it appears in ConstructionOnline.
      BILL_NUMBER string Reference number for the bill as it appears in ConstructionOnline.
      COMPANY_ID integer Unique identifier for the ConstructionOnline company.
      PRJ_ID integer Unique identifier for the project that contains the bill.
      ESTIMATE_ID integer Unique identifier for the associated estimate.
      CHANGE_ORDER_ID integer Unique identifier for the associated change order. Returns a 0 if no change order is associated.

      DUE_DATE

      		 string Date and time the bill is set to be due.
      INVOICE_DATE string Date and time the bill is set to be invoiced.
      RECEIVED_DATE string Date and time the bill was received.
      PAID_DATE string Date and time the bill was paid.
      ACTIVE boolean Signifies the state of the bill. Returns true if the bill is currently set to active, false if the bill is currently set to a draft.
      PAID boolean Signifies if the bill has been paid. Returns true if the bill has been paid in full, false if the bill has not been paid in full.
      READY_FOR_PAYMENT boolean Signifies if the bill is ready to be paid. Returns true if the bill is ready to be paid, false if the bill is not ready to be paid.
      APPROVER integer Unique identifier for the user that approved the bill.
      APPROVAL_DATE string Date and time the bill was approved.
      DATE_CREATED string Date and time the bill was created. 
      CREATED_BY integer

      Unique identifier for the user who created the bill.
      SUBTOTAL decimal Subtotal of the bill before any tax. 
      TOTAL

      decimal

      		 Total value of the subtotal and the tax total of the bill.
      AMOUNT_PAID decimal Total value of the bill that has been paid.
      VENDOR_ID integer Unique identifier for the subcontractor/vendor that is assigned to the bill.
      LMOD string Date and time the bill was last modified.
      LMOD_BY integer Unique identifier for the user that last modified the bill.
      NOTES string Notes entered for the bill. Returns as an encoded string.
      TRADE

      integer

      		 Unique identifier for the trade that is assigned to the bill.
      BILL_TYPE integer Unique identifier for the bill type that is assigned to the bill.
      TRAFFIC_COLOR integer Represents the traffic light color assigned to the bill. The number 1 corresponds to the color green, 2 corresponds to the color yellow, 3 corresponds to the color red, and 0 means no color has been assigned to the bill.
      ACCT_INT_ID integer Unique identifier for the QuickBooks account that bill is integrated with.
      ACCT_INT_VENDOR_ID integer Unique identifier for the QuickBooks vendor that the bill is integrated with.
      SENT_TO_ACCT_INT_VALUE decimal

      Total value of the bill that was sent to QuickBooks.

      Example response:

      {       "ID": 21,
              "TITLE": "Bill# 1432504-000",
              "BILL_NUMBER": "1432504-000",
              "COMPANY_ID": 23573,
              "PRJ_ID": 1432504,
              "ESTIMATE_ID": 504358,
              "CHANGE_ORDER_ID": 0,
              "DUE_DATE": "2024-09-30T00:00:00",
              "INVOICE_DATE": "2024-09-15T00:00:00",
              "RECEIVED_DATE": "2024-09-15T00:00:00",
              "PAID_DATE": null,
              "ACTIVE": true,
              "PAID": false,
              "READY_FOR_PAYMENT": false,
              "APPROVER": 0,
              "APPROVAL_DATE": null,
              "DATE_CREATED": "2024-09-13T14:35:28.273",
              "CREATED_BY": 885048,
              "SUBTOTAL": 92320.0,
              "TOTAL": 92320.0,
              "AMOUNT_PAID": 0.0,
              "VENDOR_ID": 1551562,
              "LMOD": "2024-09-13T19:35:28.273",
              "LMOD_BY": 885048,
              "NOTES": "",
              "TRADE": 75300,
              "BILL_TYPE": 105762,
              "TRAFFIC_COLOR": 0,
              "ACCT_INT_ID": 0,
              "ACCT_INT_VENDOR_ID": 0,
              "SENT_TO_ACCT_INT_VALUE": 0.0,
              "ITEMS": [
                  {
                      "ID": 138,
                      "PRJ_ID": 1432504,
                      "BILL_ID": 21,
                      "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,
                      "COST_CODE_ID": 0,
                      "TAX_TYPE_ID": 0,
                      "TAX_PERCENT": 0.0,
                      "NAME": "HVAC Subcontract",
                      "DESCRIPTION": "",
                      "QTY": 1.0,
                      "UNIT": 90055,
                      "RATE": 92320.0,
                      "SUBTOTAL": 92320.0,
                      "TOTAL": 92320.0,
                      "TOTAL_COST": 92320.0,
                      "SUBTOTAL_COST": 92320.0,
                      "AMOUNT_PAID": 0.0,
                      "AMOUNT_PAID_NO_TAX": 0.0,
                      "ADDED_FROM_PO": false
                  }
              ]
          }

      api/Expenses

      The following properties will return when an api/Expenses endpoint is called:

      Name Type Description
      ID integer Unique identifier for the expense.
      TITLE string Name of the expense as it appears in ConstructionOnline.
      COMPANY_ID integer Unique identifier for the ConstructionOnline company.
      PRJ_ID integer Unique identifier for the project that contains the expense.

      DATE_CREATED

      		 string Date and time the expense was created.
      CREATED_BY integer

      Unique identifier for the user who created the expense.
      SUBTOTAL decimal Subtotal of the expense before any tax. 
      TAX_PERCENT decimal Tax percentage applied to the expense.
      TOTAL

      decimal

      		 Total value of the subtotal and the tax total of the expense.
      AMOUNT_BILLED

      decimal

      		 Total value of expense that has been billed.
      AMOUNT_PAID decimal Total value of the expense that has been paid.
      PAID boolean Signifies if the expense has been paid. Returns true if the expense has been paid in full, false if the expense has not been paid in full.
      VENDOR_ID integer Unique identifier for the subcontractor/vendor that is assigned to the expense.
      LMOD string Date and time the expense was last modified.
      LMOD_BY integer Unique identifier for the user that last modified the expense.
      NOTES string Notes entered for the expense. Returns as an encoded string.
      TRADE

      integer

      		 Unique identifier for the trade that is assigned to the expense.
      RECEIPT_STATUS integer Unique identifier for the status that is assigned to the expense.
      IS_EXPENSE boolean Signifies if the object is an expense or receipt. Returns true if the object is an expense, returns false if the object is a receipt.
      TRAFFIC_COLOR integer Represents the traffic light color assigned to the expense. The number 1 corresponds to the color green, 2 corresponds to the color yellow, 3 corresponds to the color red, and 0 means no color has been assigned to the expense.

      Example response:

      {   "ID": 27,
          "TITLE": "Site Supervisor Labor - September",
          "COMPANY_ID": 23573,
          "PRJ_ID": 1432504,
          "DATE_CREATED": "2024-09-23T08:16:42.517",
          "CREATED_BY": 885048,
          "SUBTOTAL": 15962.0,
          "TAX_PERCENT": 0.0,
          "TAX_TYPE": 0,
          "TOTAL": 15962.0,
          "AMOUNT_BILLED": 0.0,
          "AMOUNT_PAID": 0.0,
          "PAID": false,
          "VENDOR_ID": 1055308,
          "LMOD": "2024-09-23T13:16:42.517",
          "LMOD_BY": 885048,
          "NOTES": "",
          "TRADE": 0,
          "RECEIPT_STATUS": 105770,
          "IS_EXPENSE": true,
          "TRAFFIC_COLOR": 0,
          "ITEMS": [
              {
                  "ID": 52,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Hourly Wage",
                  "QTY": 160.0,
                  "UNIT": 266,
                  "RATE": 45.0,
                  "SUBTOTAL": 7200.0,
                  "TOTAL": 7200.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 53,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Overtime Pay",
                  "QTY": 20.0,
                  "UNIT": 266,
                  "RATE": 67.5,
                  "SUBTOTAL": 1350.0,
                  "TOTAL": 1350.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 54,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Per Diem",
                  "QTY": 20.0,
                  "UNIT": 266,
                  "RATE": 50.0,
                  "SUBTOTAL": 1000.0,
                  "TOTAL": 1000.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 55,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Travel Expenses",
                  "QTY": 200.0,
                  "UNIT": 266,
                  "RATE": 0.56,
                  "SUBTOTAL": 112.0,
                  "TOTAL": 112.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 56,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Accommodation Costs",
                  "QTY": 20.0,
                  "UNIT": 266,
                  "RATE": 120.0,
                  "SUBTOTAL": 2400.0,
                  "TOTAL": 2400.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 57,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Administrative Costs",
                  "QTY": 20.0,
                  "UNIT": 266,
                  "RATE": 45.0,
                  "SUBTOTAL": 900.0,
                  "TOTAL": 900.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 58,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Insurance",
                  "QTY": 1.0,
                  "UNIT": 266,
                  "RATE": 1000.0,
                  "SUBTOTAL": 1000.0,
                  "TOTAL": 1000.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              },
              {
                  "ID": 59,
                  "PRJ_ID": 1432504,
                  "RECEIPT_ID": 27,
                  "NAME": "Equipment / Tools",
                  "QTY": 20.0,
                  "UNIT": 266,
                  "RATE": 100.0,
                  "SUBTOTAL": 2000.0,
                  "TOTAL": 2000.0,
                  "TAX_TYPE_ID": 0,
                  "TAX_PERCENT": 0.0,
                  "AMOUNT_BILLED": 0.0,
                  "AMOUNT_BILLED_NO_TAX": 0.0,
                  "AMOUNT_PAID": 0.0,
                  "AMOUNT_PAID_NO_TAX": 0.0
              }
          ]
      }

      api/Receipts

      The following properties will return when an api/Receipts endpoint is called:

      Name Type Description
      ID integer Unique identifier for the receipt.
      TITLE string Name of the receipt as it appears in ConstructionOnline.
      COMPANY_ID integer Unique identifier for the ConstructionOnline company.
      PRJ_ID integer Unique identifier for the project that contains the receipt.

      DATE_CREATED

      		 string Date and time the receipt was created.
      CREATED_BY integer

      Unique identifier for the user who created the receipt.
      SUBTOTAL decimal Subtotal of the receipt before any tax. 
      TAX_PERCENT decimal Tax percentage applied to the receipt.
      TOTAL

      decimal

      		 Total value of the subtotal and the tax total of the receipt.
      AMOUNT_BILLED

      decimal

      		 Total value of receipt that has been billed.
      AMOUNT_PAID decimal Total value of the receipt that has been paid.
      PAID boolean Signifies if the receipt has been paid. Returns true if the receipt has been paid in full, false if the receipt has not been paid in full.
      VENDOR_ID integer Unique identifier for the subcontractor/vendor that is assigned to the receipt.
      LMOD string Date and time the receipt was last modified.
      LMOD_BY integer Unique identifier for the user that last modified the receipt.
      NOTES string Notes entered for the receipt. Returns as an encoded string.
      TRADE

      integer

      		 Unique identifier for the trade that is assigned to the receipt.
      RECEIPT_STATUS integer Unique identifier for the status that is assigned to the receipt.
      IS_EXPENSE boolean Signifies if the object is an expense or receipt. Returns true if the object is an expense, returns false if the object is a receipt.
      TRAFFIC_COLOR integer Represents the traffic light color assigned to the receipt. The number 1 corresponds to the color green, 2 corresponds to the color yellow, 3 corresponds to the color red, and 0 means no color has been assigned to the receipt.

      Example response:

      {   "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
              }
          ]
      }

      api/POPayments

      The following properties will return when an api/POPayments endpoint is called:

      Name Type Description
      ID integer Unique identifier for the payment.
      TITLE string Name of the payment as it appears in ConstructionOnline.
      NUMBER string Reference number for the payment as it appears in ConstructionOnline.
      COMPANY_ID integer Unique identifier for the ConstructionOnline company.
      PRJ_ID integer Unique identifier for the project that contains the payment.
      ESTIMATE_ID integer Unique identifier for the associated estimate.
      VENDOR_ID integer Unique identifier for the subcontractor/vendor that is assigned to the payment.
      PAID_DATE string Date and time the payment was paid.
      DATE_CREATED string Date and time the payment was created. 
      CREATED_BY integer

      Unique identifier for the user who created the payment.
      SUBTOTAL decimal Subtotal of the payment before any tax. 
      TOTAL

      decimal

      		 Total value of the subtotal and the tax total of the payment.
      LMOD string Date and time the payment was last modified.
      LMOD_BY integer Unique identifier for the user that last modified the payment.
      NOTES string Notes entered for the payment. Returns as an encoded string.
      PAYMENT_METHOD

      integer

      		 Unique identifier for the payment method that is assigned to the payment.
      TRAFFIC_COLOR integer Represents the traffic light color assigned to the payment. The number 1 corresponds to the color green, 2 corresponds to the color yellow, 3 corresponds to the color red, and 0 means no color has been assigned to the payment.
      ACCT_INT_ID integer Unique identifier for the QuickBooks account that payment is integrated with.
      ACCT_INT_VENDOR_ID integer Unique identifier for the QuickBooks vendor that the payment is integrated with.
      SENT_TO_ACCT_INT_VALUE decimal

      Total value of the payment that was sent to QuickBooks.

      Example response:

      {   "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
              }
          ]
      }

      Items

      The following properties will return for the ITEMS when any of the purchasing endpoints are called:

      Name Type Description
      ID integer Unique identifier for the item. Included on purchase order, bill, expense, receipt, and payment items.
      PO_ID integer Unique identifier for the associated purchase order. Included on purchase order and payment items.
      PRJ_ID integer Unique reference number for the project. Included on bill, expense, and receipt items.
      BILL_ID integer Unique identifier for the associated bill. Included on bill and payment items.
      RECEIPT_ID integer Unique identifier for the associated expense or receipt. Included on expense, receipt, and payment items.
      PAYMENT_ID integer Unique identifier for the associated payment. Include on payment items only.
      RELATED_ITEM_ID integer Unique identifier for the associated estimate item. Included on purchase order, bill, and payment items.
      ORG_ITEM_ID integer Unique identifier for the originally associated estimate item. Included on purchase order, bill, and payment items.
      RELATED_ITEM_TYPE integer Unique identifier for the item type of the associated estimate item. Included on purchase order, bill, and payment items.
      IS_ADDITIONAL_ITEM boolean Signifies if the item was created as an additional item. Returns true if the item was an additional item, false if it was not an additional item. Included on purchase order, bill, and payment items.
      PO_ITEM_ID integer Reference to the ID number of the associated purchase order item. Returns a 0 if no purchase order item is associated. Included on bill and payment items.
      BILL_ITEM_ID integer Reference to the ID number of the associated bill item. Returns a 0 if no bill item is associated. Included on payment items only.
      RECEIPT_ITEM_ID integer Reference to the ID number of the associated expense or receipt item. Returns a 0 if no expense or receipt item is associated. Included on bill and payment items.
      COST_CODE_ID integer Unique identifier for the cost code of the associated estimate item. Returns a 0 if no cost code is associated. Included on purchase order and bill items.
      TAX_TYPE_ID

      integer

      		 Unique identifier for the tax type associated to the item. Returns a 0 if no tax type is associated. Included on purchase order, bill, expense, receipt, and payment items.
      TAX_PERCENT decimal Tax percentage applied to the item. Included on purchase order, bill, expense, receipt, and payment items.
      NAME string Name of the item as it appears in ConstructionOnline. Included on purchase order, bill, expense, receipt, and payment items.
      DESCRIPTION string Description entered for the item. Returns as an encoded string. Included on purchase order, bill, and payment items.
      QTY

      decimal

      		 Quantity entered for the item. Included on purchase order, bill, expense, and receipt items.
      UNIT integer Unique identifier for the unit type associated to the item. Included on purchase order, bill, expense, and receipt items.
      UNIT_NAME string Name of the unit associated to the item. Included on purchase order items only.
      RATE decimal Unit cost of the item. Included on purchase order, bill, expense, and receipt items.
      SUBTOTAL decimal Total cost of the item before tax is applied. Included on purchase order, bill, expense, receipt, and payment items.
      TOTAL decimal Total cost of the item. Included on purchase order, bill, expense, receipt, and payment items.
      SUBTOTAL_COST decimal Total cost of the item before tax is applied. Included on bill and payment items.
      TOTAL_COST decimal Total cost of the item. Included on bill and payment items.
      AMOUNT_BILLED decimal Total amount of the item that is included in a bill. Included on purchase order, expense, and receipt items.
      AMOUNT_BILL_NO_TAX decimal Total amount of the item without tax that is included in a bill. Included on purchase order, expense, and receipt items.
      AMOUNT_PAID decimal Total amount of the item that is included in a payment. Included on purchase order, bill, expense, and receipt items.
      AMOUNT_PAID_NO_TAX decimal Total amount of the item without tax that is included in a payment. Included on purchase order, bill, expense, and receipt items.
      PAID_TO_DATE decimal Total of the item that has been paid to date. Included on payment items only.
      PAID_TO_DATE_NO_TAX decimal Total of the item without tax that has been paid to date. Included on payment items only.
      REMAINING decimal Remainder of the item that has not been paid. Included on payment items only.
      REMAINING_NO_TAX decimal Remainder of the item without tax that has not been paid. Included on payment items only.
      ADDED_FROM_PO boolean Signifies if the item was created from a purchase order. Returns true if the item was created from a purchase order, false if it was not created from a purchase order. Included  bill items only.

       

      Last updated: Oct 10, 2024