支付申请变量

将本文中的变量包含在文档模板中,以填充系统中支付申请的值。例如,您可以添加支付申请的编号、说明或原始合同值。

在本文中:

若要详细了解:


常见用例和示例

在深入探究完整的变量参考之前,下面针对最常见的场景给出了一些实用示例:

支付申请表头

为支付申请文档创建专业的表头:

PAYMENT APPLICATION #{payment.number}
Contractor: {payment.supplier}
Project: {payment.name}
Billing Period: {payment.startDate | date: "%B %d, %Y"} to {payment.endDate | date: "%B %d, %Y"}

审批历史摘要

按照审计要求跟踪审批人、审批事项及审批时间:

APPROVAL HISTORY:
{#approvalHistories}
• {stepName}: {action} by {operator.name}
{/approvalHistories}

财务摘要

一目了然地呈现关键财务总计:

Original Contract Amount: {payment.contractAmount | currency}
Total Change Orders: {payment.totalApprovedChangeOrders | currency}
Contract Sum to Date: {payment.contractSumToDate | currency}
Current Payment Due: {payment.currentPayment | currency}
Balance to Finish: {payment.balanceToFinish | currency}

行项目表

为完成的工作生成详细的行项目:

{#payment.columnView.items}
{number} | {name} | {originalAmount | currency} | {amount | currency} | {percentCompleted}%
{/payment.columnView.items}

TOTALS:
Work Completed: {payment.columnView.totalAmount | currency}
Materials Stored: {payment.columnView.totalMaterialsStored | currency}
Total Retention: {payment.columnView.totalRetainage | currency}

往期与当期对比

显示自上次支付申请以来的进展:

Previous Payment #{previousPayment.number}: {payment.previousPayment | currency}
Current Period Work: {payment.currentPayment | currency}
Total Earned to Date: {payment.totalEarned | currency}

计费材料跟踪

当“计费材料”设置处于启用状态时,跟踪运送到施工现场的材料:

Materials Delivered This Period: ${payment.lineView.materialsBilled | currency}
Materials Delivered Previously: ${payment.lineView.previousMaterialsBilled | currency}
Total Materials Delivered: ${payment.lineView.materials | currency}

Calculation: {payment.lineView.materials} = {payment.lineView.previousMaterialsBilled} + {payment.lineView.materialsBilled}

这样就不需要使用以前可用的 totalMaterialsStored 变量手动计算总数。

包含添加项和扣除项的变更单摘要

将正值和负值变更单分成不同的列:

CHANGE ORDER SUMMARY
                     Additions    Deductions
Previous Periods:    {payment.approvedChangeOrderAdditionsInPreviousPeriod | currency}    {payment.approvedChangeOrderDeductionsInPreviousPeriod | currency}
This Period:         {payment.approvedChangeOrderAdditionsThisPeriod | currency}    {payment.approvedChangeOrderDeductionsThisPeriod | currency}
TOTALS:              {payment.totalApprovedChangeOrderAdditions | currency}    {payment.totalApprovedChangeOrderDeductions | currency}
Net Change Orders: {payment.totalApprovedChangeOrders | currency}

有关使用变量的提示

供应商特定值

提示:

您可以在任何支付申请变量前面加上 contract.supplier.,以返回特定于供应商的值。

示例:{contract.supplier.payment.currentPayment}

电子表格兼容性

重要信息:

电子表格不支持富文本变量。在电子表格中使用变量时,请移除“@”符号。

不使用{@pco.scopeOfWork}
应使用{pco.scopeOfWork}

行模式与列模式

注意:
注意:如果您在支付申请中使用行模式(将变更单显示为行项目),请将变量中的 columnView 替换为 lineView

列模式{payment.columnView.totalAmount}
行模式{payment.lineView.totalAmount}

变更单添加项/扣除项变量

重要信息:

这些变量不支持内嵌模式,需要经过完全批准的变更单才能确保准确性。


完整的变量参考

使用表顶部的搜索功能可缩小结果的范围。为使浏览更方便,变量按类别组织起来。

变量 说明 类型
基本信息
{payment.number} 返回支付申请编号。 字符串
{payment.name} 返回支付申请名称。 字符串
{payment.description} 返回支付申请描述。 字符串
{payment.supplier} 返回供应商的公司。 字符串
{payment.owner} 返回业主的公司。 字符串
{payment.architect} 返回建筑师的公司。 字符串
{@payment.note} 返回支付申请注释。 富文本
批准工作流
{#approvalHistories} 和 {/approvalHistories} 返回支付申请的批准历史详细信息,包括执行的操作、工作流步骤名称和操作员姓名。

将 {#approvalHistories} 和 {/approvalHistories} 一起使用。

数组
{#approvalHistories.action}

例如:
{#approvalHistories}{action}

{/approvalHistories}

返回在批准工作流步骤中执行的操作。 字符串
{#approvalHistories.stepName}

例如:
{#approvalHistories}{stepName}

{/approvalHistories}

返回批准历史中的工作流步骤名称。 字符串
{#approvalHistories.operator.name}

例如:
{#approvalHistories}{operator.name}

{/approvalHistories}

返回执行审批操作的人员的姓名。 字符串
日期与时间轴
{payment.startDate} 返回支付申请的计费期开始日期。 日期
{payment.endDate} 返回支付申请的计费期结束日期。 日期
{payment.createdAt} 返回创建支付申请的日期。 日期
{payment.submittedAt} 返回提交支付申请的日期。 日期
{payment.revisedAt} 返回修订支付申请的日期。 日期
{payment.updatedAt} 返回更新支付申请的日期。 日期
核心财务总计
{payment.contractAmount} 返回支付申请的原始合同值。 数字
{payment.contractSumToDate} 返回目前的合同总额。 数字
{payment.totalCompletedAndStored} 返回目前已完成工作和已存储材料的总计。 数字
{payment.totalEarned} 返回总收入减去保留款。 数字
{payment.previousPayment}
例如:

{#payment.previousPayment == ""} {/} {#payment.previousPayment < 0} ({payment.previousPayment | multiply: -1}) {/}

返回自上次支付申请以来的总收入减去保留款。 数字
{payment.currentPayment} 返回当前支付截止日期。 数字
{payment.balanceToFinish} 返回要完成的余额,包括保留款。 数字
保留金与保留款
{payment.completedWorkRetentionPercent} 返回目前已完成工作和已存储材料的总计所占的百分比。 数字
{payment.completedWorkRetention} 返回已完成工作的保留量。 数字
{payment.materialsOnStoreRetentionPercent} 返回现场材料的保留百分比。 百分比
{payment.materialsOnStoreRetention} 返回现场保留材料的数量。 数字
{payment.allTotalRetainage} 返回总保留量。 数字
{payment.previousCompletedWorkRetained} 返回自上次支付申请以来已完成工作的保留量。 数字
{payment.previousMaterialsRetained} 返回自上次支付申请以来已存储材料的保留量。 数字
{payment.currentCompletedWorkRetention} 返回当前周期已完成工作的保留量。 数字
{payment.currentMaterialsRetention} 返回当前周期已存储材料的保留量。 数字
{payment.thisPeriodRetainage} 返回当前支付的总保留款减去上一次支付的保留款所得的结果。 数字
变更单与变化
{payment.approvedInPreviousPeriod} 返回在上一周期批准的总变化。 数字
{payment.approvedThisPeriod} 返回本周期的总变化。 数字
{payment.totalApprovedChangeOrders} 返回按变更单的净变更。 数字
{payment.approvedChangeOrderAdditionsInPreviousPeriod} 返回先前周期的已批准变更单添加项总计。 数字
{payment.approvedChangeOrderDeductionsInPreviousPeriod} 返回先前周期的已批准变更单扣除项总计。 数字
{payment.approvedChangeOrderAdditionsThisPeriod} 返回此周期的已批准变更单添加项。 数字
{payment.approvedChangeOrderDeductionsThisPeriod} 返回此周期的已批准变更单扣除项。 数字
{payment.totalApprovedChangeOrderAdditions} 返回所有周期内的已批准变更单添加项总计。 数字
{payment.totalApprovedChangeOrderDeductions} 返回所有周期的已批准变更单扣除项总计。 数字
行项目详细信息
{#payment.columnView.items} 和 {/payment.columnView.items} 当 OCO 显示为列时,返回支付申请的项目详细信息。

将 {#payment.columnView.items} 和 {/payment.columnView.items} 一起使用。

数组
{#payment.columnView.items.number}

例如:
{#payment.columnView.items}{number}

{/payment.columnView.items}

返回支付申请的编号行项目。 字符串
{#payment.columnView.items.name}

例如:
{#payment.columnView.items}{name}

{/payment.columnView.items}

返回支付申请的名称行项目。 字符串
{#payment.columnView.items.originalQuantity}

例如:
{#payment.columnView.items}{originalQuantity}

{/payment.columnView.items}

返回支付申请的原始数量行项目。 数字
{#payment.columnView.items.unit}

例如:
{#payment.columnView.items}{unit}

{/payment.columnView.items}

返回支付申请的单位行项目。 字符串
{#payment.columnView.items.originalUnitPrice}

例如:
{#payment.columnView.items}{originalUnitPrice}

{/payment.columnView.items}

返回支付申请的原始单价行项目。 数字
{#payment.columnView.items.originalAmount}

例如:
{#payment.columnView.items}{originalAmount}

{/payment.columnView.items}

返回支付申请的原始价格一览表行项目。 数字
{#payment.columnView.items.changeOrders}

例如:
{#payment.columnView.items}{changeOrders}

{/payment.columnView.items}

返回支付申请的变更单值行项目。 数字
{#payment.columnView.changeOrderQuantity} 返回变更单的数量。 数字
{#payment.columnView.items.revisedQuantity}
例如:
{#payment.columnView.items}{revisedQuantity}
{/payment.columnView.items}
返回支付申请的修订数量行项目。 数字
{#payment.columnView.items.revisedValue}

例如:
{#payment.columnView.items}{revisedValue}

{/payment.columnView.items}

返回支付申请的修订值行项目。 数字
{#payment.columnView.items.previousQuantity}

例如:
{#payment.columnView.items}{previousQuantity}

{/payment.columnView.items}

返回上次支付申请的数量行项目。 数字
{#payment.columnView.items.previousAmount}

例如:
{#payment.columnView.items}{previousAmount}

{/payment.columnView.items}

返回上次支付申请的已完成工作值行项目。 数字
{#payment.columnView.items.quantity}

例如:
{#payment.columnView.items}{quantity}

{/payment.columnView.items}

返回当前支付申请的数量行项目。 数字
{#payment.columnView.items.amount}

例如:
{#payment.columnView.items}{amount}

{/payment.columnView.items}

返回当前支付申请的已完成工作值行项目。 数字
{#payment.columnView.items.materialsOnStoreQuantity}

例如:
{#payment.columnView.items}{materialsOnStoreQuantity}

{/payment.columnView.items}

返回支付申请的存储材料数量值行项目。 数字
{#payment.columnView.items.materialsOnStoreUnitPrice}

例如:
{#payment.columnView.items}{materialsOnStoreUnitPrice}

{/payment.columnView.items}

返回支付申请的存储材料单价值行项目。 数字
{#payment.columnView.items.materialsStored}

例如:
{#payment.columnView.items}{materialsStored}

{/payment.columnView.items}

返回支付申请的存储材料值行项目。 数字
{#payment.columnView.items.completed}

例如:
{#payment.columnView.items}{completed}

{/payment.columnView.items}

返回支付申请的完成值总计行项目,包括已完成工作值和现场材料值。 数字
{#payment.columnView.items.percentCompleted}

例如:
{#payment.columnView.items}{percentCompleted}

{/payment.columnView.items}

返回支付申请的完成百分比总计行项目。 数字
{#payment.columnView.items.balanceToFinish}

例如:
{#payment.columnView.items}{balanceToFinish}

{/payment.columnView.items}

返回支付申请的要完成的余额值行项目。 数字
{#payment.columnView.items.retainage}

例如:
{#payment.columnView.items}{retainage}

{/payment.columnView.items}

返回支付申请的保留值行项目。 数字
{#payment.columnView.items.completedWorkRetentionPercent}

例如:
{#payment.columnView.items}{completedWorkRetentionPercent}

{/payment.columnView.items}

返回支付申请的已完成工作的保留百分比行项目。 数字
{#payment.columnView.items.materialsOnStoreRetentionPercent}

例如:
{#payment.columnView.items}{materialsOnStoreRetentionPercent}

{/payment.columnView.items}

返回支付申请的存储材料保留百分比行项目。 数字
{#payment.columnView.items.completedWorkReleased}

例如:
{#payment.columnView.items}{completedWorkReleased}

{/payment.columnView.items}

返回支付申请的已完成工作的已发放保留值行项目。 数字
{#payment.columnView.items.materialsOnStoreReleased}

例如:
{#payment.columnView.items}{materialsOnStoreReleased}

{/payment.columnView.items}

返回支付申请的存储材料的已发放保留值行项目。 数字
{payment.columnView.totalOriginalAmount} 返回支付申请的原始价格一览表总计,包括合同金额、预算转移和变更单。 数字
{approvedBudgetTransfers} 批准的预算转移:批准的预算转移的总金额。 数字
{previousApprovedBudgetTransfers} 先前批准的预算转移:以前周期所有批准的预算转移的金额。 数字
{approvedThisPeriodBudgetTransfers} 本周期已批准的预算转移:本周期添加的已批准预算转移的金额。 数字
{totalBudgetTransfers} 预算转移总额:预算转移的总金额。 数字
{budgetTransfers} 预算转移:预算转移的金额。 数字
{budgetTransfersQuantity} 预算转移数量:预算转移的数量。 数字
{budgetTransfersUnit} 预算转移单位:预算转移的测量单位。 字符串
{budgetTransfersUnitPrice} 预算转移单价:预算转移的单价。 数字
{payment.columnView.totalChangeOrders} 返回支付申请的批准的变更单值总计。 数字
{payment.columnView.totalRevisedValue} 返回支付申请的修订值总计。 数字
{payment.columnView.totalPreviousAmount} 返回上次支付申请的已完成工作值总计。 数字
{payment.columnView.totalAmount} 返回当前支付申请的已完成工作值总计。 数字
{payment.columnView.totalMaterialsStored} 返回支付申请的现场材料值总计。 数字
{previousMaterialsOnStore} 返回先前所有申请中的存储材料量。 数字
{previousClaimedAmount} 返回先前申请中申领的金额。 数字
{claimedAmount} 返回本周期工作完成申领的金额。 数字
{claimedWorkCompleted} 返回总工作完成申领的金额。 数字
{payment.columnView.totalCompleted} 返回支付申请的完成值总计,包括存储材料值。 数字
{payment.columnView.percentTotalCompleted} 返回支付申请的完成百分比总计,包括存储材料值。 数字
{payment.columnView.totalBalanceToFinish} 返回支付申请的要完成的余额值总计。 数字
{payment.columnView.totalRetainage} 返回支付申请的保留值总计。 数字
{payment.thisPeriodRetainage} 返回当前支付的总保留款减去上一次支付的保留款所得的结果。 数字
{#committedSubItems}{value}{/committedSubItems} 返回成本项目的子项的承诺金额。 数字
{#committedSubItems}{unitPrice}{/committedSubItems} 返回成本项目的子项的承诺单价。 数字
{latestComment.content} 返回每行的最新审阅注释。 数字
{this.costItem.corNumber} 返回链接到成本项目的变更单信息。代替编写 corNumber,也可以编写 ocoNumber、scoNumber、scoType、corType、ocoType、corName、ocoName 或 scoName 以包含所需信息。 数字
{materialsBilled}
例如:
{payment.columnView.materialsBilled}
如果启用了“计费材料”设置,该变量将返回材料计费金额。详细了解支付申请中的材料 数字
{previousMaterialsBilled}
例如:
{payment.columnView.previousMaterialsBilled}
如果启用了“计费材料”设置,该变量将返回上次申请中的材料计费金额。详细了解支付申请中的材料 数字
{payment.lineView.materials}
例如:
{payment.lineView.materials}
如果启用了“计费材料”设置,此变量将返回每个行项目的计费材料总计,计算公式为 previousMaterialsBilled + materialsBilled(本周期)。这提供了单个变量来获取累计材料计费金额。详细了解支付申请中的材料 数字
{previousAmount | add: previousMaterialsBilled} 如果启用了“计费材料”设置,该变量将返回先前完成的工作和材料计费的总和。详细了解支付申请中的材料 数字
{payment.columnView.totalPreviousAmount | add:payment.columnView.previousMaterialsBilled} 如果启用了“计费材料”设置,该变量将提供先前完成的工作和材料计费的总计。详细了解支付申请中的材料 数字
{totalAdvanceAmount} 所有周期的预付款总金额。 数字
{totalAdvancePercent} 所有周期的预付款百分比。 数字
{totalRecoupmentAmount} 所有周期的收回款总金额。 数字
{totalRecoupmentPercentOfAdvance} 本周期的收回款百分比。 数字
{advanceAmount} 本周期的预付款金额。 数字
{advancePercent} 本周期的预付款百分比。 数字
{recoupmentAmount} 本周期的收回款金额。 数字
{recoupmentPercentOfCompletedWork} 已完成工作的收回款百分比。 数字
{previousAdvanceAmount} 本周期已完成工作的收回款百分比。 数字
{previousRecoupmentAmount} 先前收回款的金额。 数字
{previousAdvanceAmountForeignCurrency} 以外币表示的 {previousAdvanceAmount} 值。 数字
{previousRecoupmentAmountForeignCurrency} 以外币表示的 {previousRecoupmentAmount} 值。 数字
{payment.columnView.totalOriginalAmount} 返回支付申请的原始价格一览表总计,包括合同金额、预算转移和变更单。 数字
{approvedBudgetTransfers} 返回批准的预算转移的总金额。 数字
{previousApprovedBudgetTransfers} 返回以前周期所有已批准的预算转移的金额。 数字
{approvedThisPeriodBudgetTransfers} 返回本周期添加的已批准预算转移的金额。 数字
{totalBudgetTransfers} 返回预算转移的总金额。 数字
{budgetTransfers} 返回预算转移的金额。 数字
{budgetTransfersQuantity} 返回预算转移的数量。 数字
{budgetTransfersUnit} 返回预算转移的测量单位。 字符串
{budgetTransfersUnitPrice} 返回预算转移的单价。 数字