Project estimates

A project estimate enables you to approximate how much a project might cost to complete. You can compare the actual costs against your estimate to determine if the project is progressing as expected.

Please be aware that this object is currently "Uncertified", signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List project estimates

get/objects/construction/project-estimate

Returns up to 100 object references from the collection with a key, ID, and link for each object. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and specify the properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "2",
      • "id": "PJE-01-001",
      • "href": "/objects/construction/project-estimate/2"
      },
    • {
      • "key": "1",
      • "id": "PJE-00-01",
      • "href": "/objects/construction/project-estimate/1"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a project estimate
post/objects/construction/project-estimate
Creates a new project estimate.


SecurityOAuth2 
Request 
Request Body schema: application/json
Project estimate to create


id
required
string
Unique identifier of the project estimate.
You must specify a unique ID when creating a project estimate unless document sequencing is configured, in which case the ID is auto-generated.


 
 Example:  "BTI-Estimate-01"
required
object
Reference to the project that this estimate is for.


 
key
string
System-assigned key of the project.


 
 Example:  "27"
id
string
Unique identifier for the project.


 
 Example:  "BPN-PRJ-01"
description
string
Description of the project estimate.


 
 Example:  "Estimation for BTI"
postTo
string
 Default:  "firstPeriod"
Posting period for the project estimate. 


    

  • firstPeriod - Post the amounts to the period in which the project begin date falls. 
    • 

  • estimateDate - Post estimate entries to the period that corresponds with the project estimateDate. You can change this date, but you can't enter a date before the project begin date.
    • 

  • effectiveDate - Post each estimate line entry to the effective date for that line. Each line might post to different periods due to different effective dates. If you choose this option, enter an effective date for each entry line. Multiple estimate line entries for the same GL account, dimension, and budget period are summarized and posted as a single line to the same budget period.
    • 

  • allPeriods - Spread the amounts equally across periods between the project begin and end date.
    • 



 Enum: "allPeriods" "effectiveDate" "estimateDate" "firstPeriod"  
 Example:  "firstPeriod"
status
string
 Default:  "active"
The project estimate status.


    

  • active - For current estimates.
    • 

  • inactive - For historical estimates, such as an original customer bid.
    • 

  • finalized - Lock the estimate from further changes. You can change a finalized estimate to active status at any time.
    • 



 Enum: "active" "finalized" "inactive"  
 Example:  "active"
isPrimary
boolean
 Default:  false
Specifies whether the estimate is primary for the project. During create, the first estimate for a project is set to primary. This value can be changed in an update.


 
 Example:  false
isPosted
boolean
 Default:  false
Specifies whether the estimate is posted to GL budgets. In an update, if this is set to false, then any existing GL budgets for that project estimate will be deleted.


 
 Example:  false
estimateDate
string <date> 
Date of the project estimate, which must be in a budgetable period.


 
 Example:  "2022-06-23"
object
Reference to the budget that the estimate will be posted to. The budget must have postProjectEstimates set to true.


 
key
string
System-assigned unique key for the budget.


 
 Example:  "10"
id
string
Budget identifier.


 
 Example:  "Root PJ Estimates"
object
Reference to the project estimate type.


 
key
string
System-assigned key of the project estimate type.


 
 Example:  "15"
id
string
Unique identifier of the project estimate type.


 
 Example:  "Original"
Array of objects
Array of project estimate lines.


 
 Array 
amount
string^(-?(\d+\.?\d*|\d*\.?\d+))?$
Amount for the project estimate line.


 
 Example:  "2000.00"
quantity
string
Quantity for the project estimate line.


 
 Example:  "10"
unitCost
string <decimal-precision-2> 
Unit rate for the project estimate line.


 
 Example:  "1000.00"
memo
string
Memo for the project estimate line. Use 2000 or fewer characters.


 
 Example:  "service charges"
externalUOM
string
External unit of measure.


 
 Example:  "Piece"
workflowType
string
 Default:  "original"
Workflow type for the project estimate line.


 Enum: "approvedChange" "forecast" "original" "other" "pendingChange" "revision"  
 Example:  "original"
isPosted
boolean
 Default:  false
Set to true to post this line to the budget specified in the project estimate. Set to false to unpost and deletes any existing GL budget lines for this estimate line.


 
 Example:  false
effectiveDate
string <date> 
Date that the transaction line comes into effect from a GL budget or reporting perspective.


 
 Example:  "2023-06-23"
numberOfProductionUnits
integer
Number of production units, which are units that track several inputs of cost (such as for material, labor, equipment).


 
 Example:  200
object
 
object
Dimensions active on this project estimate line.


 
object
Supporting document for this vendor.


 
key
string or null
 
 Example:  "21"
id
string or null
 
 Example:  "Sales01"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "PE-CB-BTI-003",
  • "description": "PE-CB-BTI-003",
  • "estimateDate": "2024-03-14",
  • "isPrimary": false,
  • "status": "active",
  • "postTo": "firstPeriod",
  • "budget": {
    • "key": "2"
    },
  • "projectEstimateType": {
    • "key": "7"
    },
  • "project": {
    • "key": "1"
    },
  • "projectEstimateLines": [
    • {
      • "externalUOM": "Hour",
      • "quantity": "10.00",
      • "unitCost": "300.00",
      • "amount": "3000.00",
      • "numberOfProductionUnits": 0,
      • "workflowType": "original",
      • "glAccount": {
        },
      • "dimensions": {
        }
      },
    • {
      • "externalUOM": "Box",
      • "quantity": "10.00",
      • "unitCost": "300.00",
      • "amount": "3000.00",
      • "numberOfProductionUnits": 0,
      • "workflowType": "original",
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "27",
    • "id": "PE-CB-BTI-003",
    • "href": "/objects/construction/project-estimate/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a project estimate
get/objects/construction/project-estimate/{key}
Returns detailed information for a specified project estimate.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the project estimate.


 
 Example:  27
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "27",
    • "id": "PE-CB-BTI-003",
    • "description": "PE-CB-BTI-003",
    • "estimateDate": "2024-03-14",
    • "isPrimary": false,
    • "status": "active",
    • "isPosted": false,
    • "budget": {
      • "key": "2",
      • "id": "Root PJ Estimates",
      • "href": "/objects/general-ledger/budget/2"
      },
    • "postTo": "firstPeriod",
    • "project": {
      • "key": "1",
      • "id": "DIM - BTI",
      • "name": "Dimensions - Berkeley Technology Inc",
      • "beginDate": "2000-01-01",
      • "endDate": "2023-12-31",
      • "href": "/objects/projects/project/1"
      },
    • "projectEstimateType": {
      • "key": "7",
      • "id": "Original",
      • "workflowTypes": [
        ],
      • "href": "/objects/construction/project-estimate-type/7"
      },
    • "currency": "USD",
    • "totalEstimateAmount": "6000.00",
    • "location": {
      • "key": "1",
      • "id": "USA",
      • "name": "United States of America"
      },
    • "parentProject": {
      • "key": "2",
      • "id": "DIM",
      • "name": "Dimensions"
      },
    • "customer": {
      • "key": "14",
      • "id": "BTI",
      • "name": "Berkeley Technology Inc",
      • "href": "/objects/accounts-receivable/customer/14"
      },
    • "attachment": {
      • "id": "Doc001"
      },
    • "audit": {
      • "modifiedDateTime": "2023-03-14T06:25:35Z",
      • "createdDateTime": "2023-03-14T06:25:35Z",
      • "modifiedBy": "1",
      • "createdBy": "1"
      },
    • "projectEstimateLines": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/construction/project-estimate/27"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a project estimate
patch/objects/construction/project-estimate/{key}
Updates an existing project estimate by setting field values. Any fields not provided remain unchanged. 
If the budget reference is change when isPosted is true, the estimate is unposted from the first budget and posted to the new budget.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the project estimate.


 
 Example:  27
Request Body schema: application/json
description
string
Description of the project estimate.


 
 Example:  "Estimation for BTI"
postTo
string
 Default:  "firstPeriod"
Posting period for the project estimate. 


    

  • firstPeriod - Post the amounts to the period in which the project begin date falls. 
    • 

  • estimateDate - Post estimate entries to the period that corresponds with the project estimateDate. You can change this date, but you can't enter a date before the project begin date.
    • 

  • effectiveDate - Post each estimate line entry to the effective date for that line. Each line might post to different periods due to different effective dates. If you choose this option, enter an effective date for each entry line. Multiple estimate line entries for the same GL account, dimension, and budget period are summarized and posted as a single line to the same budget period.
    • 

  • allPeriods - Spread the amounts equally across periods between the project begin and end date.
    • 



 Enum: "allPeriods" "effectiveDate" "estimateDate" "firstPeriod"  
 Example:  "firstPeriod"
status
string
 Default:  "active"
The project estimate status.


    

  • active - For current estimates.
    • 

  • inactive - For historical estimates, such as an original customer bid.
    • 

  • finalized - Lock the estimate from further changes. You can change a finalized estimate to active status at any time.
    • 



 Enum: "active" "finalized" "inactive"  
 Example:  "active"
isPrimary
boolean
 Default:  false
Specifies whether the estimate is primary for the project. During create, the first estimate for a project is set to primary. This value can be changed in an update.


 
 Example:  false
isPosted
boolean
 Default:  false
Specifies whether the estimate is posted to GL budgets. In an update, if this is set to false, then any existing GL budgets for that project estimate will be deleted.


 
 Example:  false
estimateDate
string <date> 
Date of the project estimate, which must be in a budgetable period.


 
 Example:  "2022-06-23"
object
Reference to the budget that the estimate will be posted to. The budget must have postProjectEstimates set to true.


 
key
string
System-assigned unique key for the budget.


 
 Example:  "10"
id
string
Budget identifier.


 
 Example:  "Root PJ Estimates"
object
Reference to the project that this estimate is for.


 
key
string
System-assigned key of the project.


 
 Example:  "27"
id
string
Unique identifier for the project.


 
 Example:  "BPN-PRJ-01"
object
Reference to the project estimate type.


 
key
string
System-assigned key of the project estimate type.


 
 Example:  "15"
id
string
Unique identifier of the project estimate type.


 
 Example:  "Original"
Array of objects
Array of project estimate lines.


 
 Array 
amount
string^(-?(\d+\.?\d*|\d*\.?\d+))?$
Amount for the project estimate line.


 
 Example:  "2000.00"
quantity
string
Quantity for the project estimate line.


 
 Example:  "10"
unitCost
string <decimal-precision-2> 
Unit rate for the project estimate line.


 
 Example:  "1000.00"
memo
string
Memo for the project estimate line. Use 2000 or fewer characters.


 
 Example:  "service charges"
externalUOM
string
External unit of measure.


 
 Example:  "Piece"
workflowType
string
 Default:  "original"
Workflow type for the project estimate line.


 Enum: "approvedChange" "forecast" "original" "other" "pendingChange" "revision"  
 Example:  "original"
isPosted
boolean
 Default:  false
Set to true to post this line to the budget specified in the project estimate. Set to false to unpost and deletes any existing GL budget lines for this estimate line.


 
 Example:  false
effectiveDate
string <date> 
Date that the transaction line comes into effect from a GL budget or reporting perspective.


 
 Example:  "2023-06-23"
numberOfProductionUnits
integer
Number of production units, which are units that track several inputs of cost (such as for material, labor, equipment).


 
 Example:  200
object
 
object
Dimensions active on this project estimate line.


 
object
Supporting document for this vendor.


 
key
string or null
 
 Example:  "21"
id
string or null
 
 Example:  "Sales01"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "Project estimate for BUD BTI- update4",
  • "estimateDate": "2022-06-24",
  • "projectEstimateLines": [
    • {
      • "key": "70",
      • "externalUOM": "Seconds",
      • "quantity": "10.00",
      • "unitCost": "500.00",
      • "amount": "5000.00",
      • "numberOfProductionUnits": 0,
      • "workflowType": "original",
      • "glAccount": {
        },
      • "dimensions": {
        }
      },
    • {
      • "externalUOM": "Seconds",
      • "quantity": "10.00",
      • "unitCost": "600.00",
      • "amount": "6000.00",
      • "numberOfProductionUnits": 0,
      • "workflowType": "original",
      • "glAccount": {
        },
      • "dimensions": {
        }
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "23",
    • "id": "PE-GL-T001",
    • "href": "/objects/construction/project-estimate/23"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a project estimate
delete/objects/construction/project-estimate/{key}
Deletes a project estimate. A primary project estimate cannot be deleted.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the project estimate.


 
 Example:  27
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}
Query project estimates
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "construction/project-estimate"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "accounts-payable/vendor",
  • "fields": [
    • "id",
    • "name",
    • "status",
    • "href"
    ],
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$eq": {
        }
      }
    ],
  • "filterExpression": "1 and 2",
  • "orderBy": [
    • {
      • "id": "asc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "id": "Vend-00002",
      • "name": "Test vendor",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/85"
      },
    • {
      • "id": "VEND-00010",
      • "name": "Design Works",
      • "status": "active",
      • "href": "/objects/accounts-payable/vendor/111"
      }
    ],
  • "ia::meta": {
    • "totalCount": 2,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}