Last Updated: November 16 2022
Retention is the percentage of payment held by the customer to ensure the job is completed to specific standards and to safeguard against defects in workmanship.
Retention settings are usually defined at the beginning of a project to ensure amounts are calculated correctly for each progress claim. Learn more in How to Set Up Retention.
When the project has been completed, the final progress claim includes the defined Final Claim Rebate.
When the defined retention Period passes since the Job Completed date, an alert appears in the System menu in simPRO and you can create a retention claim to receive the remaining retention.
For example, if the retention amount was five percent of the contract value and the final claim rebate was set at two percent, the final progress claim would include the two final claim rebate. You would then create a retention claim after the retention period had passed to receive the remaining three percent.
US only: If you use simPRO in the United States, the term 'retainage' is used instead of 'retention'.
In order to view content or perform actions referred to in this article you need to have the appropriate permissions enabled in your security group. Go to System > Setup > Security Groups and access your security group to update your permissions. The relevant security group tab and specific permissions for this article can be found here:
To create a retention claim:
- Go to Invoices > Retentions.
- Locate and click the required outstanding retention or go to Options > Create Retention Claim.
- Adjust the Date Issued, Payment Due terms and Invoice Comment as necessary.
- View all retentions held or rebated in the Retentions Held table, then adjust the Retention Claimed amount as necessary.
- Click Finish.
You can then email the retention claim to the customer from the Forms tab.
If you have selected Restrict Unapproved Invoices in System Setup, invoices must be in the Approved stage before they can be emailed to the customer, paid off, voided, or credited. If you have not selected Restrict Unapproved Invoices, invoices can be emailed to the customer before they are approved, but you must approve the invoice before applying payments.
To automatically approve
- Access the applicable
- Click Unlock.
- Under Invoice Stage, select Approved.
- Click Finish.
If you have renegotiated the contract value for a job, but you already created a retention claim, you can create a credit note to apply to the claim, which then transfers across to your accounting package.
To create a credit note:
- Access the job that the retention was applied to.
- Create a linked job variation and add the cost centre you wish to credit.
- Access the cost centre and go to Details > Summary.
- In the Parts & Labour breakdown, click the icon next to Total.
- Enter a '-' symbol, then enter the value you wish to credit on the retention claim to create a negative value cost centre.
Click Save and Finish.
- Click Invoice Job.
To apply the credit note to a retention claim:
- People > Customers.
- Click Options > View > Statement on the customer.
- Under Summary, click Apply on the credit.
- In the Credits table, click Apply on the credit.
- Under Invoices, enter the credit Amount Applied against the retention claim.
- Click Apply Credit.
Then when you export to your accounting package, the retention claim transfers across with the credit applied as normal.
US only: If you use simPRO in the United States, the term 'change order' is used instead of 'variation'.
After you have completed a retention claim, you can then email an invoice form directly to the customer from simPRO.
Learn more about using form builder templates in How to Use Form Builder Templates.
- Click the Forms tab in the
- Select the form you wish to send from the Templates list.
- See Assign form templates to appear when emailing a customer invoice to learn how to update the forms that appear here.
- Click View to preview and / or print the form.
- Select a Primary Contact to address the form to and click to add additional Contacts if required.
- This is automatically populated by the primary contact for invoicing defined in the customer card file.
- Alternatively, you can manually enter email addresses and separate them with a comma. To remove recipients, click Clear Recipients.
- Adjust the default Subject and Body template if required.
- Click Send > OK > OK.
A log entry is then created in the Log tab, where you can view the email text and any form attachments.
It recommended that you do not generate DOCX when you click View as it allows you to alter the invoice outside of simPRO.This can cause errors within your accounting system and impact reporting.
Click the Log tab to view a history of actions in that
Actions logged in the Message column of the log can include:
- Creation and modifications
- Status updates
- Printing and emailing forms
When you email from within the
When you click the icon, a pop-up containing the email text appears. If you emailed
Need additional help?
Try Walk Me Through, our step-by-step guidance tool, to create a retention claim.
In simPRO, go to Help > Walk Me Through and search Create a Retention Claim (ID: 110864) / Create a Retainage Claim (ID: 283834) (US only).
Learn more in How to Use Walk Me Through in simPRO.