Change Order Variables
Use the variables in this section to prepare change order document templates. You can use the variables to create PCOs, OCOs, RFQs, CORs, and SCOs when you need to change your budget. To learn more about working with change orders, see the Change Orders article.
All available variables can be found in the table. You can use the search at the top of the table to narrow down the results.
Replace x in the table with one of the following:
- pco
- rfq
- rco
- oco
- sco
| Variables | Description | PCO | RFQ | COR | OCO | SCO |
| {x.number} | Returns the number of the change order. For example, to get the SCONo from the full string of the SCO Number, use {sco.number | slice':-3'} or {sco.number | split:'-' | last}. |  |
|
|
|
|
| {#oco.pco}{number}{/} | Returns the change order instance under one OCO. As there might be multiple PCOs or CORs under one OCO, you can create a loop to iterate them. | |
|
|
|
|
| {#x.regular}{yNo}{/x.regular} | Returns the number of an associated change order in the current change order document. For example, use {#rfq.regular}{pcoNo}{/#rfq.regular} to access the associated PCO number in the RFQ document. | |
|
|
|
|
| {x.name} | Returns the name of the change order | |
|
|
|
|
| {x.xDescription} | Returns the description of the change order. Usage: {x.costItems.xDescription}, {x.regular.xDescription}, {x.markups.xDescription}. Where x can be pco, rfq, oco, sco, or rco. For example, {pco.costItems.pcoDescription}. | |
|
|
|
|
| {x.type} | Returns the change order type | |
|
|
|
|
| {x.createdAt} | Returns the date that the change order was created on | |
|
|
|
|
| {@x.scopeOfWork} | Returns the scope of work for the change order. This variable must be on a line with no other text. | |
|
|
|
|
| {x.dueDate} | Returns the due date of the change order |  |
|
|
|
|
| {approvedAt} | Returns the date of approval of the change order. For example, {sco.approvedAt | date:'MM DD, YYYY'}. | |
|
|
|
|
| {approvedSubitems} | Returns the approved subitems of the change order | |
|
|
|
|
| {x.properties.['my custom property name']} | Returns the contents of the custom attribute value of "my custom property name" for the change order | |
|
|
|
|
| {x.properties['Source Ref']} | Returns the source reference of the change order | |
|
|
|
|
| {x.sourceType}, formely {x.properties['Source Type']} | Returns the type of the change order. Note: The variable {x.properties['Source Type']} is deprecated. While it is still functional, it is advisable to transition to using {x.sourceType} as the former will be phased out in future updates. |
|
|
|
|
|
| {x.properties['Response Due']} | Returns the due date of the response for a change order | |
|
|
|
|
| {x.properties['Awarded Date']} | Returns the date when the change order was awarded | |
|
|
|
|
| {x.properties['Returned Date']} | Returns the date when the change order was returned | |
|
|
|
|
| {x.properties['Executed Date']} | Returns the date when the change order was executed | |
|
|
|
|
| {x.properties['Off Site Date']} | Returns the date when the change order was set off site | |
|
|
|
|
| {x.properties['On Site Date']} | Returns the date then the change order was set on site | |
|
|
|
|
| {x.budgetStatus} | Returns the budget status of the change order | |
|
|
|
|
| {x.signedBy.name} | Returns the name from the signed by field | |
|
|
|
|
| {x.purchasedBy.name} | Returns the name from the purchased by field | |
|
|
|
|
| {inputQuantity} | Returns the input quantity | |
|
|
|
|
| {previousApprovedTotal} | Returns the total net cost of all approved OCOs | |
|
|
|
|
| {previousApprovedTaxTotalAmount} | Returns the total tax of all approved OCOs | |
|
|
|
|
| {previousApprovedGrandTotalAmount} | Returns the gross total of all approved OCOs including taxes | |
|
|
|
|
| {pendingTotal} | Returns the total of all pending OCOs including the generated OCO document | |
|
|
|
|
| {pendingTaxTotalAmount} | Returns the total tax of all pending OCOs including the generated OCO document | |
|
|
|
|
| {pendingGrandTotalAmount} | Returns the gross total of all pending OCOs including the tax and including the generated OCO document | |
|
|
|
|
| {x.scheduleChange === 0 ? "TBD" : x.scheduleChange} or {x.scheduleChange || "TBD"} |
Returns "TBD" (To Be Determined) when the value of the schedule change is zero | |
|
|
|
|
| {x.scheduleChange === 0 ? "ZERO" : x.scheduleChange} or {x.scheduleChange || "ZERO"} |
Returns "ZERO" when the value of the schedule change is zero | |
|
|
|
|
| {x.scheduleChange === null ? "TBD" : x.scheduleChange} | Returns "TBD" (To Be Determined) when the value of the schedule change is left empty | |
|
|
|
|
| {x.supplier} | Returns supplier's company | |
|
|
|
|
| {x.owner} | Returns owner's company | |
|
|
|
|
| {x.architect} | Returns architect's company | |
|
|
|
|
Tip:
- Change order document templates can also use main contract variables. Add one of the following to the specific main contract variable. For example, adding
sco.mainContract.startDatein the SCO document template will output the date the main contract started. - Change order document templates can also use cost item variables.
- Spreadsheet can't support rich text variable. Remove "@" from the variable while using it in spreadsheets. For example, instead of {@pco.scopeOfWork} use {pco.scopeOfWork}.
Related Articles
To learn more about using variables in different scenarios, see the Using Variables Example article.