Description
Update a supplied retention balance after additions and release.
Construction records combine revisions, dates, dimensions, rental periods, claims and financial balances. Revision numbers need not be consecutive, calendar offsets differ from business days, and recoverable length can depend on a strict cutoff. A supplied approval or readiness label is a record assertion rather than an engineering inspection or contractual determination.
Update a supplied retention balance after additions and release.
When to use this tool
Use Retention Payment Release Balance when you already have retentionHeld, releasedAmount, additionalRetention and need to update a supplied retention balance after additions and release.
How to use the tool and how it works
- Enter retentionHeld, releasedAmount, additionalRetention. Use the units and conventions below.
- Run the tool. Correct any format, range, or cross-field input error before interpreting the output.
- Read closingRetention. Use the output convention below.
Require nonnegative values and release<=held+additional; return held+additional-release.1
| Input field | Meaning and units | Accepted input |
|---|---|---|
| retentionHeld | Retention Held | Required. Finite number; minimum 0. |
| releasedAmount | Released Amount | Required. Finite number; minimum 0. |
| additionalRetention | Additional Retention | Required. Finite number; minimum 0. |
| Output field | Interpretation | Returned shape |
|---|---|---|
| closingRetention | Held+additional-released; release may not exceed the available total. | Required. Finite number. |
{
"input": {
"retentionHeld": 10000,
"releasedAmount": 3000,
"additionalRetention": 500
},
"output": {
"closingRetention": 7500
}
}Limitations and assumptions
- A larger release is rejected. No contractual retention, eligibility, approval, payment or actual balance is established.
- Inputs must satisfy both the field types and the cross-field conditions above. Invalid input causes an error; a successful false flag or documented placeholder is a different result.
- Numeric calculations use binary floating point unless exact decimal-integer arithmetic is explicitly stated. No hidden measurement tolerance or decimal rounding is added; nonfinite or out-of-contract results are rejected. Numeric signed-zero results are exported as zero.
Alternative or Complementary methods
Check controlled drawings, site measurements, schedules, approvals and the complete contract. Use the appropriate engineering assessment and actual billing or claim terms when a local scalar calculation or date comparison cannot establish suitability or entitlement.
References
Similar or alternative tools
- Progress Claim Stored Material Adjustment
Calculate a progress-claim balance using supplied material and prior-claim values.
- Construction Pay Item Quantity Variance
Compare supplied installed, contracted and paid quantities.