Payment Application Variables
Include payment application variables in a report to populate values from the payment application in the system. For example, you can add the payment application's number, description, or the original contract value.
To learn more about:
- Using variables in different scenarios, see the Using Variables Example article
- Working with incoming and outgoing money flow, see the Payments article
Use the search at the top of the table to narrow down results.
| Variables | Description | Type |
| {payment.number} | Returns the payment application number. | String |
| {payment.name} | Returns the payment application name. | String |
| {payment.description} | Returns the payment application description. | String |
| {payment.supplier} | Returns the supplier's company. | String |
| {payment.owner} | Returns the owner's company. | String |
| {payment.architect} | Returns the architect's company. | String |
| {@payment.note} | Returns the payment application note. | RichText |
| {payment.startDate} | Returns the billing period start date of the payment application. | Date |
| {payment.endDate} | Returns the billing period end date of the payment application. | Date |
| {payment.createdAt} | Returns the date when the payment application was created. | Date |
| {payment.submittedAt} | Returns the date when the payment application was submitted. | Date |
| {payment.revisedAt} | Returns the date when the payment application was revised. | Date |
| {payment.updatedAt} | Returns the date when the payment application was updated. | Date |
| {payment.contractAmount} | Returns the original contract value of the payment application. | Number |
| {payment.netChangeByCO} | Returns the net change by change orders. | Number |
| {payment.contractSumToDate} | Returns the contract sum to date. | Number |
| {payment.totalCompletedAndStored} | Returns the total work completed and stored material to date. | Number |
| {payment.completedWorkRetentionPercent} | Returns the percentage of total work completed and stored material to date. | Number |
| {payment.completedWorkRetention} | Returns the retention percentage of completed work. | Number |
| {payment.materialsOnStoreRetentionPercent} | Returns the percentage of retention percentage of completed work. | Percent |
| {payment.materialsOnStoreRetention} | Returns the retention percentage of materials stored. | Number |
| {payment.allTotalRetainage} | Returns the total retention percentage. | Number |
| {payment.totalEarned} | Returns the total earned less retainage. | Number |
| {payment.previousPayment} | Returns the total earned less retainage from previous payment application. | Number |
| {payment.currentPayment} | Returns current payment due. | Number |
| {payment.balanceToFinish} | Returns balance to finish including the retainage. | Number |
| {payment.approvedInPreviousPeriod} | Returns the total variations approved in previous period. | Number |
| {payment.approvedThisPeriod} | Returns the total variations this period. | Number |
| {payment.totalApprovedChangeOrders} | Returns the net changes by Change Order. | Number |
| {previousPayment.number} | Returns previous payment number. | Number |
| {previousPayment.endDate} | Returns previous payment end date. | Date |
| {previousPayment.currentPayment} | Returns previous payment due. | Number |
| {payment.previousCompletedWorkRetained} | Returns the retained amount from completed work from previous payment applications. | Number |
| {payment.previousMaterialsRetained} | Returns the retained amount from materials stored from previous payment applications. | Number |
| {payment.currentCompletedWorkRetention} | Returns the current period retention amount for completed work. | Number |
| {payment.currentMaterialsRetention} | Returns the current period retention amount for materials stored. | Number |
| {payment.previousCompletedWorkRetained | add: payment.previousMaterialsRetained} | Returns the total previously retained amount (Previously Retained column). | Number |
| {payment.currentCompletedWorkRetention | add: payment.currentMaterialsRetention} | Returns the total current period retention amount (This Period Total Retained Pre-Release column). | Number |
| {previousMaterialsOnStore} | Returns the amount for materials stored from all previous applications. | Number |
| {payment.columnView.totalPreviousAmount | add:payment.columnView.previousMaterialsBilled} | If the Materials Billed setting is enabled, the variable provides the combined total of previous work completed and materials billed. Learn more about Materials in Payment Applications. | Number |
| {totalAdvanceAmount} | The total advance amount of all periods. | Number |
| {totalAdvancePercent} | The advance percent of all periods. | Number |
| {totalRecoupmentAmount} | The total recoupment amount of all periods. | Number |
| {totalRecoupmentPercentOfAdvance} | The recoupment percent of this period. | Number |
| {advanceAmount} | The advance amount of this period. | Number |
| {advancePercent} | The advance percent of this period. | Number |
| {recoupmentAmount} | The recoupment amount of this period. | Number |
| {recoupmentPercentOfCompletedWork} | The recoupment percent of completed work. | Number |
| {previousAdvanceAmount} | The percentage of recoupment for the work completed in this period. | Number |
| {previousRecoupmentAmount} | The amount of the previous recoupment. | Number |
| {previousAdvanceAmountForeignCurrency} | {previousAdvanceAmount} value in the foreign currency. | Number |
| {previousRecoupmentAmountForeignCurrency} | {previousRecoupmentAmount} value in the foreign currency. | Number |
Tip:
- To remove empty line items from a payment application use the conditional expression {#!amount} at the beginning of a table and {/} at the end of the line. For example:
- You can precede any of the payment application variables with
contract.supplier.to return values specific to the supplier. - To eliminate subtotals from payment applications or contracts, you can enter your payment line items with {#children.length===0}{xxx}{/}. For example:
- 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}.
- If you are using line mode (Show change orders as line items) on the payment application, replace
columnViewwithlineViewon the preceding variables.