Page tree
Skip to end of metadata
Go to start of metadata

Retentions allow you track and manage your contract retentions on projects. They can be quickly setup when you first create a project.

AroFlo will track your retention amounts and show you how much you can claim both on Completion and after the Retention Liability Period.


Set up retentions

To set up retentions for a project:

  1. Click the Retentions tab.
  2. The Project Value field is pre-filled with the approved value of the linked quote.
  3. If a quote is not linked to the project, you can manually update this field. If this value includes GST, click Inc GST to calculate the ex GST value.
  4. You can enter either a total dollar value in the Max Retention Value, or a percentage for the retention value in the Retention Margin % field.

    The Inv. Retention Margin % field can be used when the retention amount per invoice is different to the overall retention margin. This is especially useful when a contract requires a higher retention percent to be held from your invoices until the retention total amount is reached.

  5. Choose what values should be included to calculate the Retention value.

    Markups used on your project are included when the Project Value is pre-filled. Markups can be excluded by un-ticking Inc Markup.

    Every project stage is included in the retention value, however you can exclude values which aren't linked to a stage. Simply untick Inc. No Stage.

    If the contract includes variations in the retention, select the Inc Variations checkbox to allow task variations to be included in retention calculations.

  6. Enter the Retention Period (no. of months). This is used to calculate the final date for retention claims based on the Project End Date.
  7. Click Save to proceed to the final setup step.


Retention fields and settings



FieldDescription
Project ValueTotal estimate value of the project. Either automatically entered from the total value of all approved quotes in the project, or manually entered.
Inc No StageIndicates if the values found under 'No Stage' will be part of the Project value.
Inc MarkupIndicates if markups were used towards calculating the Project Value.
Inc GSTIndicates if the Project Value was manually entered as including GST
Inc VariationsIndicates if the retention calculation should include any Task Variations for the Project.
Max Retention Value

Total value of the Retention. If a value is entered, the Retention Margin % will calculate and update.


Select either the Max Retention Value OR the Retention Marging %, not both.


Retention Margin %Percent margin of the Retention. If a value is entered, the Max Retention Value will calculate and update.
Inv. Retention Margin %

Allows invoice retention amounts to be greater than the whole Retention Margin %. Retention amount on invoices will use this figure to calculate the value that will be withheld.

Retention PeriodThe number of months that the retention will be withheld. Used to calculate when retentions can be claimed.



Completion and retention period claims

Once our retention information has been saved against the Project, we can set the retention percentage we can claim on project completion and/or after the retention period has lapsed.

If you can claim a percentage amount of your retentions when the project is completed, set the Completion Claim % value. This will modify the Liability Period % to the remaining percent so you don't claim for more or less that you are entitled to. The Claim Date shown is the Project Completion Date.

If you can only claim your retentions once the Retention Period has lapsed, there is nothing further to do since the default value for the Liability Period % is 100, meaning that we will be claiming the full amount of our retentions on the Claim Date shown (Retention Period + Project Completion Date).

Retentions on invoices

Any invoice that you raise in AroFlo against that project, whether it is a Task/Project or Progress invoice, will show the retention amount for that invoice underneath the Balance Due for the invoice.

Once the invoice has been processed, an entry for its retention amount will appear in the Retentions tab on the project.

Invoice Total Less Retention

You can use the invoice layout fields [Total (ex) less Retention] or [Total (inc) less Retention] to provide your client with an invoice that shows the balance with the retention withheld.



View our Project Management product page.


On this page: